This page is meant as a template for writing a KIP. To create a KIP choose Tools->Copy on this page and modify with your content and replace the heading with the next KIP number and a description of your issue. Replace anything in italics with your own description.
Status
Current state: "Under Discussion"
Discussion thread: here [Change the link from the KIP proposal email archive to your own email thread]
JIRA: here [Change the link from KAFKA-1 to your own ticket]
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
Motivation
Describe the problems you are trying to solve.
We would like to know the progress Tiered Storage is making in uploading and deleting/expiring segments. To achieve this we would like to expose a tier-upload and tier-delete metrics from the point of view of Kafka. Since upload and deletion are carried out by plugins such metrics emitted by Kafka are only going to be best estimates on what it believes the state of the world is. We propose the new metrics to be emitted on per topic and per partition granularity to be able to narrow down which brokers are slow.
We leave more detailed progress metrics to be emitted by the developers of tiered storage plugins.
Public Interfaces
Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. The purpose of this section is to concisely call out the public contract that will come along with this feature.
New Metrics
kafka.server:type=BrokerTopicMetrics, name=UploadTierLag,topic=([-.w]+),partition=([-.w]+) | The tier lag of a topic-partition is defined as the number of records in non-active segments not yet uploaded to the remote storage. |
kafka.server:type=BrokerTopicMetrics, name=DeleteTierLag,topic=([-.w]+),partition=([-.w]+) | The tier lag of a topic-partition is defined as the number of records in non-active segments marked for deletion but not yet deleted from remote storage. |
Proposed Changes
Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.
Reference implementation for UploadTierLag on topic level: https://github.com/satishd/kafka/commit/c96d3af4d02bf515a4355b14f33793211c5b3745
On the archive path of Tiered Storage we go through segments which are eligible for upload in a sequential manner. This allows us to emit the UploadTierLag metric by taking the difference between the segment's base offset and the base offset of the first segment not eligible for tiering.
In a similar manner, when we expire segments from Tiered Storage we go through them in a sequential manner. We can emit the DeleteTierLag metric by taking the difference between the segment's base offset and the end offset + 1 of the last eligible for deletion segment.
Compatibility, Deprecation, and Migration Plan
These are new metrics and as such shouldn't have compatibility concerns.
Test Plan
Describe in few sentences how the KIP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke?
Unit and integration tests.
Rejected Alternatives
If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.
N/A