docs: document usage statistics reporting, including K8s deployment metadata (DOC-1910) - #1885
docs: document usage statistics reporting, including K8s deployment metadata (DOC-1910)#1885JakeSCahill wants to merge 2 commits into
Conversation
…etadata (DOC-1910) Add a usage statistics reporting section to the shared monitoring partial. It covers what the 24-hour report to Redpanda Data contains, the Kubernetes deployment metadata that chart and operator versions 26.1.1 and later inject through environment variables, and how to disable reporting on each platform. Verified against redpanda-operator main (charts/redpanda/metrics.go) and redpanda v26.2.1 (src/v/cluster/metrics_reporter.cc). Both opt-outs and the default injection validated by rendering the published 26.2.1 chart.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdded a table-of-contents link and a “Usage statistics reporting” section. The documentation describes the default reporting interval, report contents, configuration properties, Kubernetes metadata, inspection commands, and reporting controls. It includes Operator, Helm, and Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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/manage/partials/monitor-redpanda.adoc`:
- Around line 282-286: Update the introductory sentence above the kubectl
command to describe it as inspecting the Kubernetes metadata environment
variables configured for the Redpanda Pod, rather than claiming it shows exactly
what the deployment reports. Do not imply that the command displays reporter
state, usage reports, or data sent to Redpanda Data.
🪄 Autofix
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 Plus
Run ID: ecf691b8-f2f5-478b-b6e2-e69cca1990f4
📒 Files selected for processing (1)
modules/manage/partials/monitor-redpanda.adoc
Review finding: "To inspect exactly what your deployment reports" overclaimed. The kubectl exec command greps only the REDPANDA_METRICS_K8S_* environment variables on the redpanda container; it does not show the assembled usage report or the metrics reporter state. Reworded to describe the environment-variable inspection. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 participant
Resolves DOC-1910: documents the Kubernetes deployment telemetry that shipped in Operator/chart v26.1.1 (ENG-358). Until now the K8s docs had zero coverage of usage statistics reporting - the chart's own
values.yamlstill links to a stats-reporting docs anchor that no longer exists.Changes
Adds a Usage statistics reporting section to the shared
monitor-redpanda.adocpartial, so it renders on both the Linux and Kubernetes monitoring pages with platform-scoped content:enable_metrics_reporter/metrics_reporter_report_intervalproperties that control it.ifdef::env-kubernetes): the sixREDPANDA_METRICS_K8S_*environment variables the chart and operator inject since v26.1.1, including the detection caveats (no Azure/AKS detection, cluster ID requires reading thekube-systemnamespace), a note that Console reports separately, akubectl execcommand to inspect what a deployment reports, and Operator/Helm tabs for disabling.config.cluster.enable_metrics_reporter: falsedisables all reporting, whilelogging.usageStats.enabled: falseomits only the Kubernetes metadata.Verification
Everything was verified against source rather than the ticket's April research report:
charts/redpanda/metrics.goon redpanda-operator main: env var names, both gating conditions, GKE/EKS detection,kube-systemUID lookup.src/v/cluster/metrics_reporter.ccat redpanda v26.2.1: all six env vars are read into the report payload; report contents confirmed from the payload serializer.metrics.gofirst shipped inoperator/v26.1.1.helm template): default injection on theredpandacontainer,GCPdetection with a GKE kube-version and noENVIRONMENTvar with a plain one, and both documented opt-outs remove the variables.CLUSTER_IDis absent in offline renders only becauselookupneeds a live cluster.rpkcommand only on the Linux page, and the property xrefs resolve.🤖 Generated with Claude Code