You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mi...@apache.org on 2022/07/11 15:41:59 UTC
[kafka-site] branch asf-site updated: KAFKA-13436: Omitted BrokerTopicMetrics metrics in the documentation (#417)
This is an automated email from the ASF dual-hosted git repository.
mimaison pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/kafka-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 1ae231fd KAFKA-13436: Omitted BrokerTopicMetrics metrics in the documentation (#417)
1ae231fd is described below
commit 1ae231fd6c554cdd0d617da1f7bf410f48122f07
Author: Lee Dongjin <do...@apache.org>
AuthorDate: Tue Jul 12 00:41:53 2022 +0900
KAFKA-13436: Omitted BrokerTopicMetrics metrics in the documentation (#417)
Same as https://github.com/apache/kafka/commit/89c057397ec5ae320aee7e12e1a984b2c14a7fa5
Reviewers: Mickael Maison <mi...@gmail.com>
---
32/ops.html | 61 +++++++++++++++++++++++++++++++++++++++++++------------------
1 file changed, 43 insertions(+), 18 deletions(-)
diff --git a/32/ops.html b/32/ops.html
index 91845c5c..24dbbcc1 100644
--- a/32/ops.html
+++ b/32/ops.html
@@ -1401,18 +1401,18 @@ $ bin/kafka-acls.sh \
</tr>
<tr>
<td>Message in rate</td>
- <td>kafka.server:type=BrokerTopicMetrics,name=MessagesInPerSec</td>
- <td></td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=MessagesInPerSec,topic=([-.\w]+)</td>
+ <td>Incoming message rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Byte in rate from clients</td>
- <td>kafka.server:type=BrokerTopicMetrics,name=BytesInPerSec</td>
- <td></td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=BytesInPerSec,topic=([-.\w]+)</td>
+ <td>Byte in (from the clients) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Byte in rate from other brokers</td>
- <td>kafka.server:type=BrokerTopicMetrics,name=ReplicationBytesInPerSec</td>
- <td></td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=ReplicationBytesInPerSec,topic=([-.\w]+)</td>
+ <td>Byte in (from the other brokers) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Controller Request rate from Broker</td>
@@ -1441,7 +1441,27 @@ $ bin/kafka-acls.sh \
<td>Error rate</td>
<td>kafka.network:type=RequestMetrics,name=ErrorsPerSec,request=([-.\w]+),error=([-.\w]+)</td>
<td>Number of errors in responses counted per-request-type, per-error-code. If a response contains
- multiple errors, all are counted. error=NONE indicates successful responses.</td>
+ multiple errors, all are counted. error=NONE indicates successful responses.</td>
+ </tr>
+ <tr>
+ <td>Produce request rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=TotalProduceRequestsPerSec,topic=([-.\w]+)</td>
+ <td>Produce request rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
+ </tr>
+ <tr>
+ <td>Fetch request rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=TotalFetchRequestsPerSec,topic=([-.\w]+)</td>
+ <td>Fetch request (from clients or followers) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
+ </tr>
+ <tr>
+ <td>Failed produce request rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=FailedProduceRequestsPerSec,topic=([-.\w]+)</td>
+ <td>Failed Produce request rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
+ </tr>
+ <tr>
+ <td>Failed fetch request rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=FailedFetchRequestsPerSec,topic=([-.\w]+)</td>
+ <td>Failed Fetch request (from clients or followers) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Request size in bytes</td>
@@ -1461,7 +1481,7 @@ $ bin/kafka-acls.sh \
<tr>
<td>Message conversion rate</td>
<td>kafka.server:type=BrokerTopicMetrics,name={Produce|Fetch}MessageConversionsPerSec,topic=([-.\w]+)</td>
- <td>Number of records which required message format conversion.</td>
+ <td>Message format conversion rate, for Produce or Fetch requests, per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Request Queue Size</td>
@@ -1470,33 +1490,38 @@ $ bin/kafka-acls.sh \
</tr>
<tr>
<td>Byte out rate to clients</td>
- <td>kafka.server:type=BrokerTopicMetrics,name=BytesOutPerSec</td>
- <td></td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=BytesOutPerSec,topic=([-.\w]+)</td>
+ <td>Byte out (to the clients) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Byte out rate to other brokers</td>
- <td>kafka.server:type=BrokerTopicMetrics,name=ReplicationBytesOutPerSec</td>
- <td></td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=ReplicationBytesOutPerSec,topic=([-.\w]+)</td>
+ <td>Byte out (to the other brokers) rate per topic. Omitting 'topic=(...)' will yield the all-topic rate.</td>
+ </tr>
+ <tr>
+ <td>Rejected byte rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=BytesRejectedPerSec,topic=([-.\w]+)</td>
+ <td>Rejected byte rate per topic, due to the record batch size being greater than max.message.bytes configuration. Omitting 'topic=(...)' will yield the all-topic rate.</td>
</tr>
<tr>
<td>Message validation failure rate due to no key specified for compacted topic</td>
<td>kafka.server:type=BrokerTopicMetrics,name=NoKeyCompactedTopicRecordsPerSec</td>
- <td></td>
+ <td>0</td>
</tr>
<tr>
<td>Message validation failure rate due to invalid magic number</td>
<td>kafka.server:type=BrokerTopicMetrics,name=InvalidMagicNumberRecordsPerSec</td>
- <td></td>
+ <td>0</td>
</tr>
<tr>
<td>Message validation failure rate due to incorrect crc checksum</td>
<td>kafka.server:type=BrokerTopicMetrics,name=InvalidMessageCrcRecordsPerSec</td>
- <td></td>
+ <td>0</td>
</tr>
<tr>
<td>Message validation failure rate due to non-continuous offset or sequence number in batch</td>
<td>kafka.server:type=BrokerTopicMetrics,name=InvalidOffsetOrSequenceRecordsPerSec</td>
- <td></td>
+ <td>0</td>
</tr>
<tr>
<td>Log flush rate and time</td>
@@ -1740,12 +1765,12 @@ $ bin/kafka-acls.sh \
<tr>
<td>Outgoing byte rate of reassignment traffic</td>
<td>kafka.server:type=BrokerTopicMetrics,name=ReassignmentBytesOutPerSec</td>
- <td></td>
+ <td>0; non-zero when a partition reassignment is in progress.</td>
</tr>
<tr>
<td>Incoming byte rate of reassignment traffic</td>
<td>kafka.server:type=BrokerTopicMetrics,name=ReassignmentBytesInPerSec</td>
- <td></td>
+ <td>0; non-zero when a partition reassignment is in progress.</td>
</tr>
<tr>
<td>Size of a partition on disk (in bytes)</td>