This is an automated email from the ASF dual-hosted git repository.
rsivaram 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 fb8eba3 KAFKA-7207: Make rate & total metrics documentation
consistent (#5429)
fb8eba3 is described below
commit fb8eba3d33df2940d58e204697ef84434a5bb089
Author: Kevin Lu <[email protected]>
AuthorDate: Tue Aug 7 00:49:57 2018 -0700
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 b9e3a4b..bf16df4 100644
--- a/docs/ops.html
+++ b/docs/ops.html
@@ -988,26 +988,51 @@
<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>
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</td>
@@ -1023,8 +1048,18 @@
<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>
@@ -1033,6 +1068,11 @@
<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>
<td>kafka.[producer|consumer|connect]:type=[producer|consumer|connect]-metrics,client-id=([-.\w]+)</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>
@@ -1087,11 +1137,21 @@
<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>
<td>kafka.producer:type=[consumer|producer|connect]-node-metrics,client-id=([-.\w]+),node-id=([0-9]+)</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>
@@ -1190,6 +1260,11 @@
<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>
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
@@ -1205,6 +1280,11 @@
<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>
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
@@ -1220,6 +1300,11 @@
<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>
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
@@ -1235,6 +1320,11 @@
<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>
<td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
