Skip to content

DOC-2196: Document Redpanda SQL billing metric#596

Merged
micheleRP merged 4 commits into
mainfrom
doc-2196-redpanda-sql-billing
May 22, 2026
Merged

DOC-2196: Document Redpanda SQL billing metric#596
micheleRP merged 4 commits into
mainfrom
doc-2196-redpanda-sql-billing

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 21, 2026

Description

Resolves: DOC-2196 (Jira). Engineering epic: ENG-1026.
Review deadline: none

Adds a == Redpanda SQL billing metrics section to the Billing page. Redpanda SQL is metered in RPU hours using the same RPU definition as Redpanda Streaming BYOC clusters (1 RPU = 2 vCPU + 8 GB memory), but the per-RPU price differs. Also renames the cluster-tab section heading from Usage-based billing metrics to Redpanda Streaming billing metrics so each product has a matching section heading, and updates the in-page anchor on the intro paragraph to match.

Page previews

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner May 21, 2026 20:52
@netlify
Copy link
Copy Markdown

netlify Bot commented May 21, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 86aeb08
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a10cd28cb1d1c0008d26589
😎 Deploy Preview https://deploy-preview-596--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
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8e7ec2a4-65a5-4220-81ab-a2679715d777

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

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR updates the billing documentation to clarify the distinction between Redpanda Streaming and SQL billing metrics. It changes cross-references and section headings from "usage-based billing metrics" to "Redpanda Streaming billing metrics," while preserving existing USD pricing and UTC/hourly billing details. A new "Redpanda SQL billing metrics" section is added, documenting Compute metrics with RPU definitions and a note explaining that SQL uses the same RPU concept as Streaming but with separate per-RPU pricing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • redpanda-data/cloud-docs#465: Both PRs modify modules/billing/pages/billing.adoc by expanding billing metrics sections; this PR specifically renames Streaming metrics and adds SQL metrics documentation, while the previous PR expanded usage-based billing content on the same page.

