This is an automated email from the ASF dual-hosted git repository.
kamalcph pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new ccd986dce82 KAFKA-20157 Document KIP-1257 partition size percentage
metrics (#21613)
ccd986dce82 is described below
commit ccd986dce8209c1c3139a82fe337cfc98fcfb146
Author: manangupta111 <[email protected]>
AuthorDate: Tue Mar 3 09:10:17 2026 +0530
KAFKA-20157 Document KIP-1257 partition size percentage metrics (#21613)
Adds documentation for the new RetentionSizeInPercent and
LocalRetentionSizeInPercent metrics introduced in
[KIP-1257](https://cwiki.apache.org/confluence/display/KAFKA/KIP-1257%3A+Partition+Size+Percentage+Metrics+for+Storage+Monitoring).
This PR documents metrics added in:
- PR #21468 - Tiered storage metrics (RemoteLogManager)
- PR #21612 - Regular topic metrics (UnifiedLog)
Reviewers: Kamal Chandraprakash <[email protected]>
---------
Co-authored-by: manan.gupta <[email protected]>
---
docs/operations/monitoring.md | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/docs/operations/monitoring.md b/docs/operations/monitoring.md
index 21065cecabb..dee195d8dca 100644
--- a/docs/operations/monitoring.md
+++ b/docs/operations/monitoring.md
@@ -990,6 +990,19 @@ The size of a partition on disk, measured in bytes.
<tr>
<td>
+Partition size as a percentage of retention bytes limit
+</td>
+<td>
+
+kafka.log:type=Log,name=RetentionSizeInPercent,topic=([-.\w]+),partition=([0-9]+)
+</td>
+<td>
+
+The partition size expressed as a percentage of the configured retention.bytes
limit. Returns 0 for topics with tiered storage enabled (where the metric is
reported by RemoteLogManager) or when retention bytes is unlimited. May exceed
100% if retention cleanup is delayed.
+</td> </tr>
+<tr>
+<td>
+
Number of log segments in a partition
</td>
<td>
@@ -1836,6 +1849,32 @@
kafka.log.remote:type=RemoteLogManager,name=RemoteLogReaderFetchRateAndTimeMs
<tr>
<td>
+Retention Size In Percent
+</td>
+<td>
+
+Total partition size (local + remote) as a percentage of the configured
retention.bytes limit. Available for tiered storage topics. May exceed 100% if
retention cleanup is delayed. Returns 0 when retention bytes is unlimited.
+</td>
+<td>
+
+kafka.log.remote:type=RemoteLogManager,name=RetentionSizeInPercent,topic=([-.\w]+),partition=([0-9]+)
+</td> </tr>
+<tr>
+<td>
+
+Local Retention Size In Percent
+</td>
+<td>
+
+Local log size as a percentage of the configured local.retention.bytes limit.
Available for tiered storage topics. Helps operators monitor pressure on local
disks independently of remote storage. May exceed 100% if retention cleanup is
delayed. Returns 0 when local retention bytes is unlimited.
+</td>
+<td>
+
+kafka.log.remote:type=RemoteLogManager,name=LocalRetentionSizeInPercent,topic=([-.\w]+),partition=([0-9]+)
+</td> </tr>
+<tr>
+<td>
+
Delayed Remote List Offsets Expires Per Sec
</td>
<td>
