(ignite) branch master updated: IGNITE-29073 Fixed CDC metrics documentation (#13615)

[na...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

NSAmelchev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git


The following commit(s) were added to refs/heads/master by this push:
     new 01d808bd892 IGNITE-29073 Fixed CDC metrics documentation (#13615)
01d808bd892 is described below

commit 01d808bd8929db583ee918dc9ce06b09083a8866
Author: Nikita Amelchev <ns...@gmail.com>
AuthorDate: Mon Oct 5 09:57:34 2026 +0300

    IGNITE-29073 Fixed CDC metrics documentation (#13615)
---
 docs/_docs/monitoring-metrics/new-metrics.adoc  |  5 ++++
 docs/_docs/persistence/change-data-capture.adoc | 33 ++++++++++++++++---------
 2 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/docs/_docs/monitoring-metrics/new-metrics.adoc b/docs/_docs/monitoring-metrics/new-metrics.adoc
index bba01c74dd8..f89008c0b61 100644
--- a/docs/_docs/monitoring-metrics/new-metrics.adoc
+++ b/docs/_docs/monitoring-metrics/new-metrics.adoc
@@ -785,6 +785,11 @@ Register name: `failure.ignored`
 |{failure_type} | long | The number of failures of the given type suppressed in accordance with the configured failure handler.
 |===
 
+== Change Data Capture
+
+The `ignite-cdc.sh` application runs in a separate JVM and exports its own registers, `cdc` and `cdc.consumer`, through the exporters configured in `CdcConfiguration`.
+See link:persistence/change-data-capture#metrics[Change Data Capture] for the list of metrics.
+
 == Custom Metrics
 
 Registers created by the application through `Ignite.metrics()`. Their names start with `custom.`, see link:monitoring-metrics/custom-metrics[Custom Metrics].
diff --git a/docs/_docs/persistence/change-data-capture.adoc b/docs/_docs/persistence/change-data-capture.adoc
index 589fc9e95ce..2f2464b0267 100644
--- a/docs/_docs/persistence/change-data-capture.adoc
+++ b/docs/_docs/persistence/change-data-capture.adoc
@@ -112,18 +112,29 @@ The consumer of change events.  It should be implemented by the user.
 
 == Metrics
 
-`ignite-cdc.sh` uses the same SPI to export metrics as Ignite does.
-The following metrics are provided by the application (additional metrics can be provided by the consumer):
+`ignite-cdc.sh` uses the same link:monitoring-metrics/new-metrics-system#metric-exporters[metric exporters] as an Ignite node.
+They are configured by the `metricExporterSpi` property of `CdcConfiguration`, the JMX exporter is used by default.
+The application registers its metrics in the `cdc` register.
+The `cdc.consumer` register is passed to `CdcConsumer.start(MetricRegistry)` and is reserved for the consumer-specific metrics.
+
+Register name: `cdc`
+
+[cols="2,1,3",opts="header"]
 |===
-|Name |Description
-| CurrentSegmentIndex | Index of the currently processing WAL segment.
-| CommittedSegmentIndex | Index of the WAL segment that contains the last committed state.
-| CommittedSegmentOffset | Committed offset in bytes inside the WAL segment.
-| LastSegmentConsumptionTime | Timestamp (in milliseconds) indicating the last segment processing start.
-| BinaryMetaDir | Binary meta-directory the application reads data from.
-| MarshallerDir | Marshaller directory the application reads data from.
-| CdcDir | The CDC directory the application reads data from.
-| SegmentConsumingTime | Time of WAL segment consumption by consumer, in milliseconds.
+|Name | Type | Description
+|BinaryMetaDir | string | Binary metadata directory the application reads data from.
+|CdcDir | string | CDC directory the application reads data from.
+|CdcMode | string | CDC mode: `CDC_UTILITY_ACTIVE` when the events are captured by the application, `IGNITE_NODE_ACTIVE` when they are captured within the Ignite node.
+|CommittedSegmentIndex | long | Index of the WAL segment that contains the last committed state.
+|CommittedSegmentOffset | long | Committed offset in bytes inside the WAL segment.
+|CurrentSegmentIndex | long | Index of the WAL segment being processed.
+|EventCaptureTime | histogram | Time between the event creation on the Ignite node and its capture by the consumer, in milliseconds.
+|EventsCount | long | Number of events passed to the consumer.
+|LastEventTime | long | Timestamp (in milliseconds) of the last event passed to the consumer.
+|LastSegmentConsumptionTime | long | Timestamp (in milliseconds) indicating the last segment processing start.
+|MarshallerDir | string | Marshaller directory the application reads data from.
+|MetadataUpdateTime | histogram | Time of the metadata update (marshaller mappings, binary types and cache configurations), in milliseconds.
+|SegmentConsumingTime | histogram | Time of WAL segment consumption by consumer, in milliseconds.
 |===
 
 == Logging