proto: don't require proxying for list broker calls #29133
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modifies the ListBrokers RPC to no longer require proxying requests to all brokers, preventing failures when individual brokers are down. The change makes node_id in GetBrokerRequest optional (using protobuf optional instead of the -1 sentinel value) and makes build_info and admin_server fields optional in the Broker message, with documentation noting they're only populated for GetBroker RPCs.
Key Changes:
- Changed
GetBrokerRequest.node_idfrom required to optional field - Made
Broker.build_infoandBroker.admin_serveroptional fields that are only populated forGetBrokercalls - Modified
list_brokersimplementation to directly populate broker node IDs without proxying
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/redpanda/core/admin/v2/broker.proto | Changed node_id, build_info, and admin_server to optional fields with updated documentation |
| src/v/redpanda/admin/services/broker.cc | Updated get_broker to check for optional node_id and modified list_brokers to populate only node IDs without proxying |
| tests/rptest/clients/admin/proto/redpanda/core/admin/v2/broker_pb2.py | Regenerated Python protobuf code reflecting the optional field changes |
| tests/rptest/clients/admin/proto/redpanda/core/admin/v2/broker_pb2.pyi | Regenerated Python type stubs with new optional field signatures and methods |
Comments suppressed due to low confidence (1)
src/v/redpanda/admin/services/broker.cc:1
- The comparison
target != -1is now redundant sincenode_idis optional and this code is only reached whenhas_node_id()is true. If the intent was to support-1as a sentinel value for backward compatibility, the current implementation still doesn't handle it properly (it would treat-1as a valid target). Either remove the-1check entirely or add explicit handling for the-1case.
/*
Collaborator
Retry command for Build#78465please wait until all jobs are finished before running the slash command |
Collaborator
rockwotj
force-pushed
the
broker_protos
branch
2 times, most recently
from
42510a7 to
5de3179
Compare
Collaborator
Retry command for Build#78495please wait until all jobs are finished before running the slash command |
Currently a single broker being down means the list broker calls will fail, which is undesirable. To fix this we omit some information in ListBroker RPCs. While this is a semantic breaking change, it's not a wire or generated code breaking change. We also use an `optional` for node_id instead of `-1`, as that's much cleaner. We don't break compatibility here FWIW.
rockwotj
force-pushed
the
broker_protos
branch
from
5de3179 to
4c9d721
Compare
Contributor
michael-redpanda
left a comment
michael-redpanda
left a comment
There was a problem hiding this comment.
lgtm - are we going to backport this? Do we have any downstream consumers using this today?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Currently a single broker being down means the list broker calls will
fail, which is undesirable. To fix this we omit some information in
ListBroker RPCs. While this is a semantic breaking change, it's not a
wire or generated code breaking change.
We also use an
optionalfor node_id instead of-1, as that's muchcleaner. We don't break compatibility here FWIW.
Backports Required
Release Notes
Improvements
ListBrokersin the Admin v2 API doesn't require all brokers to be up.