This is an automated email from the ASF dual-hosted git repository.
mjsax pushed a commit to branch 2.4
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.4 by this push:
new 9cf2fa5 KAFKA-9030: Document client-level (a.k.a. instance-level)
metrics (#7501)
9cf2fa5 is described below
commit 9cf2fa5215b9ba53893a2aada3d698156727cd7a
Author: Bruno Cadonna <[email protected]>
AuthorDate: Tue Oct 15 23:30:16 2019 +0200
KAFKA-9030: Document client-level (a.k.a. instance-level) metrics (#7501)
Reviewers: A. Sophie Blee-Goldman <[email protected]>, Matthias J. Sax
<[email protected]>
---
docs/ops.html | 40 +++++++++++++++++++++++++++++++++++++++-
1 file changed, 39 insertions(+), 1 deletion(-)
diff --git a/docs/ops.html b/docs/ops.html
index d87d16a..18d9bb5 100644
--- a/docs/ops.html
+++ b/docs/ops.html
@@ -1485,7 +1485,8 @@
the info level records only the thread-level metrics.
<p>
- Note that the metrics have a 3-layer hierarchy. At the top level there are
per-thread metrics. Each thread has tasks, with their
+ Note that the metrics have a 4-layer hierarchy. At the top level there are
client-level metrics for each started
+ Kafka Streams client. Each client has stream threads, with their own
metrics. Each stream thread has tasks, with their
own metrics. Each task has a number of processor nodes, with their own
metrics. Each task also has a number of state stores
and record caches, all with their own metrics.
</p>
@@ -1495,6 +1496,43 @@
<pre>metrics.recording.level="info"</pre>
+<h5><a id="kafka_streams_client_monitoring"
href="#kafka_streams_client_monitoring">Client Metrics</a></h5>
+All the following metrics have a recording level of <code>info</code>:
+<table class="data-table">
+ <tbody>
+ <tr>
+ <th>Metric/Attribute name</th>
+ <th>Description</th>
+ <th>Mbean name</th>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td>The version of the Kafka Streams client.</td>
+ <td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>commit-id</td>
+ <td>The version control commit ID of the Kafka Streams client.</td>
+ <td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>application-id</td>
+ <td>The application ID of the Kafka Streams client.</td>
+ <td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>topology-description</td>
+ <td>The description of the topology executed in the Kafka Streams
client.</td>
+ <td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>state</td>
+ <td>The state of the Kafka Streams client.</td>
+ <td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
+ </tr>
+ </tbody>
+</table>
+
<h5><a id="kafka_streams_thread_monitoring"
href="#kafka_streams_thread_monitoring">Thread Metrics</a></h5>
All the following metrics have a recording level of <code>info</code>:
<table class="data-table">
