Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IGNITE-18372 CDC metrics documentation update #11420

Merged
merged 2 commits into from
Jul 16, 2024
Merged

IGNITE-18372 CDC metrics documentation update #11420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b90a2a3
IGNITE-18372 CDC metrics documentation update
Jul 4, 2024
0f30c19
IGNITE-18372 default value fixed
Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading