ROB-906 Document the cluster query param across Send Events docs - #2138
Conversation
Every Send Events integration page omitted the cluster query param, so copying the example URLs filed all alerts under the generic 'external' cluster with no visible error. Add cluster=<CLUSTER_NAME> to every webhook URL and example, with a note that the name must match the cluster as it appears in the Robusta UI and that omitting it silently files alerts under 'external'. Also clarify on the AlertManager page how the URL param relates to the cluster/cluster_name label mechanism used by the in-cluster integration. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr
|
✅ Docker image ready for
Use this tag to pull the image for testing. 📋 Copy commandsgcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:db612d8
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:db612d8 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:db612d8
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:db612d8Patch Helm values in one line: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:db612d8 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThe documentation adds a ChangesCluster Routing Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
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 |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@docs/configuration/exporting/send-events/alertmanager.rst`:
- Around line 20-24: Update the alert routing description in the surrounding
documentation so the generic external cluster is used only when both the cluster
URL parameter and the supported cluster or cluster_name alert labels are absent.
Preserve the stated precedence of the URL parameter over labels and keep the
existing distinction from the in-cluster AlertManager integration.
In `@docs/configuration/exporting/send-events/dynatrace.rst`:
- Line 21: Update the cluster-fallback wording at
docs/configuration/exporting/send-events/dynatrace.rst:21,
docs/configuration/exporting/send-events/f5.rst:21,
docs/configuration/exporting/send-events/gcp-monitoring.rst:21,
docs/configuration/exporting/send-events/grafana.rst:21,
docs/configuration/exporting/send-events/jsm.rst:22,
docs/configuration/exporting/send-events/nagios.rst:21,
docs/configuration/exporting/send-events/newrelic.rst:21,
docs/configuration/exporting/send-events/opsgenie.rst:21, and
docs/configuration/exporting/send-events/pagerduty.rst:21. Use the shared
wording to state that the URL cluster parameter takes precedence, the payload
cluster is used when the parameter is omitted, and alerts fall under external
only when neither source provides a cluster.
In `@docs/configuration/exporting/send-events/f5.rst`:
- Line 19: Remove or update the redundant cluster query-parameter instruction
near the F5 webhook configuration, so it refers users to the URL containing
cluster=<CLUSTER_NAME> rather than telling them to append it again.
🪄 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: 9c126a1c-24cf-4404-8faa-42714668cab6
📒 Files selected for processing (18)
docs/configuration/exporting/send-events-api.rstdocs/configuration/exporting/send-events/alertmanager.rstdocs/configuration/exporting/send-events/aws-cloudwatch.rstdocs/configuration/exporting/send-events/azure-monitor.rstdocs/configuration/exporting/send-events/datadog.rstdocs/configuration/exporting/send-events/dynatrace.rstdocs/configuration/exporting/send-events/f5.rstdocs/configuration/exporting/send-events/gcp-monitoring.rstdocs/configuration/exporting/send-events/grafana.rstdocs/configuration/exporting/send-events/jsm.rstdocs/configuration/exporting/send-events/nagios.rstdocs/configuration/exporting/send-events/newrelic.rstdocs/configuration/exporting/send-events/opsgenie.rstdocs/configuration/exporting/send-events/pagerduty.rstdocs/configuration/exporting/send-events/rootly.rstdocs/configuration/exporting/send-events/sentry.rstdocs/configuration/exporting/send-events/solarwinds.rstdocs/configuration/exporting/send-events/splunk.rst
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr
…page Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr
Fixes ROB-906.
Problem
Every Send Events integration page documented only
type,origin, andaccount_id. Copying the example URLs verbatim silently files every alert under the genericexternalcluster: the request returns HTTP 200, the alert appears in the UI, and nothing surfaces the omission — the only symptom is a wrong value in one UI column.Changes
cluster=<CLUSTER_NAME>to every webhook URL and example across all 17 Send Events integration pages (AlertManager, Grafana, Datadog, New Relic, Dynatrace, Splunk, Sentry, GCP, Azure, AWS CloudWatch, PagerDuty, Opsgenie, JSM, Rootly, F5, Nagios, SolarWinds) and the Send Events API index page.clusterNamethe agent was installed with), and omittingclustersilently files alerts underexternal.clusterparam on the API index page from "Optional" to "Recommended", spelling out the payload-fallback andexternal-fallback behavior.cluster/cluster_namelabel mechanism: the param takes precedence, labels are a payload fallback, and the in-cluster integration described on the out-of-cluster Prometheus page is a separate, label-only mechanism.Behavior verified against the relay implementation (
_cluster_override_from_rowinrelay/pkg/apps/webhooks/executor.pyandcluster_from_labelsinparsers/base.py).🤖 Generated with Claude Code
https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr
Generated by Claude Code