From fb8eba3d33df2940d58e204697ef84434a5bb089 Mon Sep 17 00:00:00 2001 From: Kevin Lu Date: Tue, 7 Aug 2018 00:49:57 -0700 Subject: [PATCH] KAFKA-7207: Make rate & total metrics documentation consistent (#5429) Some sections of the Monitoring metrics documentation list out the -total metrics, and some sections do not list them out. Make them consistent and list out the missing -total metrics. --- docs/ops.html | 100 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 95 insertions(+), 5 deletions(-) diff --git a/docs/ops.html b/docs/ops.html index b9e3a4b32a1..bf16df44e90 100644 --- a/docs/ops.html +++ b/docs/ops.html @@ -987,26 +987,51 @@ Connections closed per second in the window. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + connection-close-total + Total connections closed in the window. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + connection-creation-rate New connections established per second in the window. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + connection-creation-total + Total new connections established in the window. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + network-io-rate The average number of network operations (reads or writes) on all connections per second. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + network-io-total + The total number of network operations (reads or writes) on all connections. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + outgoing-byte-rate The average number of outgoing bytes sent per second to all servers. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + outgoing-byte-total + The total number of outgoing bytes sent to all servers. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + request-rate The average number of requests sent per second. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + request-total + The total number of requests sent. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + request-size-avg The average size of all requests in the window. @@ -1022,9 +1047,19 @@ Bytes/second read off all sockets. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + incoming-byte-total + Total bytes read off all sockets. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + response-rate - Responses received sent per second. + Responses received per second. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + + response-total + Total responses received. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) @@ -1032,6 +1067,11 @@ Number of times the I/O layer checked for new I/O to perform per second. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + select-total + Total number of times the I/O layer checked for new I/O to perform. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + io-wait-time-ns-avg The average length of time the I/O thread spent waiting for a socket ready for reads or writes in nanoseconds. @@ -1059,12 +1099,22 @@ successful-authentication-rate - Connections that were successfully authenticated using SASL or SSL. + Connections per second that were successfully authenticated using SASL or SSL. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + + successful-authentication-total + Total connections that were successfully authenticated using SASL or SSL. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) failed-authentication-rate - Connections that failed authentication. + Connections per second that failed authentication. + kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) + + + failed-authentication-total + Total connections that failed authentication. kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+) @@ -1086,11 +1136,21 @@ The average number of outgoing bytes sent per second for a node. kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + + outgoing-byte-total + The total number of outgoing bytes sent for a node. + kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + request-rate The average number of requests sent per second for a node. kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + + request-total + The total number of requests sent for a node. + kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + request-size-avg The average size of all requests in the window for a node. @@ -1103,7 +1163,12 @@ incoming-byte-rate - The average number of responses received per second for a node. + The average number of bytes received per second for a node. + kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + + + incoming-byte-total + The total number of bytes received for a node. kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) @@ -1118,7 +1183,12 @@ response-rate - Responses received sent per second for a node. + Responses received per second for a node. + kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) + + + response-total + Total responses received for a node. kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+) @@ -1189,6 +1259,11 @@ The number of commit calls per second kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + + commit-total + The total number of commit calls + kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + assigned-partitions The number of partitions currently assigned to this consumer @@ -1204,6 +1279,11 @@ The average number of heartbeats per second kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + + heartbeat-total + The total number of heartbeats + kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + join-time-avg The average time taken for a group rejoin @@ -1219,6 +1299,11 @@ The number of group joins per second kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + + join-total + The total number of group joins + kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + sync-time-avg The average time taken for a group sync @@ -1234,6 +1319,11 @@ The number of group syncs per second kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + + sync-total + The total number of group syncs + kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+) + last-heartbeat-seconds-ago The number of seconds since the last controller heartbeat