mirror of https://github.com/apache/kafka.git
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.
This commit is contained in:
Kevin Lu
Rajini Sivaram
parent
b0d840d34b
commit
fb8eba3d33
100
docs/ops.html
100
docs/ops.html
|
|
@ -987,26 +987,51 @@
|
|||
<td>Connections closed per second in the window.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection-close-total</td>
|
||||
<td>Total connections closed in the window.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection-creation-rate</td>
|
||||
<td>New connections established per second in the window.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection-creation-total</td>
|
||||
<td>Total new connections established in the window.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>network-io-rate</td>
|
||||
<td>The average number of network operations (reads or writes) on all connections per second.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>network-io-total</td>
|
||||
<td>The total number of network operations (reads or writes) on all connections.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>outgoing-byte-rate</td>
|
||||
<td>The average number of outgoing bytes sent per second to all servers.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>outgoing-byte-total</td>
|
||||
<td>The total number of outgoing bytes sent to all servers.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-rate</td>
|
||||
<td>The average number of requests sent per second.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-total</td>
|
||||
<td>The total number of requests sent.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-size-avg</td>
|
||||
<td>The average size of all requests in the window.</td>
|
||||
|
|
@ -1022,9 +1047,19 @@
|
|||
<td>Bytes/second read off all sockets.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>incoming-byte-total</td>
|
||||
<td>Total bytes read off all sockets.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response-rate</td>
|
||||
<td>Responses received sent per second.</td>
|
||||
<td>Responses received per second.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response-total</td>
|
||||
<td>Total responses received.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -1032,6 +1067,11 @@
|
|||
<td>Number of times the I/O layer checked for new I/O to perform per second.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>select-total</td>
|
||||
<td>Total number of times the I/O layer checked for new I/O to perform.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>io-wait-time-ns-avg</td>
|
||||
<td>The average length of time the I/O thread spent waiting for a socket ready for reads or writes in nanoseconds.</td>
|
||||
|
|
@ -1059,12 +1099,22 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>successful-authentication-rate</td>
|
||||
<td>Connections that were successfully authenticated using SASL or SSL.</td>
|
||||
<td>Connections per second that were successfully authenticated using SASL or SSL.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>successful-authentication-total</td>
|
||||
<td>Total connections that were successfully authenticated using SASL or SSL.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>failed-authentication-rate</td>
|
||||
<td>Connections that failed authentication.</td>
|
||||
<td>Connections per second that failed authentication.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>failed-authentication-total</td>
|
||||
<td>Total connections that failed authentication.</td>
|
||||
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -1086,11 +1136,21 @@
|
|||
<td>The average number of outgoing bytes sent per second for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>outgoing-byte-total</td>
|
||||
<td>The total number of outgoing bytes sent for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-rate</td>
|
||||
<td>The average number of requests sent per second for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-total</td>
|
||||
<td>The total number of requests sent for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>request-size-avg</td>
|
||||
<td>The average size of all requests in the window for a node.</td>
|
||||
|
|
@ -1103,7 +1163,12 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>incoming-byte-rate</td>
|
||||
<td>The average number of responses received per second for a node.</td>
|
||||
<td>The average number of bytes received per second for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>incoming-byte-total</td>
|
||||
<td>The total number of bytes received for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -1118,7 +1183,12 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>response-rate</td>
|
||||
<td>Responses received sent per second for a node.</td>
|
||||
<td>Responses received per second for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response-total</td>
|
||||
<td>Total responses received for a node.</td>
|
||||
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -1189,6 +1259,11 @@
|
|||
<td>The number of commit calls per second</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>commit-total</td>
|
||||
<td>The total number of commit calls</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>assigned-partitions</td>
|
||||
<td>The number of partitions currently assigned to this consumer</td>
|
||||
|
|
@ -1204,6 +1279,11 @@
|
|||
<td>The average number of heartbeats per second</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>heartbeat-total</td>
|
||||
<td>The total number of heartbeats</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>join-time-avg</td>
|
||||
<td>The average time taken for a group rejoin</td>
|
||||
|
|
@ -1219,6 +1299,11 @@
|
|||
<td>The number of group joins per second</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>join-total</td>
|
||||
<td>The total number of group joins</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sync-time-avg</td>
|
||||
<td>The average time taken for a group sync</td>
|
||||
|
|
@ -1234,6 +1319,11 @@
|
|||
<td>The number of group syncs per second</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sync-total</td>
|
||||
<td>The total number of group syncs</td>
|
||||
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>last-heartbeat-seconds-ago</td>
|
||||
<td>The number of seconds since the last controller heartbeat</td>
|
||||
|
|
|
|||
Loading…
Reference in New Issue