DOC-933 Document new consumer group lag metrics and configs #1014
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
PR Change SummaryDocumented new consumer group lag metrics and configurations in the Redpanda documentation.
Modified Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add What is Hyperlint?Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation. |
|
|
||
| *Type:* integer | ||
|
|
||
| *Accepted values:* [`-17179869184`, `17179869183`] |
There was a problem hiding this comment.
These bounds are wild, maybe I should make it bounded.
| endif::[] | ||
|
|
||
| Enabling `consumer_lag` may add extra processing overhead to the broker, especially in environments with a high number of consumer groups or partitions. | ||
| The lower the value of `consumer_group_lag_collection_interval_sec`, the higher the frequency of metric collection, which could result in higher resource utilization. Monitor the broker's resource usage after enabling these properties to ensure that the broker can handle the additional load. |
There was a problem hiding this comment.
This feels a little overstated, the overhead should be pretty minimal, and not likely to be any more than using an external tool like Burrow.
There was a problem hiding this comment.
In that case, should we recommend that users enable consumer_lag instead of calculating lag themselves?
Why would users choose not to? Is this not enabled by default for some reason?
There was a problem hiding this comment.
The behavior of enable_consumer_group_metrics is:
group: enablesredpanda_kafka_consumer_group_consumers andredpanda_kafka_consumer_group_topics`partition: enablesredpanda_kafka_consumer_group_committed_offsetconsumer_lag: enablesredpanda_kafka_consumer_group_lag_maxandredpanda_kafka_consumer_group_lag_sum
The group and partition values are tagged against the wrong metrics in public-metrics-reference.adoc.
It might be helpful to add this cluster-properties.adoc, as well, as @BenPope suggested.
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-933
Partially resolves https://redpandadata.atlassian.net/browse/DOC-1115
Review deadline: March 17
Page previews
https://deploy-preview-1014--redpanda-docs-preview.netlify.app/25.1/manage/monitoring/#consumers
Checks