You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ab...@apache.org on 2021/03/04 22:47:09 UTC
[kafka] branch 2.7 updated: MINOR: add missing docs for
record-e2e-latency metrics (#10251)
This is an automated email from the ASF dual-hosted git repository.
ableegoldman pushed a commit to branch 2.7
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.7 by this push:
new 655baef MINOR: add missing docs for record-e2e-latency metrics (#10251)
655baef is described below
commit 655baefff7a16fdc52e2cadc5d8aabeb682950cd
Author: A. Sophie Blee-Goldman <so...@confluent.io>
AuthorDate: Thu Mar 4 14:42:56 2021 -0800
MINOR: add missing docs for record-e2e-latency metrics (#10251)
Need to add missing docs for the record-e2e-latency metrics, and new TRACE recording level
Reviewers: Walker Carlson <wc...@confluent.io>
---
docs/ops.html | 46 +++++++++++++++++++++++++++++++++++++++++-----
release.py | 2 +-
2 files changed, 42 insertions(+), 6 deletions(-)
diff --git a/docs/ops.html b/docs/ops.html
index fe81673..a8496a1 100644
--- a/docs/ops.html
+++ b/docs/ops.html
@@ -2089,7 +2089,7 @@ checkpoint-latency-ms-avg
<h4 class="anchor-heading"><a id="kafka_streams_monitoring" class="anchor-link"></a><a href="#kafka_streams_monitoring">Streams Monitoring</a></h4>
A Kafka Streams instance contains all the producer and consumer metrics as well as additional metrics specific to Streams.
- By default Kafka Streams has metrics with two recording levels: <code>debug</code> and <code>info</code>.
+ By default Kafka Streams has metrics with three recording levels: <code>info</code>, <code>debug</code>, and <code>trace</code>.
<p>
Note that the metrics have a 4-layer hierarchy. At the top level there are client-level metrics for each started
@@ -2253,8 +2253,8 @@ All of the following metrics have a recording level of <code>info</code>:
</table>
<h5 class="anchor-heading"><a id="kafka_streams_task_monitoring" class="anchor-link"></a><a href="#kafka_streams_task_monitoring">Task Metrics</a></h5>
-All of the following metrics have a recording level of <code>debug</code>, except for metrics
-dropped-records-rate and dropped-records-total which have a recording level of <code>info</code>:
+All of the following metrics have a recording level of <code>debug</code>, except for the dropped-records-*,
+active-process-ratio, and record-e2e-latency-* metrics which have a recording level of <code>info</code>:
<table class="data-table">
<tbody>
<tr>
@@ -2332,6 +2332,26 @@ dropped-records-rate and dropped-records-total which have a recording level of <
<td>The total number of records dropped within this task.</td>
<td>kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>active-process-ratio</td>
+ <td>The total number of records dropped within this task.</td>
+ <td>kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>record-e2e-latency-avg</td>
+ <td>The average end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>record-e2e-latency-max</td>
+ <td>The maximum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>record-e2e-latency-min</td>
+ <td>The minimum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-task-metrics,thread-id=([-.\w]+),task-id=([-.\w]+)</td>
+ </tr>
</tbody>
</table>
@@ -2370,8 +2390,9 @@ dropped-records-rate and dropped-records-total which have a recording level of <
</table>
<h5 class="anchor-heading"><a id="kafka_streams_store_monitoring" class="anchor-link"></a><a href="#kafka_streams_store_monitoring">State Store Metrics</a></h5>
- All of the following metrics have a recording level of <code>debug</code>. Note that the <code>store-scope</code> value is specified in <code>StoreSupplier#metricsScope()</code> for user's customized
- state stores; for built-in state stores, currently we have:
+All of the following metrics have a recording level of <code>debug</code>, except for the record-e2e-latency-* metrics which have a recording level <code>trace></code>.
+Note that the <code>store-scope</code> value is specified in <code>StoreSupplier#metricsScope()</code> for user's customized state stores;
+for built-in state stores, currently we have:
<ul>
<li><code>in-memory-state</code></li>
<li><code>in-memory-lru-state</code></li>
@@ -2546,6 +2567,21 @@ dropped-records-rate and dropped-records-total which have a recording level of <
<td>The maximum number of records buffered over the sampling window.</td>
<td>kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),in-memory-suppression-id=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>record-e2e-latency-avg</td>
+ <td>The average end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>record-e2e-latency-max</td>
+ <td>The maximum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>record-e2e-latency-min</td>
+ <td>The minimum end-to-end latency of a record, measured by comparing the record timestamp with the system time when it has been fully processed by the node.</td>
+ <td>kafka.streams:type=stream-state-metrics,thread-id=([-.\w]+),task-id=([-.\w]+),[store-scope]-id=([-.\w]+)</td>
+ </tr>
</tbody>
</table>
diff --git a/release.py b/release.py
index 180baa1..81e8c4c 100755
--- a/release.py
+++ b/release.py
@@ -444,7 +444,7 @@ if not user_ok("""Requirements:
</server>
<server>
<id>your-gpgkeyId</id>
- <passphrase>your-gpg-passphase</passphrase>
+ <passphrase>your-gpg-passphrase</passphrase>
</server>
<profile>
<id>gpg-signing</id>