[kafka] branch trunk updated: MINOR: record lag max metric documentation enhancement (#12367)

[mj...@apache.org]

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

mjsax 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 1daa149730 MINOR: record lag max metric documentation enhancement (#12367)
1daa149730 is described below

commit 1daa149730e3c56b7b6fe8f14369178273e8efc4
Author: Prashanth Joseph Babu <pr...@gmail.com>
AuthorDate: Thu Jun 30 22:00:14 2022 +0530

    MINOR: record lag max metric documentation enhancement (#12367)
    
    Reviewers: Matthias J. Sax <ma...@confluent.io>
---
 .../apache/kafka/clients/consumer/internals/FetcherMetricsRegistry.java | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/internals/FetcherMetricsRegistry.java b/clients/src/main/java/org/apache/kafka/clients/consumer/internals/FetcherMetricsRegistry.java
index 501ffe9a88..f76a92462d 100644
--- a/clients/src/main/java/org/apache/kafka/clients/consumer/internals/FetcherMetricsRegistry.java
+++ b/clients/src/main/java/org/apache/kafka/clients/consumer/internals/FetcherMetricsRegistry.java
@@ -96,7 +96,7 @@ public class FetcherMetricsRegistry {
                 "The total number of fetch requests.", tags);
 
         this.recordsLagMax = new MetricNameTemplate("records-lag-max", groupName,
-                "The maximum lag in terms of number of records for any partition in this window", tags);
+                "The maximum lag in terms of number of records for any partition in this window. NOTE: This is based on current offset and not committed offset", tags);
         this.recordsLeadMin = new MetricNameTemplate("records-lead-min", groupName,
                 "The minimum lead in terms of number of records for any partition in this window", tags);