[25.3] Add rpk cluster connections list examples #1431
Merged
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.
Description
This pull request updates Redpanda documentation to highlight and demonstrate the use of the
rpk cluster connections listcommand for monitoring Kafka client connections, in addition to the existing Admin API method. The changes add practical examples, command usage tabs, and improve clarity for users on how to identify and troubleshoot client connections using both CLI and API approaches.Enhancements to client connection monitoring documentation:
Added references and examples for using the
rpk cluster connections listcommand alongside the Admin APIListKafkaConnectionsendpoint throughout the documentation, making it easier for users to monitor client connections via CLI or API. [1] [2] [3]Introduced tabbed code examples showing both
rpkandcurlusage for listing, filtering, and sorting Kafka client connections, including sample command outputs and improved formatting for clarity. [1] [2] [3] [4] [5]Improvements to example responses and formatting:
Updated example API responses to be collapsible and more concise, replacing long inlined JSON with expandable sections and ellipses to focus on relevant details. [1] [2] [3] [4]
Enhanced filtering and sorting instructions for identifying high-throughput clients, including practical filter examples and output samples for both CLI and API methods. [1] [2]
Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 31 Oct
Page previews
Manage Throughput > View connected client details
Monitor Redpanda > Identify high-throughput clients
Configure Client Connections
Checks