-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add Kafka Monitoring Data Collection page #36953
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.
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
Open
shellymat-dd
wants to merge
5
commits into
master
Choose a base branch
from
shelly/dsm-kafka-data-collection
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+33
−1
Open
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
198aeeb
Add Kafka Monitoring Data Collection page
shellymat-dd 70c66ca
Refine Data Collection page after review
shellymat-dd ddf51fb
Break unit hint onto its own line in expanded-scope metrics table
shellymat-dd 701794f
Break unit hint onto its own line in expanded-scope metrics table
shellymat-dd ac55aea
Refactor Metrics section to point at integration source of truth
shellymat-dd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: Data Collection | ||
| description: Metrics, configurations, and capabilities collected by Data Streams Monitoring's Kafka Monitoring when cluster monitoring is enabled. | ||
| --- | ||
|
|
||
| Data Streams Monitoring's Kafka Monitoring collects cluster health data through the [Kafka Consumer integration][1]. With `enable_cluster_monitoring: true`, the integration collects additional metrics and unlocks the extra capabilities described on this page. | ||
|
|
||
| See [Kafka Monitoring Setup][4] for how to configure the check. | ||
|
|
||
| ## Metrics | ||
|
|
||
| | Metric | Description | | ||
| |--------------------------------------------------|--------------------------------------------------------------| | ||
| | `kafka.cluster.controller_id` | ID of the broker acting as the cluster controller | | ||
| | `kafka.broker.count` | Total number of brokers in the cluster | | ||
| | `kafka.broker.leader_count` | Number of partitions for which this broker is the leader | | ||
| | `kafka.broker.partition_count` | Total number of partitions on this broker including replicas | | ||
| | `kafka.broker.config.log_retention_bytes` | Broker configuration for log retention in bytes | | ||
| | `kafka.broker.config.log_retention_ms` | Broker configuration for log retention in milliseconds | | ||
| | `kafka.broker.config.log_segment_bytes` | Broker configuration for log segment size in bytes | | ||
| | `kafka.broker.config.num_partitions` | Broker configuration for default number of partitions | | ||
| | `kafka.broker.config.num_network_threads` | Broker configuration for number of network threads | | ||
| | `kafka.broker.config.num_io_threads` | Broker configuration for number of I/O threads | | ||
| | `kafka.broker.config.default_replication_factor` | Broker configuration for default replication factor | | ||
| | `kafka.broker.config.min_insync_replicas` | Broker configuration for minimum in-sync replicas | | ||
| | `kafka.topic.count` | Total number of topics in the cluster | | ||
| | `kafka.topic.partitions` | Number of partitions for this topic | | ||
| | `kafka.topic.size` | Total number of messages in the topic | | ||
| | `kafka.topic.message_rate` | Message production rate for this topic | | ||
| | `kafka.topic.config.retention_ms` | Topic configuration for retention time in milliseconds | | ||
| | `kafka.topic.config.retention_bytes` | Topic configuration for retention size in bytes | | ||
| | `kafka.topic.config.max_message_bytes` | Topic configuration for maximum message size in bytes | | ||
| | `kafka.partition.beginning_offset` | The earliest offset in the partition | | ||
| | `kafka.partition.replicas` | Number of replicas for this partition | | ||
| | `kafka.partition.isr` | Number of in-sync replicas for this partition | | ||
| | `kafka.partition.size` | Number of messages in the partition | | ||
| | `kafka.partition.under_replicated` | Whether this partition is under-replicated (1) or not (0) | | ||
| | `kafka.partition.offline` | Whether this partition is offline (1) or not (0) | | ||
| | `kafka.consumer_group.count` | Total number of consumer groups | | ||
| | `kafka.consumer_group.members` | Number of members in the consumer group | | ||
| | `kafka.consumer_group.member.partitions` | Number of partitions assigned to this consumer group member | | ||
|
|
||
| Now collected across the entire cluster instead of for selected topics only: | ||
|
shellymat-dd marked this conversation as resolved.
Outdated
|
||
|
|
||
| | Metric | Description | | ||
| |--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `kafka.broker_offset` | Current message offset on broker.<br>*Shown as offset* | | ||
| | `kafka.consumer_offset` | Current message offset on consumer.<br>*Shown as offset* | | ||
| | `kafka.consumer_lag` | Lag in messages between consumer and broker.<br>*Shown as message* | | ||
| | `kafka.estimated_consumer_lag` | Lag in seconds between consumer and broker. This metric is provided through Data Streams Monitoring. Additional charges may apply.<br>*Shown as second* | | ||
|
|
||
| ## Configurations and schemas | ||
|
|
||
| - Broker configurations | ||
| - Topic configurations | ||
| - Schemas from a schema registry | ||
|
|
||
| These appear in Data Streams Monitoring alongside the metrics above. | ||
|
|
||
| ## Capabilities | ||
|
|
||
| Enabling cluster monitoring also unlocks the ability to [read live messages on topics][3] on demand. See [Enable message inspection][2] for the additional setup steps. | ||
|
|
||
| [1]: /integrations/kafka-consumer/?tab=containerized | ||
| [2]: /data_streams/kafka/setup/#enable-message-inspection | ||
| [3]: /data_streams/kafka/#inspect-topic-schemas-and-messages | ||
| [4]: /data_streams/kafka/setup/ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.