Skip to content

Commit 9ffe7ec

Browse files
Sheeproidclaude
andauthored
ROB-906 Document the cluster query param across Send Events docs (#2138)
* 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=<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 * ROB-906 Shorten the cluster param notes in Send Events docs Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr * ROB-906 Tighten the cluster param description on the Send Events API page Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WfTuEudsMxDEEY9moaiQjr --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 9243468 commit 9ffe7ec

18 files changed

Lines changed: 68 additions & 31 deletions

docs/configuration/exporting/send-events-api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Endpoint
3232

3333
.. robusta-code::
3434

35-
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
35+
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
3636

3737
Query Parameters
3838
----------------
@@ -50,7 +50,7 @@ Query Parameters
5050
* - ``account_id``
5151
- Your Robusta account ID, found in ``generated_values.yaml``.
5252
* - ``cluster``
53-
- 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.
53+
- 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``.
5454

5555
Authentication
5656
--------------
@@ -69,7 +69,7 @@ Example Request
6969
.. robusta-code:: bash
7070

7171
curl --location --request POST \
72-
'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID' \
72+
'https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=ACCOUNT_ID&cluster=CLUSTER_NAME' \
7373
--header 'Authorization: Bearer API_KEY' \
7474
--header 'Content-Type: application/json' \
7575
--data-raw '{ "title": "High error rate", "severity": "high" }'

docs/configuration/exporting/send-events/alertmanager.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,13 @@ Webhook URL
1515

1616
.. robusta-code::
1717

18-
https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>
18+
https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
19+
20+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
21+
22+
.. note::
23+
24+
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 </configuration/alertmanager-integration/outofcluster-prometheus>` is a separate mechanism that routes by label only.
1925

2026
Configure AlertManager
2127
----------------------
@@ -27,7 +33,7 @@ Add a webhook receiver to ``alertmanager.yml``:
2733
receivers:
2834
- name: robusta
2935
webhook_configs:
30-
- url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>'
36+
- url: 'https://api.robusta.dev/webhooks?type=alert&origin=alertmanager&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>'
3137
send_resolved: true
3238
http_config:
3339
authorization:

docs/configuration/exporting/send-events/aws-cloudwatch.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Recipe
2224
------
@@ -32,7 +34,7 @@ Recipe
3234
import urllib.error
3335
import urllib.request
3436

35-
URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>"
37+
URL = "https://api.robusta.dev/webhooks?type=alert&origin=awscloudwatch&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>"
3638
TIMEOUT_SECONDS = 5
3739

3840
def lambda_handler(event, context):
@@ -54,7 +56,7 @@ Recipe
5456
raise
5557
return {"ok": True}
5658

57-
4. Replace ``<ACCOUNT_ID>`` with your Robusta account ID and deploy.
59+
4. Replace ``<ACCOUNT_ID>`` with your Robusta account ID and ``<CLUSTER_NAME>`` with your cluster's name as it appears in the Robusta UI, then deploy.
5860

5961
Alternatively, if you already use **Amazon EventBridge → API destination**, point the destination at the same URL with a Bearer token connection — no Lambda required.
6062

docs/configuration/exporting/send-events/azure-monitor.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure Azure
2224
---------------
@@ -25,7 +27,7 @@ Action Group webhook receivers do not allow custom headers, so authenticate via
2527

2628
.. robusta-code::
2729

28-
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
30+
https://api.robusta.dev/webhooks?type=alert&origin=azure&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>
2931

3032
1. In the Azure Portal, open **Monitor → Action groups** and either create a new group or edit an existing one.
3133
2. Under **Actions**, add an action of type **Webhook**.

docs/configuration/exporting/send-events/datadog.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=datadog&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure Datadog
2224
-----------------

docs/configuration/exporting/send-events/dynatrace.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=dynatrace&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure Dynatrace
2224
-------------------

docs/configuration/exporting/send-events/f5.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=f5&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure F5 Distributed Cloud
2224
------------------------------

docs/configuration/exporting/send-events/gcp-monitoring.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure GCP
2224
-------------
@@ -25,7 +27,7 @@ GCP webhook notification channels do not support custom headers in the console,
2527

2628
.. robusta-code::
2729

28-
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&token=<ROBUSTA_API_KEY>
30+
https://api.robusta.dev/webhooks?type=alert&origin=gcp&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>&token=<ROBUSTA_API_KEY>
2931

3032
The ``token`` query parameter is accepted as an alternative to the ``Authorization`` header.
3133

docs/configuration/exporting/send-events/grafana.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Webhook URL
1616

1717
.. robusta-code::
1818

19-
https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=<ACCOUNT_ID>
19+
https://api.robusta.dev/webhooks?type=alert&origin=grafana&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
20+
21+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2022

2123
Configure Grafana
2224
-----------------

docs/configuration/exporting/send-events/jsm.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ Webhook URL
1717

1818
.. robusta-code::
1919

20-
https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=<ACCOUNT_ID>
20+
https://api.robusta.dev/webhooks?type=alert&origin=jsm&account_id=<ACCOUNT_ID>&cluster=<CLUSTER_NAME>
21+
22+
Replace ``<ACCOUNT_ID>`` with your Robusta account id and ``<CLUSTER_NAME>`` 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.
2123

2224
Configure Jira Service Management
2325
---------------------------------

0 commit comments

Comments
 (0)