IGNITE-18372 CDC metrics documentation update (#11420)

apache · Jul 16, 2024 · 8028bac · 8028bac
1 parent db470c4
commit 8028bac
Showing 1 changed file with 29 additions and 10 deletions.
diff --git a/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc b/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
@@ -51,12 +51,13 @@ image:../../assets/images/integrations/CDC-ignite2igniteClient.svg[]
 
 === Metrics
 
+[cols="25%,75%",opts="header"]
 |===
 |Name |Description
 | `EventsCount` | Count of messages applied to destination cluster.
-| `LastEventTime` | Timestamp of last applied event.
-| `TypesCount` | Count of received binary types events.
-| `MappingsCount` | Count of received mappings events.
+| `LastEventTime` | Timestamp of last applied event to destination cluster.
+| `TypesCount` | Count of binary types events applied to destination cluster.
+| `MappingsCount` | Count of mappings events applied to destination cluster
 |===
 
 == Ignite to Ignite CDC streamer
@@ -80,12 +81,13 @@ image:../../assets/images/integrations/CDC-ignite2ignite.svg[]
 
 === Metrics
 
+[cols="25%,75%",opts="header"]
 |===
 |Name |Description
 | `EventsCount` | Count of messages applied to destination cluster.
-| `LastEventTime` | Timestamp of last applied event.
-| `TypesCount` | Count of received binary types events.
-| `MappingsCount` | Count of received mappings events.
+| `LastEventTime` | Timestamp of last applied event to destination cluster.
+| `TypesCount` | Count of binary types events applied to destination cluster.
+| `MappingsCount` | Count of mappings events applied to destination cluster
 |===
 
 == CDC replication using Kafka
@@ -118,11 +120,15 @@ image:../../assets/images/integrations/CDC-ignite2kafka.svg[]
 
 === IgniteToKafkaCdcStreamer Metrics
 
+[cols="30%,70%",opts="header"]
 |===
 |Name |Description
-| `EventsCount` | Count of messages applied to destination cluster.
-| `LastEventTime` | Timestamp of last applied event.
-| `BytesSent` | Number of bytes send to Kafka.
+| `EventsCount` | Count of messages applied to Kafka.
+| `LastEventTime` | Timestamp of last applied event to Kafka.
+| `TypesCount` | Count of binary types events applied to Kafka.
+| `MappingsCount` | Count of mappings events applied to Kafka.
+| `BytesSent` | Count of bytes sent to Kafka.
+| `MarkersCount` | Count of metadata markers sent to Kafka.
 |===
 
 === `kafka-to-ignite.sh` application
@@ -164,7 +170,7 @@ Kafka to Ignite configuration file should contain the following beans that will
 . `java.util.Properties` bean with the name `kafkaProperties`: Single Kafka consumer configuration.
 . `org.apache.ignite.cdc.kafka.KafkaToIgniteCdcStreamerConfiguration` bean: Options specific to `kafka-to-ignite.sh` application.
 
-[cols="20%,45%,35%",opts="header"]
+[cols="25%,45%,30%",opts="header"]
 |===
 |Name |Description | Default value
 | `caches` | Set of cache names to replicate. | null
@@ -176,6 +182,19 @@ Kafka to Ignite configuration file should contain the following beans that will
 | `kafkaRequestTimeout` | Kafka request timeout in milliseconds.  | `3000`
 | `maxBatchSize` | Maximum number of events to be sent to destination cluster in a single batch. | 1024
 | `threadCount` | Count of threads to proceed consumers. Each thread poll records from dedicated partitions in round-robin manner. | 16
+|`metricRegistryName`| Name for metric registry. `org.apache.metricRegistryName.cdc.applier` | cdc-kafka-to-ignite
+|===
+
+=== Metrics
+
+[cols="35%,65%",opts="header"]
+|===
+|Name |Description
+| `EventsReceivedCount` | Count of events received from Kafka.
+| `LastEventReceivedTime` | Timestamp of last received event from Kafka.
+| `EventsSentCount` | Count of events sent to destination cluster.
+| `LastBatchSentTime` | Timestamp of last sent batch to the destination cluster.
+| `MarkersCount` | Count of metadata markers received from Kafka.
 |===
 
 ==== Logging