Suggested reviewers

  • kbatuigas
  • towfiqa
  • t-eckert
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly references the main change: documenting Redpanda SQL billing metrics as specified in the Jira issue DOC-2196.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description comprehensively follows the template with detailed information, including issue resolution, preview link, and a checked checkbox for the 'New feature' category.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-2196-redpanda-sql-billing

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@modules/billing/pages/billing.adoc`:
- Line 131: Update the NOTE text that reads "Redpanda SQL uses the same RPU
definition as Redpanda Streaming" to explicitly state that the RPU definition
referenced applies only to the Redpanda Streaming BYOC tier (not Serverless or
Dedicated), and point readers to the Streaming BYOC section (or include a direct
anchor/link) for the RPU definition and to the Serverless/Dedicated metrics
(Uptime, Ingress, Egress, Storage, Partitions) for those tiers so the
distinction is clear.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3427dd1a-3fa3-4ab1-8a7a-82a152c096fc

📥 Commits

Reviewing files that changed from the base of the PR and between 638d73b and 938ccd9.

📒 Files selected for processing (1)
  • modules/billing/pages/billing.adoc

Comment thread modules/billing/pages/billing.adoc Outdated
micheleRP added a commit that referenced this pull request May 21, 2026
Address CodeRabbit feedback on PR #596. Within the Streaming section,
only the BYOC tab uses RPU metrics (Serverless and Dedicated use Uptime,
Ingress, Egress, Storage, Partitions). Make the SQL note unambiguous
about which Streaming pricing model it's comparing against.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
micheleRP and others added 2 commits May 21, 2026 15:50
Add a Redpanda SQL billing metrics section to the Billing page. Redpanda
SQL is metered in RPU hours using the same RPU definition as Redpanda
Streaming, but the per-RPU price differs.

Rename the cluster-tab section from "Usage-based billing metrics" to
"Redpanda Streaming billing metrics" so each product's billing has a
matching section heading. Update the in-page anchor accordingly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Address CodeRabbit feedback on PR #596. Within the Streaming section,
only the BYOC tab uses RPU metrics (Serverless and Dedicated use Uptime,
Ingress, Egress, Storage, Partitions). Make the SQL note unambiguous
about which Streaming pricing model it's comparing against.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP force-pushed the doc-2196-redpanda-sql-billing branch from a6e804e to ece84df Compare May 21, 2026 21:51
Comment thread modules/billing/pages/billing.adoc Outdated
Comment thread modules/billing/pages/billing.adoc Outdated
Clarify that SQL pricing is tied to provisioned compute (measured
in RPUs) and replace the price-estimator link with "Contact your
Redpanda account team" since SQL is not yet listed there.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
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.

Docs standards review

Files reviewed: 1 .adoc file (modules/billing/pages/billing.adoc)
Overall: Small, well-scoped PR. CodeRabbit and Matt Schumpert's feedback has been addressed in-thread, the diff is clean, and the anchor rename was caught in the same PR. One open question on a What's New entry, plus a small wording observation.

What this PR does

Adds a == Redpanda SQL billing metrics H2 to the Billing page, defining SQL pricing as RPU-based using the same 1 RPU = 2 vCPU + 8 GB definition as Streaming BYOC. To make the three product sections parallel, it renames the cluster-tab heading from Usage-based billing metrics to Redpanda Streaming billing metrics, updates the in-page anchor reference at the top of the page to match, and inserts "usage-based" into the UTC-billing bullet.

Jira ticket alignment

Ticket: DOC-2196 — Document Redpanda SQL billing metric (engineering epic ENG-1026)
Aligned. The PR title, description, and diff all match the ticket scope. The note that "SQL uses the same RPU definition as Streaming BYOC, but per-RPU price differs" plus the "Contact your account team" guidance matches the engineering ask (SQL is not yet in the price estimator).

Critical issues

None.

Suggestions

  1. Bullet at the top of the page now reads "All usage-based billing computations are conducted in Coordinated Universal Time (UTC)." All three product sections on this page (Streaming, SQL, Connect) are usage-based, so the qualifier doesn't actually narrow anything — it just makes the sentence longer. Reverting to "All billing computations" reads cleaner and is still accurate.

  2. Two blank lines between the new SQL NOTE: and the next == Redpanda Connect billing metrics heading. The rest of the page uses one. Cosmetic only.

  3. glossterm for RPU — consider tagging Redpanda units or RPU with glossterm: on first occurrence in the SQL section, if an RPU glossary entry exists. The Streaming BYOC table above introduces RPU without a glossterm too, so the PR is consistent with precedent — but if you've been adding glossterms across the billing page, this is the spot to do it.

Impact on other files

  • modules/get-started/pages/whats-new-cloud.adoc (May 2026 section) — no What's New entry for SQL billing metrics. If Redpanda SQL is going GA / opening up to billable customers, this is the kind of change that typically warrants a release-notes mention. If this PR is part of the larger SQL GA bundle and a coordinated entry is planned elsewhere, that's fine — but worth confirming.
  • No stale xrefs. grep against the renamed anchor (usage-based-billing-metrics) and heading turned up zero hits. The only external xref to billing.adoc#… is to #redpanda-connect-pipeline-metrics, which is unchanged.
  • No nav.adoc update needed — no new page, just a new section.
  • No back-links to add — no Redpanda SQL page exists in cloud-docs yet to link to billing; this is expected if the SQL page lands in a separate PR.

CodeRabbit findings worth considering

None outstanding. CodeRabbit's one actionable finding (BYOC ambiguity in the RPU note) was already addressed in commit ece84df and acknowledged. Matt Schumpert's two inline asks (provisioned-capacity framing + account-team contact) were addressed in 1963345.

What works well

  • Renaming "Usage-based" → "Redpanda Streaming" makes the three H2s parallel and self-documenting.
  • The anchor rename (<<usage-based-billing-metrics>><<redpanda-streaming-billing-metrics>>) was caught and updated in the same PR — no stale internal links.
  • BYOC-scoping in the RPU comparison note is the right precision: within Streaming, only BYOC is RPU-based.
  • "Contact your Redpanda account team for current pricing" matches phrasing used elsewhere in billing docs.

Copy link
Copy Markdown
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

@micheleRP micheleRP merged commit 360f50c into main May 22, 2026
5 checks passed
@micheleRP micheleRP deleted the doc-2196-redpanda-sql-billing branch May 22, 2026 21:46
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