(pulsar) branch master updated: [improve] Make the config `metricsBufferResponse` description more effective (#22490)

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

daojun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 4ca4e285526 [improve] Make the config `metricsBufferResponse` description more effective (#22490)
4ca4e285526 is described below

commit 4ca4e2855267e3b36ee1a27f7144b89ba9194821
Author: 道君 <da...@apache.org>
AuthorDate: Wed Apr 17 03:07:30 2024 +0800

    [improve] Make the config `metricsBufferResponse` description more effective (#22490)
---
 .../main/java/org/apache/pulsar/broker/ServiceConfiguration.java    | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
index 38a4c552f0b..2b58cbc2d11 100644
--- a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
+++ b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
@@ -2928,8 +2928,10 @@ public class ServiceConfiguration implements PulsarConfiguration {
     private boolean exposeTopicLevelMetricsInPrometheus = true;
     @FieldContext(
             category = CATEGORY_METRICS,
-            doc = "If true, export buffered metrics"
-    )
+            doc = "Set to true to enable the broker to cache the metrics response; the default is false. "
+                    + "The caching period is defined by `managedLedgerStatsPeriodSeconds`. "
+                    + "The broker returns the same response for subsequent requests within the same period. "
+                    + "Ensure that the scrape interval of your monitoring system matches the caching period.")
     private boolean metricsBufferResponse = false;
     @FieldContext(
         category = CATEGORY_METRICS,