Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Dec 6, 2025

Description

Add support for Serverless metrics.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

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 December 6, 2025 00:55
@netlify
Copy link

netlify bot commented Dec 6, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit d5e5d23
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69337ef5e00e750008de545e
😎 Deploy Preview https://deploy-preview-471--rp-cloud.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 Dec 6, 2025

📝 Walkthrough

Walkthrough

This pull request updates documentation to reflect serverless observability capabilities. Changes include switching the Antora playbook branch to a feature-specific branch (DOC-1509-serverless-observability-single-source), updating the cloud-overview comparison table to enable Prometheus/OpenMetrics for cluster metrics, removing outdated distinctions between deployment types regarding metrics export, and expanding the monitoring guide with detailed Prometheus and Datadog configuration steps including YAML examples and authentication placeholders.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • local-antora-playbook.yml: Verify the feature branch name is correct and properly formatted with quotes
  • modules/get-started/pages/cloud-overview.adoc: Confirm the Prometheus/OpenMetrics status change is accurate and the removed capability item reflects current serverless functionality
  • modules/manage/pages/monitor-cloud.adoc: Validate that the YAML configuration snippets, placeholders, and connection steps are syntactically correct and match actual endpoint requirements; ensure the renamed section appropriately generalizes from BYOC/Dedicated to all Cloud cluster types

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • alexlavoie-redpanda
  • c4milo

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description uses the template but contains unfilled placeholders (issue number and page previews) and unchecked boxes, making it incomplete. Fill in the linked issue number (DOC-1509), add Netlify preview URLs for the three modified pages, and check the appropriate box for the type of change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update cloud pages for Serverless metrics' accurately summarizes the main change - updating documentation pages to document the observability endpoint for serverless.
Linked Issues check ✅ Passed The PR successfully documents the observability endpoint for serverless by enabling Prometheus/OpenMetrics endpoint for Serverless and updating related documentation.
Out of Scope Changes check ✅ Passed All changes align with DOC-1509 objective. The local-antora-playbook.yml branch update and all documentation changes support documenting serverless observability.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1509-document-feature-observability-endpoint-for-serve

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 6f64e23 and d5e5d23.

📒 Files selected for processing (3)
  • local-antora-playbook.yml (1 hunks)
  • modules/get-started/pages/cloud-overview.adoc (1 hunks)
  • modules/manage/pages/monitor-cloud.adoc (2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-04-25T01:42:09.318Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.

Applied to files:

  • modules/get-started/pages/cloud-overview.adoc
📚 Learning: 2025-04-25T01:41:57.162Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.

Applied to files:

  • modules/get-started/pages/cloud-overview.adoc
  • modules/manage/pages/monitor-cloud.adoc
📚 Learning: 2025-08-07T16:36:45.111Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.

Applied to files:

  • modules/get-started/pages/cloud-overview.adoc
  • modules/manage/pages/monitor-cloud.adoc
📚 Learning: 2025-08-15T04:45:28.695Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T04:45:28.695Z
Learning: In the Redpanda documentation system, content is single-sourced across multiple repositories (cloud-docs and docs repos). Include directives in the cloud-docs repo may reference files that exist in separate PRs in the docs repo. These PRs are linked via local-antora-playbook.yml for preview rendering, and the includes resolve correctly during the Antora build process when repositories are merged. The playbook is reverted to main before merging. This cross-repository single sourcing pattern is commonly used, so missing include targets should be verified against linked PRs in other repositories before flagging as errors.

Applied to files:

  • local-antora-playbook.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - rp-cloud
  • GitHub Check: Header rules - rp-cloud
  • GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (3)
modules/get-started/pages/cloud-overview.adoc (1)

86-89: Prometheus/OpenMetrics enablement for Serverless is correct.

The table update correctly reflects that Prometheus/OpenMetrics endpoint is now available for Serverless, aligning with the PR objective. The change is minimal and maintains consistency across all three deployment types.

local-antora-playbook.yml (1)

18-18: Feature branch configuration is correct.

The playbook update adds the DOC-1509-serverless-observability-single-source branch to enable preview builds with feature-specific documentation. This follows the single-source documentation pattern used for cross-repository includes and will be reverted to main before merge.

modules/manage/pages/monitor-cloud.adoc (1)

29-40: Verify endpoint domain format applies to all Cloud deployment types.

The YAML example endpoint contains .byoc.cloud.redpanda.com in the domain name. Since the section title was updated to "To monitor a Redpanda Cloud cluster" (implying all types), clarify whether:

  1. This endpoint domain format is correct for Serverless and Dedicated clusters as well, or
  2. The domain is BYOC-specific and the section should note deployment-type restrictions

Additionally, confirm the image reference on Line 27 (cloud_metrics.png) exists in the documentation assets.


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

@micheleRP
Copy link
Contributor

please also update here

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.

3 participants