Skip to content

Add DescribeConsumer support in Topic SDK#760

Merged
vgvoleg merged 1 commit intomainfrom
feature/describe-consumer-713
Jan 30, 2026
Merged

Add DescribeConsumer support in Topic SDK#760
vgvoleg merged 1 commit intomainfrom
feature/describe-consumer-713

Conversation

@vgvoleg
Copy link
Copy Markdown
Member

@vgvoleg vgvoleg commented Jan 30, 2026

Implements DescribeConsumer API call for Topic SDK, allowing users to get detailed information about a topic's consumer including partition stats and consumer offsets.

Closes #713

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Other information

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds support for the TopicService DescribeConsumer API in the Python Topic SDK so users can fetch consumer details (including optional per-partition stats and location info).

Changes:

  • Added describe_consumer() to both async and sync Topic clients.
  • Introduced new public request/response types for DescribeConsumer, plus corresponding grpcwrapper parsing/to_public conversions.
  • Added control-plane tests covering DescribeConsumer basics and offset/stat assertions.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
ydb/topic.py Exposes describe_consumer() on async/sync clients and exports TopicConsumerDescription.
ydb/_grpc/grpcwrapper/ydb_topic_public_types.py Adds DescribeConsumer request params and public result dataclasses for consumer/partition stats and location.
ydb/_grpc/grpcwrapper/ydb_topic.py Implements protobuf-to-public conversions for DescribeConsumerResult, PartitionConsumerStats, and PartitionLocation.
ydb/_apis.py Registers DescribeConsumer method name constant for TopicService calls.
tests/topics/test_control_plane.py Adds async/sync tests for DescribeConsumer, including stats and committed offsets.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread ydb/_grpc/grpcwrapper/ydb_topic.py Outdated
Comment thread ydb/_grpc/grpcwrapper/ydb_topic.py Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tests/topics/test_control_plane.py
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread ydb/topic.py
Comment thread ydb/topic.py
Implements DescribeConsumer API call for Topic SDK, allowing users to
get detailed information about a topic's consumer including partition
stats and consumer offsets.

Closes #713
@vgvoleg vgvoleg force-pushed the feature/describe-consumer-713 branch from bedcf7b to 4e23719 Compare January 30, 2026 11:16
@vgvoleg vgvoleg merged commit 83ea174 into main Jan 30, 2026
23 checks passed
@vgvoleg vgvoleg deleted the feature/describe-consumer-713 branch January 30, 2026 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature: DescribeConsumer in Topic SDK

3 participants