Skip to content

ROB-906 Document the cluster query param across Send Events docs - #2138

Merged
Sheeproid merged 3 commits into
masterfrom
claude/docs-send-event-instructions-sw4hzt
Aug 12, 2026
Merged

ROB-906 Document the cluster query param across Send Events docs#2138
Sheeproid merged 3 commits into
masterfrom
claude/docs-send-event-instructions-sw4hzt

Conversation

@Sheeproid

Copy link
Copy Markdown
Contributor

Fixes ROB-906.

Problem

Every Send Events integration page documented only type, origin, and account_id. Copying the example URLs verbatim silently files every alert under the generic external cluster: 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

  • Added 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.
  • Added a consistent note under each Webhook URL: the name must exactly match the cluster's name as it appears in the Robusta UI (the clusterName the agent was installed with), and omitting cluster silently files alerts under external.
  • Upgraded the cluster param on the API index page from "Optional" to "Recommended", spelling out the payload-fallback and external-fallback behavior.
  • On the AlertManager page, clarified how the URL param relates to the cluster/cluster_name label 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_row in relay/pkg/apps/webhooks/executor.py and cluster_from_labels in parsers/base.py).

🤖 Generated with Claude Code

https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr


Generated by Claude Code

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
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown

Docker image ready for db612d8 (built in 44s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud 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:db612d8

Patch 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

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7104c755-6961-457d-a6bf-c98f1dea925e

📥 Commits

Reviewing files that changed from the base of the PR and between 45d292a and 178bbc7.

📒 Files selected for processing (1)
  • docs/configuration/exporting/send-events-api.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/configuration/exporting/send-events-api.rst

Walkthrough

The documentation adds a cluster query parameter to the Send Events API and webhook integrations. It documents exact cluster-name matching, parameter precedence, and fallback routing to payload data or the generic external cluster.

Changes

Cluster Routing Documentation

Layer / File(s) Summary
Send Events API cluster parameter
docs/configuration/exporting/send-events-api.rst
The API endpoint and example request include cluster. The documentation defines parameter precedence and fallback behavior.
Webhook cluster parameters
docs/configuration/exporting/send-events/*.rst
Webhook URLs and provider configuration examples include cluster placeholders. The documentation defines exact-name requirements and external fallback behavior.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: moshemorad, naomi-robusta

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes documenting the cluster query parameter across Send Events documentation.
Description check ✅ Passed The description directly explains the documentation gap, the affected integrations, and the cluster fallback behavior.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/docs-send-event-instructions-sw4hzt

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.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9243468 and df0c6c3.

📒 Files selected for processing (18)
  • docs/configuration/exporting/send-events-api.rst
  • docs/configuration/exporting/send-events/alertmanager.rst
  • docs/configuration/exporting/send-events/aws-cloudwatch.rst
  • docs/configuration/exporting/send-events/azure-monitor.rst
  • docs/configuration/exporting/send-events/datadog.rst
  • docs/configuration/exporting/send-events/dynatrace.rst
  • docs/configuration/exporting/send-events/f5.rst
  • docs/configuration/exporting/send-events/gcp-monitoring.rst
  • docs/configuration/exporting/send-events/grafana.rst
  • docs/configuration/exporting/send-events/jsm.rst
  • docs/configuration/exporting/send-events/nagios.rst
  • docs/configuration/exporting/send-events/newrelic.rst
  • docs/configuration/exporting/send-events/opsgenie.rst
  • docs/configuration/exporting/send-events/pagerduty.rst
  • docs/configuration/exporting/send-events/rootly.rst
  • docs/configuration/exporting/send-events/sentry.rst
  • docs/configuration/exporting/send-events/solarwinds.rst
  • docs/configuration/exporting/send-events/splunk.rst

Comment thread docs/configuration/exporting/send-events/alertmanager.rst Outdated
Comment thread docs/configuration/exporting/send-events/dynatrace.rst Outdated
Comment thread docs/configuration/exporting/send-events/f5.rst
@Sheeproid
Sheeproid enabled auto-merge (squash) August 12, 2026 15:17
@Sheeproid
Sheeproid merged commit 9ffe7ec into master Aug 12, 2026
7 checks passed
@Sheeproid
Sheeproid deleted the claude/docs-send-event-instructions-sw4hzt branch August 12, 2026 17:29
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