Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Oct 31, 2025

Description

This pull request updates Redpanda documentation to highlight and demonstrate the use of the rpk cluster connections list command 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 list command alongside the Admin API ListKafkaConnections endpoint 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 rpk and curl usage 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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@kbatuigas kbatuigas requested a review from a team as a code owner October 31, 2025 06:16
@netlify
Copy link

netlify bot commented Oct 31, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit a1b562d
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6904f332505a0a0008a5c78b
😎 Deploy Preview https://deploy-preview-1431--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 31, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1726-document-feature-rpk-commands-for-active-client-m

Comment @coderabbitai help to get the list of available commands and usage tips.

@kbatuigas kbatuigas changed the title Doc 1726 document feature rpk commands for active client m [25.3] Add rpk cluster connections list examples Oct 31, 2025
@kbatuigas kbatuigas requested a review from graham-rp October 31, 2025 16:24
Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

lgtm
In Configure Client connections, there is a Tip that includes connect in bold surrounded by periods--please take a look, as this does not look correct. Fix here if you can. Thx

@kbatuigas kbatuigas merged commit ec52414 into beta Oct 31, 2025
5 checks passed
@kbatuigas kbatuigas deleted the DOC-1726-document-feature-rpk-commands-for-active-client-m branch October 31, 2025 17:47
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.

4 participants