docs(admin): document Admin#read_partition_offsets (ListOffsets API)#635
Merged
Conversation
Adds a new section to the Admin API page covering the upcoming `read_partition_offsets` method (karafka/karafka#3183). Documents the four offset specs (:earliest, :latest, :max_timestamp, ms timestamp), the isolation_level option for LSO-based lag on transactional topics, and how it compares to read_watermark_offsets.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for Karafka::Admin.read_partition_offsets, describing how it uses Kafka’s ListOffsets API via librdkafka to query offsets by spec (earliest/latest/max_timestamp/timestamp) and optionally apply transactional isolation for LSO-based lag calculations.
Changes:
- Added a new “Reading Partition Offsets” section covering capabilities, return shape, and key differences vs
read_watermark_offsets. - Included usage examples for basic calls, multi-topic queries, LSO (
READ_COMMITTED) queries, timestamp-based lookups, and:max_timestamp.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… rdkafka bindings
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.