Skip to content

docs(metrics): updates for kafka exporter #11520

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Jun 10, 2025

Documentation

  • Creates a separate section for the Kafka Exporter to bring together consumer lag concepts and a new procedure to enable the Kafka Exporter
  • Removes the Kafka Exporter config step from the procedure for enabling the Prometheus JMX Exporter so that the Kafka Exporter option is not embedded within that section and treated as a separate option (whether JMX Exporter or Metrics Reporter is being used)

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

Signed-off-by: prmellor <pmellor@redhat.com>
Copy link
Contributor

@fvaleri fvaleri left a comment

Choose a reason for hiding this comment

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

Thanks @PaulRMellor. This avoids any confusion between Prometheus JMX Exporter and Kafka Exporter.


IMPORTANT: Kafka Exporter provides only additional metrics related to consumer lag and consumer offsets.
For regular Kafka metrics, you have to configure the Prometheus metrics in xref:assembly-metrics-setup-{context}[Kafka brokers].
Kafka Exporter relies on data from the `__consumer_offsets` topic to report lag metrics.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Kafka Exporter relies on data from the `__consumer_offsets` topic to report lag metrics.
Kafka Exporter relies on data from the `__consumer_offsets` topic to report consumer lag metrics.


* Consumer groups must be in use.
+
Kafka Exporter relies on data from the `__consumer_offsets` topic to report lag metrics.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Kafka Exporter relies on data from the `__consumer_offsets` topic to report lag metrics.
Kafka Exporter relies on data from the `__consumer_offsets` topic to report consumer lag metrics.

@ppatierno
Copy link
Member

@PaulRMellor can you rebase this PR please? There was a fix in main to allow the build to pass. Thanks!

Copy link
Contributor

@OwenCorrigan76 OwenCorrigan76 left a comment

Choose a reason for hiding this comment

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

From what I can see, this looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants