SQL: monitoring#602
Conversation
New how-to page covering where SQL metrics appear and useful PromQL queries for node health, throughput, latency, admission control, and resource use. Nav-wired under Manage Redpanda SQL. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR adds a new "Monitor Redpanda SQL" documentation page that guides operators through monitoring Redpanda SQL using Prometheus/OpenMetrics metrics. The new page explains metric exposure via the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
| branches: HEAD | ||
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: ['DOC-2197-sql-monitoring', v/*, shared, site-search] |
There was a problem hiding this comment.
| branches: ['DOC-2197-sql-monitoring', v/*, shared, site-search] | |
| branches: [main, v/*, shared, site-search] |
commit before merge
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
♻️ Duplicate comments (1)
local-antora-playbook.yml (1)
18-18:⚠️ Potential issue | 🟠 Major | ⚡ Quick winUse only allowed branch patterns in playbook sources.
Line 18 introduces a non-standard branch (
DOC-2197-sql-monitoring) that violates the branch checker and fails CI. Replace it with the allowed set (for example includemainplus the existing allowed patterns) so local preview config passes validation.Suggested fix
- branches: ['DOC-2197-sql-monitoring', v/*, shared, site-search] + branches: [main, v/*, shared, site-search]🤖 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 `@local-antora-playbook.yml` at line 18, The branches entry under the playbook sources uses a non-allowed literal branch name; update the branches array (the branches: [...] key) to only use allowed patterns (e.g., include "main" and the existing allowed patterns) so CI branch-check passes—replace the literal 'DOC-2197-sql-monitoring' entry with "main" (keeping v/*, shared, site-search) in the branches list.
🤖 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.
Duplicate comments:
In `@local-antora-playbook.yml`:
- Line 18: The branches entry under the playbook sources uses a non-allowed
literal branch name; update the branches array (the branches: [...] key) to only
use allowed patterns (e.g., include "main" and the existing allowed patterns) so
CI branch-check passes—replace the literal 'DOC-2197-sql-monitoring' entry with
"main" (keeping v/*, shared, site-search) in the branches list.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 295e84af-de3d-4012-bcd3-b26e47fe5fcf
📒 Files selected for processing (3)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/sql/pages/manage/monitor-sql.adoc
1 participant
Description
This pull request introduces documentation for monitoring Redpanda SQL using Prometheus metrics, and updates navigation and playbook configuration to include the new content. The main focus is to help users identify and query Redpanda SQL metrics for operational monitoring.
New documentation for monitoring Redpanda SQL:
monitor-sql.adoc, detailing how to scrape and interpret Prometheus metrics from the Redpanda SQL engine, including example PromQL queries for node health, query throughput, errors, latency, admission control, and resource usage.Navigation and configuration updates:
nav.adoc).local-antora-playbook.yml) to reference the correct documentation branch for Redpanda SQL monitoring.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
https://deploy-preview-602--rp-cloud.netlify.app/cloud-data-platform/sql/manage/monitor-sql/
https://deploy-preview-602--rp-cloud.netlify.app/cloud-data-platform/reference/public-metrics-reference/#redpanda-sql-metrics
Checks