You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Drop HMAC/signature-ignored note on PagerDuty page.
- Replace Delivery Log mentions in every Verify section with a
simple 'alert should appear on the Robusta timeline' line.
- Trim the main page: remove HolmesGPT marketing sentence, the
Response/Errors sections, rate-limit numbers, and the
401-on-mismatch note.
- Collapse the Query Parameters table from four columns to two.
- Shorten the Nagios resource.cfg security explanation.
- Drop the 'token is an alternative to Authorization' meta note
from the GCP page.
Copy file name to clipboardExpand all lines: docs/configuration/exporting/send-events-api.rst
+3-32Lines changed: 3 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
Send Events API
2
2
================
3
3
4
-
Send alerts from any monitoring system to Robusta through a single webhook endpoint. HolmesGPT investigates each alert against your live cluster state, logs, metrics, and connected data sources, and attaches its findings to help accelerate triage.
4
+
Send alerts from your monitoring system to Robusta through a single webhook endpoint.
5
5
6
6
This is the recommended ingestion path for new integrations. The legacy :doc:`Send Alerts API </configuration/exporting/send-alerts-api>` remains available for existing customers.
7
7
@@ -24,11 +24,9 @@ This is the recommended ingestion path for new integrations. The legacy :doc:`Se
24
24
send-events/solarwinds
25
25
send-events/splunk
26
26
27
-
Overview
27
+
Endpoint
28
28
--------
29
29
30
-
The endpoint accepts the default payload structure of the supported origins. The request is parameterized by query string:
31
-
32
30
.. code-block::
33
31
34
32
POST https://api.robusta.dev/webhooks?type=alert&origin=<ORIGIN>&account_id=<ACCOUNT_ID>
@@ -37,25 +35,17 @@ Query Parameters
37
35
----------------
38
36
39
37
.. list-table::
40
-
:widths: 20 10 60 10
38
+
:widths: 20 70
41
39
:header-rows: 1
42
40
43
41
* - Parameter
44
-
- Type
45
42
- Description
46
-
- Required
47
43
* - ``type``
48
-
- string
49
44
- Must be ``alert``.
50
-
- Yes
51
45
* - ``origin``
52
-
- string
53
46
- Identifies the monitoring product. Must be one of the supported origins listed under `Integrations`_ below.
54
-
- Yes
55
47
* - ``account_id``
56
-
- string
57
48
- Your Robusta account ID, found in ``generated_values.yaml``.
58
-
- Yes
59
49
60
50
Authentication
61
51
--------------
@@ -66,8 +56,6 @@ Send your Robusta API key as a Bearer token. Generate keys in the Robusta UI und
66
56
67
57
Authorization: Bearer <API_KEY>
68
58
69
-
The key must be scoped to the ``account_id`` query parameter. Mismatches return ``401``.
Copy file name to clipboardExpand all lines: docs/configuration/exporting/send-events/nagios.rst
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,23 +21,21 @@ Webhook URL
21
21
Configure Nagios
22
22
----------------
23
23
24
-
Nagios delivers notifications by running shell commands. Define a command that POSTs the alert as JSON.
25
-
26
-
Store the API key in ``resource.cfg`` rather than inlining it in ``commands.cfg`` so that it does not appear in command definitions, command-line process listings, or backups of the main configuration:
24
+
Store the API key in ``resource.cfg`` so it does not appear in command definitions or process listings:
27
25
28
26
.. code-block::
29
27
30
28
# /etc/nagios/resource.cfg
31
29
$USER20$=<ROBUSTA_API_KEY>
32
30
33
-
Nagios resource macros are intentionally not exposed to the CGIs and can hold secrets. Tighten the file permissions so only the Nagios user can read it, and exclude ``resource.cfg`` from any unprotected backup or config-management bundle:
31
+
Restrict the file to the Nagios user:
34
32
35
33
.. code-block:: bash
36
34
37
35
chown root:nagios /etc/nagios/resource.cfg
38
36
chmod 640 /etc/nagios/resource.cfg
39
37
40
-
Then reference ``$USER20$`` from the notification command:
38
+
Define a notification command that references ``$USER20$``:
41
39
42
40
.. code-block::
43
41
@@ -73,4 +71,4 @@ Add ``robusta`` to the ``contact_groups`` you want to forward.
73
71
Verify
74
72
------
75
73
76
-
Acknowledge a test problem to fire a notification. The event should appear in **Settings → Delivery Log** and on the Robusta timeline.
74
+
Acknowledge a test problem to fire a notification. The alert should appear on the Robusta timeline.
0 commit comments