(pulsar) 06/06: [improve] Make the config `metricsBufferResponse` description more effective (#22490)

[lhotari]

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

lhotari pushed a commit to branch branch-3.0
in repository https://gitbox.apache.org/repos/asf/pulsar.git

commit 94f12543a9ffe7e96f9af7ef9108d1b849ca3280
Author: 道君 <dao...@apache.org>
AuthorDate: Wed Apr 17 03:07:30 2024 +0800

    [improve] Make the config `metricsBufferResponse` description more 
effective (#22490)
    
    (cherry picked from commit 4ca4e2855267e3b36ee1a27f7144b89ba9194821)
---
 .../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 ae6928d2b32..0dc5d38c191 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
@@ -2852,8 +2852,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,