Skip to content

Commit 8028bac

Browse files
authored
IGNITE-18372 CDC metrics documentation update (#11420)
1 parent db470c4 commit 8028bac

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

Diff for: docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc

+29-10
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,13 @@ image:../../assets/images/integrations/CDC-ignite2igniteClient.svg[]
5151

5252
=== Metrics
5353

54+
[cols="25%,75%",opts="header"]
5455
|===
5556
|Name |Description
5657
| `EventsCount` | Count of messages applied to destination cluster.
57-
| `LastEventTime` | Timestamp of last applied event.
58-
| `TypesCount` | Count of received binary types events.
59-
| `MappingsCount` | Count of received mappings events.
58+
| `LastEventTime` | Timestamp of last applied event to destination cluster.
59+
| `TypesCount` | Count of binary types events applied to destination cluster.
60+
| `MappingsCount` | Count of mappings events applied to destination cluster
6061
|===
6162

6263
== Ignite to Ignite CDC streamer
@@ -80,12 +81,13 @@ image:../../assets/images/integrations/CDC-ignite2ignite.svg[]
8081

8182
=== Metrics
8283

84+
[cols="25%,75%",opts="header"]
8385
|===
8486
|Name |Description
8587
| `EventsCount` | Count of messages applied to destination cluster.
86-
| `LastEventTime` | Timestamp of last applied event.
87-
| `TypesCount` | Count of received binary types events.
88-
| `MappingsCount` | Count of received mappings events.
88+
| `LastEventTime` | Timestamp of last applied event to destination cluster.
89+
| `TypesCount` | Count of binary types events applied to destination cluster.
90+
| `MappingsCount` | Count of mappings events applied to destination cluster
8991
|===
9092

9193
== CDC replication using Kafka
@@ -118,11 +120,15 @@ image:../../assets/images/integrations/CDC-ignite2kafka.svg[]
118120

119121
=== IgniteToKafkaCdcStreamer Metrics
120122

123+
[cols="30%,70%",opts="header"]
121124
|===
122125
|Name |Description
123-
| `EventsCount` | Count of messages applied to destination cluster.
124-
| `LastEventTime` | Timestamp of last applied event.
125-
| `BytesSent` | Number of bytes send to Kafka.
126+
| `EventsCount` | Count of messages applied to Kafka.
127+
| `LastEventTime` | Timestamp of last applied event to Kafka.
128+
| `TypesCount` | Count of binary types events applied to Kafka.
129+
| `MappingsCount` | Count of mappings events applied to Kafka.
130+
| `BytesSent` | Count of bytes sent to Kafka.
131+
| `MarkersCount` | Count of metadata markers sent to Kafka.
126132
|===
127133

128134
=== `kafka-to-ignite.sh` application
@@ -164,7 +170,7 @@ Kafka to Ignite configuration file should contain the following beans that will
164170
. `java.util.Properties` bean with the name `kafkaProperties`: Single Kafka consumer configuration.
165171
. `org.apache.ignite.cdc.kafka.KafkaToIgniteCdcStreamerConfiguration` bean: Options specific to `kafka-to-ignite.sh` application.
166172

167-
[cols="20%,45%,35%",opts="header"]
173+
[cols="25%,45%,30%",opts="header"]
168174
|===
169175
|Name |Description | Default value
170176
| `caches` | Set of cache names to replicate. | null
@@ -176,6 +182,19 @@ Kafka to Ignite configuration file should contain the following beans that will
176182
| `kafkaRequestTimeout` | Kafka request timeout in milliseconds. | `3000`
177183
| `maxBatchSize` | Maximum number of events to be sent to destination cluster in a single batch. | 1024
178184
| `threadCount` | Count of threads to proceed consumers. Each thread poll records from dedicated partitions in round-robin manner. | 16
185+
|`metricRegistryName`| Name for metric registry. `org.apache.metricRegistryName.cdc.applier` | cdc-kafka-to-ignite
186+
|===
187+
188+
=== Metrics
189+
190+
[cols="35%,65%",opts="header"]
191+
|===
192+
|Name |Description
193+
| `EventsReceivedCount` | Count of events received from Kafka.
194+
| `LastEventReceivedTime` | Timestamp of last received event from Kafka.
195+
| `EventsSentCount` | Count of events sent to destination cluster.
196+
| `LastBatchSentTime` | Timestamp of last sent batch to the destination cluster.
197+
| `MarkersCount` | Count of metadata markers received from Kafka.
179198
|===
180199

181200
==== Logging

0 commit comments

Comments
 (0)