Document Connection::Client/Proxy#read_partition_offsets - #991
Open
coipond-writer[bot] wants to merge 1 commit into
Open
Document Connection::Client/Proxy#read_partition_offsets#991coipond-writer[bot] wants to merge 1 commit into
coipond-writer[bot] wants to merge 1 commit into
Conversation
connection/client.rb:463-481 and connection/proxy.rb:68-111 define a 2.6.0 read_partition_offsets on the consumer's own connection (as opposed to Karafka::Admin's dedicated admin connection). It accepts the same topic_partition_offsets spec, forwards the consumer's own isolation.level, and is used internally by the Pro Iterator (pro/iterator/tpl_builder.rb) and lag-compensation (pro/instrumentation/consumer_groups/lag_compensation/fetcher.rb) features. No wiki page mentioned this method exists. Added a "Consumer-Side Counterpart" subsection cross-linked from the Admin API's Reading Partition Offsets section, including its own :latest/isolation-level caveat as documented directly in connection/client.rb's docstring. Fixes #44803.
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.
What
`connection/client.rb:463-481` and `connection/proxy.rb:68-111` define a 2.6.0 `read_partition_offsets` on the consumer's own connection (as opposed to `Karafka::Admin`'s dedicated admin connection). It is used internally by the Pro Iterator (`pro/iterator/tpl_builder.rb`) and lag-compensation (`pro/instrumentation/consumer_groups/lag_compensation/fetcher.rb`) features. No wiki page mentioned this method exists.
Fix
Added a "Consumer-Side Counterpart" subsection cross-linked from the Admin API's Reading Partition Offsets section, including its own `:latest`/isolation-level caveat as documented directly in `connection/client.rb`'s docstring (this PR only documents what this method's own docstring says about itself -- it does not touch or resolve the separate `Admin::Topics#read_partition_offsets` LSO-recipe dispute tracked in #44792).
Fixes #44803 (Redmine).