This is an automated email from the ASF dual-hosted git repository.
AndrewJSchofield 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 bf49716f25b KAFKA-19491 CONSUMER protocol metrics documentation
(#22684)
bf49716f25b is described below
commit bf49716f25b9467fe0a97e131e9e4a400d028a4d
Author: Ritikj55 <[email protected]>
AuthorDate: Mon Jul 27 14:38:41 2026 +0530
KAFKA-19491 CONSUMER protocol metrics documentation (#22684)
Description
Added documentation for new consumer metrics related to the CONSUMER
protocol implementation
Below are metrics for which documentation has been added :
1. time-between-network-thread-poll
2. application-event-queue-size
3. application-event-queue-time-avg
4. application-event-queue-processing-time-avg
5. application-events-expired-count
6. background-event-queue-size
7. background-event-queue-time-avg
8. background-event-queue-processing-time-avg
9. unsent-requests-queue-size
10. unsent-requests-queue-time-avg
Testing :
Tested using javascript wrapper in local for checking indentation
<img width="1250" height="494" alt="image"
src="https://github.com/user-attachments/assets/bcfbecbe-fadb-4f5c-a289-c8b03e3b1f76";
/>
Reviewers: Sushant Mahajan <[email protected]>, Andrew Schofield
<[email protected]>
---
docs/operations/monitoring.md | 214 +++++++++++++++++++++++++++++++++++++++++-
1 file changed, 212 insertions(+), 2 deletions(-)
diff --git a/docs/operations/monitoring.md b/docs/operations/monitoring.md
index 92badfae27a..431d26bb267 100644
--- a/docs/operations/monitoring.md
+++ b/docs/operations/monitoring.md
@@ -3654,8 +3654,218 @@ The total time the Consumer spent committing offsets in
nanoseconds (for AOS).
</td>
<td>
-kafka.consumer:type=consumer-metrics,client-id=([-.\w]+)
-</td> </tr> </table>
+kafka.consumer:type=consumer-metrics,client-id=([-.\w]+)
+</td> </tr>
+<tr>
+<td>
+
+application-event-queue-size
+</td>
+<td>
+
+The current number of events in the queue to send from the application thread
to the background thread (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+application-event-queue-time-avg
+</td>
+<td>
+
+The average time, in ms, that application events are taking to be dequeued
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+application-event-queue-time-max
+</td>
+<td>
+
+The maximum time, in ms, that application events are taking to be dequeued
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+application-event-queue-processing-time-avg
+</td>
+<td>
+
+The average time, in ms, that the background thread took to process all
available application events (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+application-event-queue-processing-time-max
+</td>
+<td>
+
+The maximum time, in ms, that the background thread took to process all
available application events (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+application-events-expired-count
+</td>
+<td>
+
+The current number of expired application events (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+background-event-queue-size
+</td>
+<td>
+
+The current number of events in the queue to send from the background thread
to the application thread (consumer protocol).
+</td>
+
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+background-event-queue-time-avg
+</td>
+<td>
+
+The average time, in ms, that background events are taking to be dequeued
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+background-event-queue-time-max
+</td>
+<td>
+
+The maximum time, in ms, that background events are taking to be dequeued
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+background-event-queue-processing-time-avg
+</td>
+<td>
+
+The average time, in ms, that the consumer took to process all available
background events (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+background-event-queue-processing-time-max
+</td>
+<td>
+
+The maximum time, in ms, that the consumer took to process all available
background events (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+time-between-network-thread-poll-max
+</td>
+<td>
+
+The maximum delay, in ms,between invocations of poll in the network thread
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td> </tr>
+<tr>
+<td>
+
+time-between-network-thread-poll-avg
+</td>
+<td>
+
+The average delay, in ms, between invocations of poll in the network thread
(consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td> </tr>
+<tr>
+<td>
+
+unsent-requests-queue-size
+</td>
+<td>
+
+The current number of unsent requests in the background thread (consumer
protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+unsent-requests-queue-time-max
+</td>
+<td>
+
+The maximum time, in ms, that a request remained unsent in the background
thread (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+<tr>
+<td>
+
+unsent-requests-queue-time-avg
+</td>
+<td>
+
+The average time, in ms, that requests are taking to be sent in the background
thread (consumer protocol).
+</td>
+<td>
+
+kafka.consumer:type=consumer-metrics,client-id=([-\.\w]+)
+</td></tr>
+</table>
### Consumer Group Metrics
