[
https://issues.apache.org/jira/browse/KAFKA-7207?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16571220#comment-16571220
]
ASF GitHub Bot commented on KAFKA-7207:
---------------------------------------
rajinisivaram closed pull request #5429: [MINOR] KAFKA-7207: Make -rate &
-total metrics documentation consistent
URL: https://github.com/apache/kafka/pull/5429
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
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 @@ <h4><a id="selector_monitoring"
href="#selector_monitoring">Common monitoring me
<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 @@ <h4><a id="selector_monitoring"
href="#selector_monitoring">Common monitoring me
<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 @@ <h4><a id="selector_monitoring"
href="#selector_monitoring">Common monitoring me
<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 @@ <h4><a id="selector_monitoring"
href="#selector_monitoring">Common monitoring me
</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 @@ <h4><a id="common_node_monitoring"
href="#common_node_monitoring">Common Per-bro
<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 @@ <h4><a id="common_node_monitoring"
href="#common_node_monitoring">Common Per-bro
</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 @@ <h4><a id="common_node_monitoring"
href="#common_node_monitoring">Common Per-bro
</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 @@ <h5><a id="new_consumer_group_monitoring"
href="#new_consumer_group_monitoring">
<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 @@ <h5><a id="new_consumer_group_monitoring"
href="#new_consumer_group_monitoring">
<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 @@ <h5><a id="new_consumer_group_monitoring"
href="#new_consumer_group_monitoring">
<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 @@ <h5><a id="new_consumer_group_monitoring"
href="#new_consumer_group_monitoring">
<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>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Make rate & total metrics documentation consistent
> --------------------------------------------------
>
> Key: KAFKA-7207
> URL: https://issues.apache.org/jira/browse/KAFKA-7207
> Project: Kafka
> Issue Type: Improvement
> Components: documentation
> Reporter: Kevin Lu
> Assignee: Kevin Lu
> Priority: Trivial
>
> [KIP-187|https://cwiki-test.apache.org/confluence/display/KAFKA/KIP-187+-+Add+cumulative+count+metric+for+all+Kafka+rate+metrics]
> added an additional cumulative total metric for each existing rate metric.
> In the [Monitoring|https://kafka.apache.org/documentation/#monitoring]
> section of the docs, there is a mix of some sections only listing out the
> rate metric, and some sections listing out both the total metric and the rate
> metric.
> We should make all the sections consistent and list out all of the total
> metrics.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
