Skip to content

KAFKA-19922: Updated docs for start-offset in share groups (#20991) #20997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2025
Merged

KAFKA-19922: Updated docs for start-offset in share groups (#20991) #20997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion clients/src/main/java/org/apache/kafka/clients/admin/SharePartitionOffsetInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ public class SharePartitionOffsetInfo {
/**
* Construct a new SharePartitionOffsetInfo.
*
* @param startOffset The share-partition start offset
* @param startOffset The share-partition start offset. The start offset is the earliest offset
* for in-flight records being evaluated for delivery to share consumers.
* Some records after the start offset may already have completed delivery.
* @param leaderEpoch The optional leader epoch of the share-partition
* @param lag The optional lag for the share-partition
*/
Expand All @@ -41,14 +43,31 @@ public SharePartitionOffsetInfo(long startOffset, Optional<Integer> leaderEpoch,
this.lag = lag;
}

/**
* Get the start offset for the share-partition. The start offset is the earliest offset for
* in-flight records being evaluated for delivery to share consumers. Some records after the start
* offset may already have completed delivery.
*
* @return The start offset of the partition read by the share group.
*/
public long startOffset() {
return startOffset;
}

/**
* Get the leader epoch for the partition.
*
* @return The leader epoch of the partition.
*/
public Optional<Integer> leaderEpoch() {
return leaderEpoch;
}

/**
* Get the lag for the partition.
*
* @return The lag of the partition.
*/
public Optional<Long> lag() {
return lag;
}
Expand Down
2 changes: 2 additions & 0 deletions docs/ops.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,8 @@ <h4 class="anchor-heading"><a id="basic_ops_share_group" class="anchor-link"></a
GROUP TOPIC PARTITION START-OFFSET LAG
my-share-group topic1 0 4 0</code></pre>

The start offset is the earliest offset for in-flight records being evaluated for delivery to share consumers. Some records after the start offset may already have completed delivery.

NOTE: The admin client needs DESCRIBE access to all the topics used in the group.

There are many --describe options that provide more detailed information about a share group:
Expand Down