Skip to content

Commit 04282fa

Browse files
authored
Docs for sending grafana alerts to the timeline (#1871)
* Docs for sending grafana alerts to the timeline * CR comments
1 parent 603f252 commit 04282fa

7 files changed

Lines changed: 84 additions & 8 deletions

File tree

docs/configuration/alertmanager-integration/grafana-alert-manager.rst

Lines changed: 84 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,101 @@
11
Grafana AlertManager
22
****************************************
33

4-
Grafana can send alerts to Robusta for automatic enrichment and visualization.
4+
Grafana can send alerts to the Robusta timeline for visualization and AI investigation.
55

66
.. image:: /images/grafana-docs-robusta-ui.png
77
:width: 600
88
:align: center
99

1010

11-
This guide only covers integrating alerts from Grafana Alerting with Robusta, not configuring Robusta to query metrics from the relevant Grafana data source.
11+
This guide only covers sending alerts from Grafana Alerting to the Robusta timeline.
12+
If you'd like Robusta to also query metrics from Grafana, refer to general :ref:`metrics-integration docs for Prometheus <Integrating with Prometheus>`.
1213

13-
After completing this tutorial, we recommend configuring a metrics integration according to the :ref:`standard instructions for your metrics backend <Integrating with Prometheus>`
1414

15-
Prerequisite
15+
Send Alerts to Robusta's Timeline
16+
===========================================
17+
18+
This integration lets you send Grafana alerts to Robusta's Timeline. To configure it:
19+
20+
1. Get your Robusta ``account_id`` from your ``generated_values.yaml`` file. It appears under the ``globalConfig`` section.
21+
22+
2. Create an ``api key``
23+
24+
In the Robusta UI, navigate to the ``settings`` page, and select the ``API Keys`` tab.
25+
26+
.. image:: /images/robusta-api-keys.png
27+
:width: 600
28+
:align: center
29+
30+
31+
Click ``New API Key``. Select a name for your key, and check the ``Alerts Write`` capability.
32+
Generate and save your new ``API Key``
33+
34+
.. image:: /images/new-api-key.png
35+
:width: 600
36+
:align: center
37+
38+
39+
3. In the Grafana UI, navigate to the ``Alerting`` tab, click on ``Manage Contact Points``, and then ``Create contact point``.
40+
41+
Select ``Webhook`` from the Integration options.
42+
Add the following URL. Add your ``account_id`` to it:
43+
44+
.. code-block::
45+
46+
https://api.robusta.dev/integrations/alerts/grafana?account_id=YOUR_ACCOUNT_ID
47+
48+
.. image:: /images/robusta-contact-point-1.png
49+
:width: 600
50+
:align: center
51+
52+
On the ``Optional Webhook settings`` add your ``API Key`` in the ``Bearer Token`` field:
53+
54+
.. image:: /images/robusta-contact-point-2.png
55+
:width: 600
56+
:align: center
57+
58+
Lastly, on the ``Notification settings``, check the ``Send resolved`` checkbox:
59+
60+
.. image:: /images/grafana-send-resolved.png
61+
:width: 600
62+
:align: center
63+
64+
Click the ``Test`` button. If successful, you will receive a notification in the Robusta UI under the ``external`` cluster.
65+
66+
Save your new ``Contact Point``
67+
68+
4. Create a new ``Notification Policy``. Navigate to ``Alerting`` tab, and click ``Manage notification policies``
69+
Create a new policy.
70+
71+
Add a policy without matchers, that handles all alerts. Disable grouping, by specifying ``Group By = ...``
72+
73+
.. image:: /images/robusta-new-notification-policy.png
74+
:width: 600
75+
:align: center
76+
77+
78+
Save your new ``Notification Policy``
79+
80+
81+
That's it!
82+
83+
You can now see your Grafana alerts in the Robusta Timeline, and use AI to analyze it.
84+
85+
86+
Kubernetes Alerts
1687
=================================
17-
* A label in the following format ``cluster_name: YourClusterName`` added to each alert, with the cluster name as it appears in Robusta ``generated_values.yaml``.
88+
In case your alerts are from a Kubernetes cluster monitored by Robusta, and your alerts has a ``cluster`` label, make sure it matches the ``cluster_name`` that appears in Robusta ``generated_values.yaml``.
89+
90+
** This is optional - you can send any alert to the Robusta timeline! **
91+
92+
93+
Send Alerts to Robusta for enrichments
94+
===================================================================
1895

19-
Send Alerts to Robusta
20-
============================
96+
You can use Robusta to enrich alerts with extra context, and to route it to other systems as well.
2197

22-
This integration lets you send Grafana alerts to Robusta.
98+
If you'd like to do that, this integration is for you.
2399

24100
To configure it:
25101

12.4 KB
Loading

docs/images/new-api-key.png

38.6 KB
Loading

docs/images/robusta-api-keys.png

51.8 KB
Loading
36.4 KB
Loading
67.3 KB
Loading
45.7 KB
Loading

0 commit comments

Comments
 (0)