Skip to content

docs: add group_state metric to metrics tables#53

Merged
softberries merged 1 commit intomainfrom
docs/group-state-metric
Mar 13, 2026
Merged

docs: add group_state metric to metrics tables#53
softberries merged 1 commit intomainfrom
docs/group-state-metric

Conversation

@softberries
Copy link
Copy Markdown
Member

Summary

Test plan

  • Documentation-only change, no code affected

Copilot AI review requested due to automatic review settings March 13, 2026 09:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation entries for the newly introduced kafka_consumergroup_group_state metric so users can discover it in the main README and the metrics reference docs.

Changes:

  • Add kafka_consumergroup_group_state to the metrics table in docs/metrics-collection.md
  • Add kafka_consumergroup_group_state to the metrics table in README.md

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/metrics-collection.md Documents the new group state metric in the group-level metrics table.
README.md Exposes the new group state metric in the top-level metrics overview table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

| `kafka_consumergroup_group_sum_lag` | Sum of lag across all partitions | cluster_name, group |
| `kafka_consumergroup_group_max_lag` | Max offset lag across partitions | cluster_name, group |
| `kafka_consumergroup_group_max_lag_seconds` | Max time lag across partitions | cluster_name, group |
| `kafka_consumergroup_group_state` | Consumer group state as integer (0=Unknown, 1=PreparingRebalance, 2=CompletingRebalance, 3=Stable, 4=Dead, 5=Empty, 6=Assigning, 7=Reconciling) | cluster_name, group |
@softberries softberries merged commit 390f3f3 into main Mar 13, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants