MINOR: Add JmxReporter note to metric.reporters (#19706)
CI / build (push) Waiting to run Details

According to KIP-830, in Kafka 4 users currently relying on JmxReporter
and that are using additional reporters via metric.reporters will have
to include org.apache.kafka.common.metrics.JmxReporter in
metric.reporters.

Reviewers: Mickael Maison <mickael.maison@gmail.com>
This commit is contained in:
Federico Valeri 2025-05-16 11:58:01 +02:00 committed by GitHub
parent 34e426b517
commit 102d35190b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions

View File

@ -126,7 +126,9 @@ public class CommonClientConfigs {
"\n" + "\n" +
"TRACE level records all possible metrics, capturing every detail about the system's performance and operation. It's best for controlled environments where in-depth analysis is required, though it can introduce significant overhead."; "TRACE level records all possible metrics, capturing every detail about the system's performance and operation. It's best for controlled environments where in-depth analysis is required, though it can introduce significant overhead.";
public static final String METRIC_REPORTER_CLASSES_CONFIG = "metric.reporters"; public static final String METRIC_REPORTER_CLASSES_CONFIG = "metric.reporters";
public static final String METRIC_REPORTER_CLASSES_DOC = "A list of classes to use as metrics reporters. Implementing the <code>org.apache.kafka.common.metrics.MetricsReporter</code> interface allows plugging in classes that will be notified of new metric creation."; public static final String METRIC_REPORTER_CLASSES_DOC = "A list of classes to use as metrics reporters. " +
"Implementing the <code>org.apache.kafka.common.metrics.MetricsReporter</code> interface allows plugging in classes that will be notified of new metric creation. " +
"When custom reporters are set and <code>org.apache.kafka.common.metrics.JmxReporter</code> is needed, it has to be explicitly added to the list.";
public static final String METRICS_CONTEXT_PREFIX = "metrics.context."; public static final String METRICS_CONTEXT_PREFIX = "metrics.context.";