This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new 9e06767ffa8 KAFKA-13898 Updated docs for metrics.recording.level
(#16402)
9e06767ffa8 is described below
commit 9e06767ffa80b26791c3bff6bc9b10b6612ce7d2
Author: Nancy <[email protected]>
AuthorDate: Wed Jul 31 01:59:33 2024 +0530
KAFKA-13898 Updated docs for metrics.recording.level (#16402)
Reviewers: Chia-Ping Tsai <[email protected]>
---
.../main/java/org/apache/kafka/clients/CommonClientConfigs.java | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git
a/clients/src/main/java/org/apache/kafka/clients/CommonClientConfigs.java
b/clients/src/main/java/org/apache/kafka/clients/CommonClientConfigs.java
index e229465a598..b4fd73e40de 100644
--- a/clients/src/main/java/org/apache/kafka/clients/CommonClientConfigs.java
+++ b/clients/src/main/java/org/apache/kafka/clients/CommonClientConfigs.java
@@ -118,8 +118,13 @@ public class CommonClientConfigs {
public static final String METRICS_NUM_SAMPLES_DOC = "The number of
samples maintained to compute metrics.";
public static final String METRICS_RECORDING_LEVEL_CONFIG =
"metrics.recording.level";
- public static final String METRICS_RECORDING_LEVEL_DOC = "The highest
recording level for metrics.";
-
+ public static final String METRICS_RECORDING_LEVEL_DOC = "The highest
recording level for metrics. It has three levels for recording metrics - info,
debug, and trace.\n" +
+ " \n" +
+ "INFO level records only essential metrics necessary for
monitoring system performance and health. It collects vital data without
gathering too much detail, making it suitable for production environments where
minimal overhead is desired.\n" +
+ "\n" +
+ "DEBUG level records most metrics, providing more detailed
information about the system's operation. It's useful for development and
testing environments where you need deeper insights to debug and fine-tune the
application.\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.";
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. The
JmxReporter is always included to register JMX statistics.";
