KAFKA-15186 AppInfo metrics don't contain the client-id #20493
Merged
+111
−35
Conversation
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
m1a2st
changed the title
chia7712
reviewed
Sep 6, 2025
| server.registerMBean(mBean, name); | ||
|
|
||
| registerMetrics(metrics, mBean); // prefix will be added later by JmxReporter | ||
|
|
clients/src/main/java/org/apache/kafka/common/utils/AppInfoParser.java
Outdated
Show resolved
Hide resolved
chia7712
reviewed
Sep 11, 2025
| metrics.addMetric(metricName(metrics, "version", Map.of()), (Gauge<String>) (config, now) -> appInfo.getVersion()); | ||
| metrics.addMetric(metricName(metrics, "commit-id", Map.of()), (Gauge<String>) (config, now) -> appInfo.getCommitId()); | ||
| metrics.addMetric(metricName(metrics, "start-time-ms", Map.of()), (Gauge<Long>) (config, now) -> appInfo.getStartTimeMs()); | ||
| // Mirror Maker/Worker doesn't set client-id tag into the metrics config, so we need to set it here. |
There was a problem hiding this comment.
Should we fix the both MM or worker?
There was a problem hiding this comment.
I think MirrorMaker is more precise.
| metrics.addMetric(metricName(metrics, "version"), (Gauge<String>) (config, now) -> appInfo.getVersion()); | ||
| metrics.addMetric(metricName(metrics, "commit-id"), (Gauge<String>) (config, now) -> appInfo.getCommitId()); | ||
| metrics.addMetric(metricName(metrics, "start-time-ms"), (Gauge<Long>) (config, now) -> appInfo.getStartTimeMs()); | ||
| private static void registerMetrics(Metrics metrics, AppInfo appInfo, String clientId) { |
There was a problem hiding this comment.
Could you please add a unit test to ensure that the client ID is not added repeatedly?
There was a problem hiding this comment.
I added a unit test to ensure that existing tagged metrics are not affected.
chia7712
reviewed
Sep 12, 2025
| metrics.removeMetric(metricName(metrics, "commit-id", Map.of())); | ||
| metrics.removeMetric(metricName(metrics, "start-time-ms", Map.of())); | ||
|
|
||
| if (clientId != null) { |
There was a problem hiding this comment.
Should it be if (!metrics.config().tags().containsKey("client-id") && clientId != null) { for consistency?
chia7712
reviewed
Sep 13, 2025
| metrics.addMetric(metricName(metrics, "version", Map.of()), (Gauge<String>) (config, now) -> appInfo.getVersion()); | ||
| metrics.addMetric(metricName(metrics, "commit-id", Map.of()), (Gauge<String>) (config, now) -> appInfo.getCommitId()); | ||
| metrics.addMetric(metricName(metrics, "start-time-ms", Map.of()), (Gauge<Long>) (config, now) -> appInfo.getStartTimeMs()); | ||
| // MirrorMaker doesn't set client-id tag into the metrics config, so we need to set it here. |
There was a problem hiding this comment.
To be precise, the worker also does not set client-id
https://github.com/apache/kafka/blob/trunk/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/ConnectMetrics.java#L89
# Conflicts: # docs/upgrade.html
jim0987795064
pushed a commit
to jim0987795064/kafka
that referenced
this pull request
Sep 25, 2025
All Kafka component register AppInfo metrics to track the application start time or commit-id etc. These metrics are useful for monitoring and debugging. However, the AppInfo doesn't provide client-id, which is an important information for custom metrics reporter. The AppInfoParser class registers a JMX MBean with the provided client-id, but when it adds metrics to the Metrics registry, the client-id is not included. This KIP aims to add the client-id as a tag. Reviewers: Chia-Ping Tsai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
All Kafka component register AppInfo metrics to track the application
start time or commit-id etc. These metrics are useful for monitoring and
debugging. However, the AppInfo doesn't provide client-id, which is an
important information for custom metrics reporter.
The AppInfoParser class registers a JMX MBean with the provided
client-id, but when it adds metrics to the Metrics registry, the
client-id is not included. This KIP aims to add the client-id as a tag.
Reviewers: Chia-Ping Tsai [email protected]