You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by sa...@apache.org on 2024/01/09 03:18:50 UTC
(kafka) branch 3.7 updated: MINOR: Add public documentation for metrics introduced in KIP-963 (#15138)
This is an automated email from the ASF dual-hosted git repository.
satishd pushed a commit to branch 3.7
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/3.7 by this push:
new 56774efdd78 MINOR: Add public documentation for metrics introduced in KIP-963 (#15138)
56774efdd78 is described below
commit 56774efdd78894da59fe8e393f48d69c88f744be
Author: Christo Lolov <lo...@amazon.com>
AuthorDate: Tue Jan 9 03:17:31 2024 +0000
MINOR: Add public documentation for metrics introduced in KIP-963 (#15138)
Reviewers: Satish Duggana <sa...@apache.org>, Kamal Chandraprakash<ka...@gmail.com>
---
docs/ops.html | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
docs/upgrade.html | 10 ++++++++++
2 files changed, 70 insertions(+)
diff --git a/docs/ops.html b/docs/ops.html
index c4be91cb0ad..eb0cbd78828 100644
--- a/docs/ops.html
+++ b/docs/ops.html
@@ -1892,6 +1892,66 @@ $ bin/kafka-acls.sh \
<td>Rate of write errors from remote storage per topic. Omitting 'topic=(...)' will yield the all-topic rate</td>
<td>kafka.server:type=BrokerTopicMetrics,name=RemoteCopyErrorsPerSec,topic=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>Remote Copy Lag Bytes</td>
+ <td>Bytes which are eligible for tiering, but are not in remote storage yet. Omitting 'topic=(...)' will yield the all-topic sum</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteCopyLagBytes,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Copy Lag Segments</td>
+ <td>Segments which are eligible for tiering, but are not in remote storage yet. Omitting 'topic=(...)' will yield the all-topic count</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteCopyLagSegments,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Delete Requests Per Sec</td>
+ <td>Rate of delete requests to remote storage per topic. Omitting 'topic=(...)' will yield the all-topic rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteDeleteRequestsPerSec,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Delete Errors Per Sec</td>
+ <td>Rate of delete errors from remote storage per topic. Omitting 'topic=(...)' will yield the all-topic rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteDeleteErrorsPerSec,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Delete Lag Bytes</td>
+ <td>Tiered bytes which are eligible for deletion, but have not been deleted yet. Omitting 'topic=(...)' will yield the all-topic sum</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteDeleteLagBytes,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Delete Lag Segments</td>
+ <td>Tiered segments which are eligible for deletion, but have not been deleted yet. Omitting 'topic=(...)' will yield the all-topic count</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteDeleteLagSegments,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Build Remote Log Aux State Requests Per Sec</td>
+ <td>Rate of requests for rebuilding the auxiliary state from remote storage per topic. Omitting 'topic=(...)' will yield the all-topic rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=BuildRemoteLogAuxStateRequestsPerSec,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Build Remote Log Aux State Errors Per Sec</td>
+ <td>Rate of errors for rebuilding the auxiliary state from remote storage per topic. Omitting 'topic=(...)' will yield the all-topic rate</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=BuildRemoteLogAuxStateErrorsPerSec,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Log Size Computation Time</td>
+ <td>The amount of time needed to compute the size of the remote log. Omitting 'topic=(...)' will yield the all-topic time</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteLogSizeComputationTime,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Log Size Bytes</td>
+ <td>The total size of a remote log in bytes. Omitting 'topic=(...)' will yield the all-topic sum</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteLogSizeBytes,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Remote Log Metadata Count</td>
+ <td>The total number of metadata entries for remote storage. Omitting 'topic=(...)' will yield the all-topic count</td>
+ <td>kafka.server:type=BrokerTopicMetrics,name=RemoteLogMetadataCount,topic=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>Delayed Remote Fetch Expires Per Sec</td>
+ <td>The number of expired remote fetches per second. Omitting 'topic=(...)' will yield the all-topic rate</td>
+ <td>kafka.server:type=DelayedRemoteFetchMetrics,name=ExpiresPerSec,topic=([-.\w]+)</td>
+ </tr>
<tr>
<td>RemoteLogReader Task Queue Size</td>
<td>Size of the queue holding remote storage read tasks</td>
diff --git a/docs/upgrade.html b/docs/upgrade.html
index d3713263206..dc3321616d6 100644
--- a/docs/upgrade.html
+++ b/docs/upgrade.html
@@ -19,6 +19,16 @@
<script id="upgrade-template" type="text/x-handlebars-template">
+<h4><a id="upgrade_3_7_0" href="#upgrade_3_7_0">Upgrading to 3.7.0 from any version 0.8.x through 3.6.x</a></h4>
+
+ <h5><a id="upgrade_370_notable" href="#upgrade_370_notable">Notable changes in 3.7.0</a></h5>
+ <ul>
+ <li>More metrics related to Tiered Storage have been introduced. They should improve the operational experience
+ of running Tiered Storage in production.
+ For more detailed information, please refer to <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-963%3A+Additional+metrics+in+Tiered+Storage">KIP-963</a>.
+ </li>
+ </ul>
+
<h4><a id="upgrade_3_6_0" href="#upgrade_3_6_0">Upgrading to 3.6.0 from any version 0.8.x through 3.5.x</a></h4>
<h5><a id="upgrade_360_zk" href="#upgrade_360_zk">Upgrading ZooKeeper-based clusters</a></h5>