DOC-2197: Add Redpanda SQL metrics reference section#1721
Conversation
Appends a cloud-only section (ifdef::env-cloud[]) documenting 67 Oxla Prometheus metrics across admission, catalog, cluster, executor, kafka, memory, network, query, scheduler, and storage subsystems. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR adds a new "Redpanda SQL metrics" documentation section to the public metrics reference guide. The section is conditioned on the cloud environment and introduces oxla_-prefixed metric entries covering SQL engine monitoring areas including admissions, object storage requests, catalog transactions, cluster and node state, data-task execution, executor/scheduler/thread-pool operations, query execution statistics, PostgreSQL wire-protocol connections, and S3 lifecycle events. The documentation is inserted before the existing "Related topics" section. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/reference/pages/public-metrics-reference.adoc (1)
3541-4142: ⚡ Quick winConsider adding "Available in Serverless" indicators for consistency.
The SQL metrics section is cloud-only (wrapped in
ifdef::env-cloud[]), but unlike other cloud metrics in this file (e.g., Serverless metrics at lines 1434-1502), individual metrics don't include*Available in Serverless*: Yes/Notags. Since the section intro (line 3539) specifies "BYOC clusters," these metrics appear to be unavailable in Serverless.For consistency with the established pattern throughout this file, consider adding the following after each metric's
*Type*:line (and before any*Labels*:or---separator):*Available in Serverless*: NoThis would match the documentation style used for other cloud metrics and improve clarity for readers.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/reference/pages/public-metrics-reference.adoc` around lines 3541 - 4142, This SQL metrics block (metrics named like oxla_admission_active_queries through oxla_writers_opened_total) is cloud-only but lacks the "Available in Serverless" tag; add a line "*Available in Serverless*: No" immediately after each metric's "*Type*:" line (and before any "*Labels*:" or the "---" separator) for every metric in this section so it matches the established pattern used elsewhere.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@modules/reference/pages/public-metrics-reference.adoc`:
- Around line 3541-4142: This SQL metrics block (metrics named like
oxla_admission_active_queries through oxla_writers_opened_total) is cloud-only
but lacks the "Available in Serverless" tag; add a line "*Available in
Serverless*: No" immediately after each metric's "*Type*:" line (and before any
"*Labels*:" or the "---" separator) for every metric in this section so it
matches the established pattern used elsewhere.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 62a4e0e2-a179-4713-8175-457794e88858
📒 Files selected for processing (1)
modules/reference/pages/public-metrics-reference.adoc
Appends a cloud-only section (ifdef::env-cloud[]) documenting 67 Oxla Prometheus metrics across admission, catalog, cluster, executor, kafka, memory, network, query, scheduler, and storage subsystems.
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks