From df0c6c30a7b8e75141030f231811e1cfa91d22fc Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 12 Aug 2026 14:38:15 +0000 Subject: [PATCH 1/3] ROB-906 Document the cluster query param across Send Events docs 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= 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 Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr --- docs/configuration/exporting/send-events-api.rst | 6 +++--- .../exporting/send-events/alertmanager.rst | 10 ++++++++-- .../exporting/send-events/aws-cloudwatch.rst | 8 +++++--- .../exporting/send-events/azure-monitor.rst | 6 ++++-- .../configuration/exporting/send-events/datadog.rst | 4 +++- .../exporting/send-events/dynatrace.rst | 4 +++- docs/configuration/exporting/send-events/f5.rst | 4 +++- .../exporting/send-events/gcp-monitoring.rst | 6 ++++-- .../configuration/exporting/send-events/grafana.rst | 4 +++- docs/configuration/exporting/send-events/jsm.rst | 4 +++- docs/configuration/exporting/send-events/nagios.rst | 6 ++++-- .../exporting/send-events/newrelic.rst | 4 +++- .../exporting/send-events/opsgenie.rst | 4 +++- .../exporting/send-events/pagerduty.rst | 4 +++- docs/configuration/exporting/send-events/rootly.rst | 4 ++-- docs/configuration/exporting/send-events/sentry.rst | 13 +++++++++---- .../exporting/send-events/solarwinds.rst | 6 ++++-- docs/configuration/exporting/send-events/splunk.rst | 6 ++++-- 18 files changed, 71 insertions(+), 32 deletions(-) diff --git a/docs/configuration/exporting/send-events-api.rst b/docs/configuration/exporting/send-events-api.rst index 6c184dc7e..1d624b853 100644 --- a/docs/configuration/exporting/send-events-api.rst +++ b/docs/configuration/exporting/send-events-api.rst @@ -32,7 +32,7 @@ Endpoint .. robusta-code:: - POST https://api.robusta.dev/webhooks?type=alert&origin=&account_id= + POST https://api.robusta.dev/webhooks?type=alert&origin=&account_id=&cluster= Query Parameters ---------------- @@ -50,7 +50,7 @@ Query Parameters * - ``account_id`` - Your Robusta account ID, found in ``generated_values.yaml``. * - ``cluster`` - - Optional. The cluster to associate the alert with. When set, it overrides any cluster found in the alert payload and is used for the resulting alert investigation. When omitted, the cluster is taken from the payload if present, otherwise the alert is recorded under the ``external`` cluster. Use this when your monitoring system cannot add a cluster label to the alert itself. + - Recommended. The cluster to associate the alert with. Set it to the exact name of the cluster as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with), so alerts are filed under that cluster and investigated in its context. When set, it overrides any cluster found in the alert payload. When omitted, the cluster is taken from the payload if present — otherwise the request still returns ``200`` but the alert is silently recorded under a generic ``external`` cluster. Authentication -------------- @@ -69,7 +69,7 @@ Example Request .. robusta-code:: bash curl --location --request POST \ - 'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID' \ + 'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID&cluster=CLUSTER_NAME' \ --header 'Authorization: Bearer API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ "title": "High error rate", "severity": "high" }' diff --git a/docs/configuration/exporting/send-events/alertmanager.rst b/docs/configuration/exporting/send-events/alertmanager.rst index 9336e09ac..d639e4dc2 100644 --- a/docs/configuration/exporting/send-events/alertmanager.rst +++ b/docs/configuration/exporting/send-events/alertmanager.rst @@ -15,7 +15,13 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. + +.. note:: + + If you can't set the URL parameter, this endpoint also reads the cluster from a ``cluster`` or ``cluster_name`` label on each alert (for example, set via Prometheus ``externalLabels``). The ``cluster`` URL parameter takes precedence over labels. Note this is a different mechanism from the :doc:`in-cluster AlertManager integration `, which routes by label only — following that page's label advice does not remove the need for the URL parameter (or label) here. Configure AlertManager ---------------------- @@ -27,7 +33,7 @@ Add a webhook receiver to ``alertmanager.yml``: receivers: - name: robusta webhook_configs: - - url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=' + - url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=&cluster=' send_resolved: true http_config: authorization: diff --git a/docs/configuration/exporting/send-events/aws-cloudwatch.rst b/docs/configuration/exporting/send-events/aws-cloudwatch.rst index 05d582ba9..1d8826af8 100644 --- a/docs/configuration/exporting/send-events/aws-cloudwatch.rst +++ b/docs/configuration/exporting/send-events/aws-cloudwatch.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Recipe ------ @@ -32,7 +34,7 @@ Recipe import urllib.error import urllib.request - URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=" + URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=&cluster=" TIMEOUT_SECONDS = 5 def lambda_handler(event, context): @@ -54,7 +56,7 @@ Recipe raise return {"ok": True} -4. Replace ```` with your Robusta account ID and deploy. +4. Replace ```` with your Robusta account ID and ```` with your cluster's name as it appears in the Robusta UI, then deploy. Alternatively, if you already use **Amazon EventBridge → API destination**, point the destination at the same URL with a Bearer token connection — no Lambda required. diff --git a/docs/configuration/exporting/send-events/azure-monitor.rst b/docs/configuration/exporting/send-events/azure-monitor.rst index 6ddcfc3bc..b7359e40e 100644 --- a/docs/configuration/exporting/send-events/azure-monitor.rst +++ b/docs/configuration/exporting/send-events/azure-monitor.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Azure --------------- @@ -25,7 +27,7 @@ Action Group webhook receivers do not allow custom headers, so authenticate via .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=&token= + https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=&cluster=&token= 1. In the Azure Portal, open **Monitor → Action groups** and either create a new group or edit an existing one. 2. Under **Actions**, add an action of type **Webhook**. diff --git a/docs/configuration/exporting/send-events/datadog.rst b/docs/configuration/exporting/send-events/datadog.rst index aaddc57c7..a600b25b1 100644 --- a/docs/configuration/exporting/send-events/datadog.rst +++ b/docs/configuration/exporting/send-events/datadog.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Datadog ----------------- diff --git a/docs/configuration/exporting/send-events/dynatrace.rst b/docs/configuration/exporting/send-events/dynatrace.rst index c0fe8c225..67eba8acc 100644 --- a/docs/configuration/exporting/send-events/dynatrace.rst +++ b/docs/configuration/exporting/send-events/dynatrace.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Dynatrace ------------------- diff --git a/docs/configuration/exporting/send-events/f5.rst b/docs/configuration/exporting/send-events/f5.rst index 2835f7b30..0edd29e3a 100644 --- a/docs/configuration/exporting/send-events/f5.rst +++ b/docs/configuration/exporting/send-events/f5.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure F5 Distributed Cloud ------------------------------ diff --git a/docs/configuration/exporting/send-events/gcp-monitoring.rst b/docs/configuration/exporting/send-events/gcp-monitoring.rst index 8845678d1..72700cfbf 100644 --- a/docs/configuration/exporting/send-events/gcp-monitoring.rst +++ b/docs/configuration/exporting/send-events/gcp-monitoring.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure GCP ------------- @@ -25,7 +27,7 @@ GCP webhook notification channels do not support custom headers in the console, .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=&token= + https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=&cluster=&token= The ``token`` query parameter is accepted as an alternative to the ``Authorization`` header. diff --git a/docs/configuration/exporting/send-events/grafana.rst b/docs/configuration/exporting/send-events/grafana.rst index f3cd2b453..41241cd22 100644 --- a/docs/configuration/exporting/send-events/grafana.rst +++ b/docs/configuration/exporting/send-events/grafana.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Grafana ----------------- diff --git a/docs/configuration/exporting/send-events/jsm.rst b/docs/configuration/exporting/send-events/jsm.rst index 0ee9a791b..aba0ff7a2 100644 --- a/docs/configuration/exporting/send-events/jsm.rst +++ b/docs/configuration/exporting/send-events/jsm.rst @@ -17,7 +17,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Jira Service Management --------------------------------- diff --git a/docs/configuration/exporting/send-events/nagios.rst b/docs/configuration/exporting/send-events/nagios.rst index 8e1a35412..c3041241b 100644 --- a/docs/configuration/exporting/send-events/nagios.rst +++ b/docs/configuration/exporting/send-events/nagios.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Nagios ---------------- @@ -51,7 +53,7 @@ Define a notification command that references ``$USER20$``: "type": "$NOTIFICATIONTYPE$", "output": "$SERVICEOUTPUT$" }' \ - 'https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=' + 'https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=&cluster=' } Define an analogous ``notify-robusta-host`` command, then attach both to a Nagios contact: diff --git a/docs/configuration/exporting/send-events/newrelic.rst b/docs/configuration/exporting/send-events/newrelic.rst index cbcdd962a..bb0834b8e 100644 --- a/docs/configuration/exporting/send-events/newrelic.rst +++ b/docs/configuration/exporting/send-events/newrelic.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=newrelic&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=newrelic&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure New Relic ------------------- diff --git a/docs/configuration/exporting/send-events/opsgenie.rst b/docs/configuration/exporting/send-events/opsgenie.rst index ac00f4971..5e924a55f 100644 --- a/docs/configuration/exporting/send-events/opsgenie.rst +++ b/docs/configuration/exporting/send-events/opsgenie.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=opsgenie&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=opsgenie&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Opsgenie ------------------ diff --git a/docs/configuration/exporting/send-events/pagerduty.rst b/docs/configuration/exporting/send-events/pagerduty.rst index 20efad710..4c54b8c1e 100644 --- a/docs/configuration/exporting/send-events/pagerduty.rst +++ b/docs/configuration/exporting/send-events/pagerduty.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure PagerDuty ------------------- diff --git a/docs/configuration/exporting/send-events/rootly.rst b/docs/configuration/exporting/send-events/rootly.rst index 4c788b5c2..2df5c850c 100644 --- a/docs/configuration/exporting/send-events/rootly.rst +++ b/docs/configuration/exporting/send-events/rootly.rst @@ -16,9 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=rootly&account_id=&token= + https://api.robusta.dev/webhooks?type=alert&origin=rootly&account_id=&cluster=&token= -Replace ```` with your Robusta account id and ```` with the API key you generated. +Replace ```` with your Robusta account id, ```` with the API key you generated, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Rootly ---------------- diff --git a/docs/configuration/exporting/send-events/sentry.rst b/docs/configuration/exporting/send-events/sentry.rst index f48a5cf52..d3b0cbd44 100644 --- a/docs/configuration/exporting/send-events/sentry.rst +++ b/docs/configuration/exporting/send-events/sentry.rst @@ -34,10 +34,15 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=sentry&account_id=&token= - -Replace ```` with your Robusta account id and -```` with the API key you just generated. + https://api.robusta.dev/webhooks?type=alert&origin=sentry&account_id=&cluster=&token= + +Replace ```` with your Robusta account id, +```` with the API key you just generated, and +```` with the name of the cluster to file alerts under. +The name must exactly match the cluster's name as it appears in the +Robusta UI (the ``clusterName`` your Robusta agent was installed +with). If ``cluster`` is omitted, alerts are silently filed under a +generic ``external`` cluster. .. note:: diff --git a/docs/configuration/exporting/send-events/solarwinds.rst b/docs/configuration/exporting/send-events/solarwinds.rst index 5ff02ee86..523d938c2 100644 --- a/docs/configuration/exporting/send-events/solarwinds.rst +++ b/docs/configuration/exporting/send-events/solarwinds.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure SolarWinds -------------------- @@ -25,7 +27,7 @@ SolarWinds does not ship a native bearer-token webhook action. Use the **Execute .. robusta-code:: - curl -sS -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" --data "{ \"alertName\": \"${N=Alerting;M=AlertName}\", \"node\": \"${N=SwisEntity;M=Caption}\", \"severity\": \"${N=Alerting;M=Severity}\", \"message\": \"${N=Alerting;M=AlertMessage}\" }" "https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=" + curl -sS -X POST -H "Authorization: Bearer " -H "Content-Type: application/json" --data "{ \"alertName\": \"${N=Alerting;M=AlertName}\", \"node\": \"${N=SwisEntity;M=Caption}\", \"severity\": \"${N=Alerting;M=Severity}\", \"message\": \"${N=Alerting;M=AlertMessage}\" }" "https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=&cluster=" Save the action and attach it to the alerts you want forwarded. diff --git a/docs/configuration/exporting/send-events/splunk.rst b/docs/configuration/exporting/send-events/splunk.rst index fe6b6702e..5a1e5482d 100644 --- a/docs/configuration/exporting/send-events/splunk.rst +++ b/docs/configuration/exporting/send-events/splunk.rst @@ -16,7 +16,9 @@ Webhook URL .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id= + https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=&cluster= + +Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. Configure Splunk ---------------- @@ -28,7 +30,7 @@ Splunk's built-in **Webhook** alert action does not let you set custom headers, .. robusta-code:: - https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=&token= + https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=&cluster=&token= 3. Save the search. If your Splunk environment has the **Webhook Alert Action** app installed, you can instead set an ``Authorization: Bearer `` header and use the plain webhook URL without ``&token=…``. From 45d292a0fff3e2f6686a7e2d88d7892c95d88685 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 12 Aug 2026 14:52:15 +0000 Subject: [PATCH 2/3] ROB-906 Shorten the cluster param notes in Send Events docs Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr --- docs/configuration/exporting/send-events/alertmanager.rst | 4 ++-- docs/configuration/exporting/send-events/aws-cloudwatch.rst | 2 +- docs/configuration/exporting/send-events/azure-monitor.rst | 2 +- docs/configuration/exporting/send-events/datadog.rst | 2 +- docs/configuration/exporting/send-events/dynatrace.rst | 2 +- docs/configuration/exporting/send-events/f5.rst | 2 +- docs/configuration/exporting/send-events/gcp-monitoring.rst | 2 +- docs/configuration/exporting/send-events/grafana.rst | 2 +- docs/configuration/exporting/send-events/jsm.rst | 2 +- docs/configuration/exporting/send-events/nagios.rst | 2 +- docs/configuration/exporting/send-events/newrelic.rst | 2 +- docs/configuration/exporting/send-events/opsgenie.rst | 2 +- docs/configuration/exporting/send-events/pagerduty.rst | 2 +- docs/configuration/exporting/send-events/rootly.rst | 2 +- docs/configuration/exporting/send-events/sentry.rst | 6 ++---- docs/configuration/exporting/send-events/solarwinds.rst | 2 +- docs/configuration/exporting/send-events/splunk.rst | 2 +- 17 files changed, 19 insertions(+), 21 deletions(-) diff --git a/docs/configuration/exporting/send-events/alertmanager.rst b/docs/configuration/exporting/send-events/alertmanager.rst index d639e4dc2..e6facca5b 100644 --- a/docs/configuration/exporting/send-events/alertmanager.rst +++ b/docs/configuration/exporting/send-events/alertmanager.rst @@ -17,11 +17,11 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. .. note:: - If you can't set the URL parameter, this endpoint also reads the cluster from a ``cluster`` or ``cluster_name`` label on each alert (for example, set via Prometheus ``externalLabels``). The ``cluster`` URL parameter takes precedence over labels. Note this is a different mechanism from the :doc:`in-cluster AlertManager integration `, which routes by label only — following that page's label advice does not remove the need for the URL parameter (or label) here. + Alerts can also carry the cluster as a ``cluster`` or ``cluster_name`` label (e.g. via Prometheus ``externalLabels``); the URL parameter takes precedence. The :doc:`in-cluster integration ` is a separate mechanism that routes by label only. Configure AlertManager ---------------------- diff --git a/docs/configuration/exporting/send-events/aws-cloudwatch.rst b/docs/configuration/exporting/send-events/aws-cloudwatch.rst index 1d8826af8..be86e9035 100644 --- a/docs/configuration/exporting/send-events/aws-cloudwatch.rst +++ b/docs/configuration/exporting/send-events/aws-cloudwatch.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Recipe ------ diff --git a/docs/configuration/exporting/send-events/azure-monitor.rst b/docs/configuration/exporting/send-events/azure-monitor.rst index b7359e40e..95b40ad5a 100644 --- a/docs/configuration/exporting/send-events/azure-monitor.rst +++ b/docs/configuration/exporting/send-events/azure-monitor.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Azure --------------- diff --git a/docs/configuration/exporting/send-events/datadog.rst b/docs/configuration/exporting/send-events/datadog.rst index a600b25b1..ee6bf489c 100644 --- a/docs/configuration/exporting/send-events/datadog.rst +++ b/docs/configuration/exporting/send-events/datadog.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Datadog ----------------- diff --git a/docs/configuration/exporting/send-events/dynatrace.rst b/docs/configuration/exporting/send-events/dynatrace.rst index 67eba8acc..9cdbb26b9 100644 --- a/docs/configuration/exporting/send-events/dynatrace.rst +++ b/docs/configuration/exporting/send-events/dynatrace.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Dynatrace ------------------- diff --git a/docs/configuration/exporting/send-events/f5.rst b/docs/configuration/exporting/send-events/f5.rst index 0edd29e3a..8415fbe31 100644 --- a/docs/configuration/exporting/send-events/f5.rst +++ b/docs/configuration/exporting/send-events/f5.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure F5 Distributed Cloud ------------------------------ diff --git a/docs/configuration/exporting/send-events/gcp-monitoring.rst b/docs/configuration/exporting/send-events/gcp-monitoring.rst index 72700cfbf..a0c5c3e8d 100644 --- a/docs/configuration/exporting/send-events/gcp-monitoring.rst +++ b/docs/configuration/exporting/send-events/gcp-monitoring.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure GCP ------------- diff --git a/docs/configuration/exporting/send-events/grafana.rst b/docs/configuration/exporting/send-events/grafana.rst index 41241cd22..301776712 100644 --- a/docs/configuration/exporting/send-events/grafana.rst +++ b/docs/configuration/exporting/send-events/grafana.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Grafana ----------------- diff --git a/docs/configuration/exporting/send-events/jsm.rst b/docs/configuration/exporting/send-events/jsm.rst index aba0ff7a2..8f2758524 100644 --- a/docs/configuration/exporting/send-events/jsm.rst +++ b/docs/configuration/exporting/send-events/jsm.rst @@ -19,7 +19,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Jira Service Management --------------------------------- diff --git a/docs/configuration/exporting/send-events/nagios.rst b/docs/configuration/exporting/send-events/nagios.rst index c3041241b..9cd645765 100644 --- a/docs/configuration/exporting/send-events/nagios.rst +++ b/docs/configuration/exporting/send-events/nagios.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=nagios&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Nagios ---------------- diff --git a/docs/configuration/exporting/send-events/newrelic.rst b/docs/configuration/exporting/send-events/newrelic.rst index bb0834b8e..97b80cded 100644 --- a/docs/configuration/exporting/send-events/newrelic.rst +++ b/docs/configuration/exporting/send-events/newrelic.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=newrelic&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure New Relic ------------------- diff --git a/docs/configuration/exporting/send-events/opsgenie.rst b/docs/configuration/exporting/send-events/opsgenie.rst index 5e924a55f..20b3ba3d2 100644 --- a/docs/configuration/exporting/send-events/opsgenie.rst +++ b/docs/configuration/exporting/send-events/opsgenie.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=opsgenie&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Opsgenie ------------------ diff --git a/docs/configuration/exporting/send-events/pagerduty.rst b/docs/configuration/exporting/send-events/pagerduty.rst index 4c54b8c1e..752cb8ad8 100644 --- a/docs/configuration/exporting/send-events/pagerduty.rst +++ b/docs/configuration/exporting/send-events/pagerduty.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=pagerduty&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure PagerDuty ------------------- diff --git a/docs/configuration/exporting/send-events/rootly.rst b/docs/configuration/exporting/send-events/rootly.rst index 2df5c850c..69eaa9619 100644 --- a/docs/configuration/exporting/send-events/rootly.rst +++ b/docs/configuration/exporting/send-events/rootly.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=rootly&account_id=&cluster=&token= -Replace ```` with your Robusta account id, ```` with the API key you generated, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id, ```` with the API key you generated, and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Rootly ---------------- diff --git a/docs/configuration/exporting/send-events/sentry.rst b/docs/configuration/exporting/send-events/sentry.rst index d3b0cbd44..3e6275235 100644 --- a/docs/configuration/exporting/send-events/sentry.rst +++ b/docs/configuration/exporting/send-events/sentry.rst @@ -38,10 +38,8 @@ Webhook URL Replace ```` with your Robusta account id, ```` with the API key you just generated, and -```` with the name of the cluster to file alerts under. -The name must exactly match the cluster's name as it appears in the -Robusta UI (the ``clusterName`` your Robusta agent was installed -with). If ``cluster`` is omitted, alerts are silently filed under a +```` with your cluster's name exactly as it appears in +the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. .. note:: diff --git a/docs/configuration/exporting/send-events/solarwinds.rst b/docs/configuration/exporting/send-events/solarwinds.rst index 523d938c2..5ca015485 100644 --- a/docs/configuration/exporting/send-events/solarwinds.rst +++ b/docs/configuration/exporting/send-events/solarwinds.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=solarwinds&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure SolarWinds -------------------- diff --git a/docs/configuration/exporting/send-events/splunk.rst b/docs/configuration/exporting/send-events/splunk.rst index 5a1e5482d..98a6db3bb 100644 --- a/docs/configuration/exporting/send-events/splunk.rst +++ b/docs/configuration/exporting/send-events/splunk.rst @@ -18,7 +18,7 @@ Webhook URL https://api.robusta.dev/webhooks?type=alert&origin=splunk&account_id=&cluster= -Replace ```` with your Robusta account id, and ```` with the name of the cluster to file alerts under. The name must exactly match the cluster's name as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with). If ``cluster`` is omitted, alerts are silently filed under a generic ``external`` cluster. +Replace ```` with your Robusta account id and ```` with your cluster's name exactly as it appears in the Robusta UI. If ``cluster`` is omitted, alerts are filed under a generic ``external`` cluster. Configure Splunk ---------------- From 178bbc7f2e153da42700e2282d4933dfad3ec62e Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 12 Aug 2026 15:11:13 +0000 Subject: [PATCH 3/3] ROB-906 Tighten the cluster param description on the Send Events API page Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr --- docs/configuration/exporting/send-events-api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/exporting/send-events-api.rst b/docs/configuration/exporting/send-events-api.rst index 1d624b853..60be0289d 100644 --- a/docs/configuration/exporting/send-events-api.rst +++ b/docs/configuration/exporting/send-events-api.rst @@ -50,7 +50,7 @@ Query Parameters * - ``account_id`` - Your Robusta account ID, found in ``generated_values.yaml``. * - ``cluster`` - - Recommended. The cluster to associate the alert with. Set it to the exact name of the cluster as it appears in the Robusta UI (the ``clusterName`` your Robusta agent was installed with), so alerts are filed under that cluster and investigated in its context. When set, it overrides any cluster found in the alert payload. When omitted, the cluster is taken from the payload if present — otherwise the request still returns ``200`` but the alert is silently recorded under a generic ``external`` cluster. + - Recommended. The cluster to file the alert under — use the exact name shown in the Robusta UI. Overrides any cluster in the alert payload. If omitted, the cluster is taken from the payload, or silently defaults to ``external``. Authentication --------------