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.

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

Add JMX note for Kafka consumer metrics #19446

Closed
wants to merge 1 commit into from

Conversation

izeye
Copy link
Contributor

@izeye izeye commented Dec 24, 2019

Looking at #19348, it seems to be good to add a JMX note for Kafka consumer metrics similar to Tomcat metrics.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Dec 24, 2019
Copy link
Member

@snicoll snicoll left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I am wondering about rephrasing the note. WDYT?

@@ -1644,7 +1644,7 @@ Spring Boot registers the following core metrics when applicable:
** Number of classes loaded/unloaded
* CPU metrics
* File descriptor metrics
* Kafka consumer metrics
* Kafka consumer metrics (`spring.jmx.enabled` must be set to `true`)
Copy link
Member

Choose a reason for hiding this comment

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

This is a good idea. I'd rather change the note to something like "JMX support should be enabled" or something like that with a link to the section that explains how to do it rather than the reference to the property.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@snicoll Thanks for the feedback! I changed it as suggested.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the quick feedback. I meant that the text on "JMX support" should be a link to the relevant section. Have you missed it or do you disagree with that approach?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@snicoll Sorry. I overlooked your comment. I changed it again. Please let me know if it isn't what you meant.

@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Dec 24, 2019
@snicoll snicoll self-assigned this Dec 24, 2019
@snicoll snicoll added this to the 2.2.3 milestone Dec 24, 2019
snicoll pushed a commit that referenced this pull request Dec 24, 2019
@snicoll snicoll closed this in 27317ce Dec 24, 2019
@izeye izeye deleted the kafka-consumer-metrics branch December 24, 2019 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants