Skip to content

Commit 732273a

Browse files
authored
tweaks (#1905)
1 parent a7adc1c commit 732273a

6 files changed

Lines changed: 104 additions & 138 deletions

File tree

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,9 @@
199199
"developer-guide/platform/docs-contributions.html": "/master/docs-contributions.html#improving-these-docs",
200200
"developer-guide/platform/sinks-guide.html": "/master/configuration/sinks/sinks-development.html",
201201
"user-guide/robusta-cli.html": "/master/setup-robusta/installation/index.html",
202-
"advanced/index.html": "/master/setup-robusta/installation/index.html"
202+
"advanced/index.html": "/master/setup-robusta/installation/index.html",
203+
"configuration/exporting/exporting-data.html": "/master/configuration/exporting/send-alerts-api.html",
204+
"configuration/alertmanager-integration/troubleshooting-alertmanager.html": "/master/configuration/exporting/send-alerts-api.html"
203205
}
204206

205207

docs/configuration/alertmanager-integration/troubleshooting-alertmanager.rst

Lines changed: 0 additions & 89 deletions
This file was deleted.

docs/configuration/exporting/exporting-data.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/configuration/exporting/robusta-pro-features.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ Data Export and Reporting APIs
3333

3434
Export alert history and generate reports using Robusta's REST APIs.
3535

36-
:doc:`Alert History Import and Export API <exporting-data>`
37-
Comprehensive API for exporting alert history, generating reports, and sending custom alerts programmatically.
36+
**Robusta API Reference**
37+
Comprehensive APIs for exporting alert history, generating reports, and sending custom alerts programmatically.
3838

3939
Features include:
4040

4141
* :doc:`Alert Export API <alert-export-api>`: Export historical alert data with filtering by time range, alert name, and account
4242
* :doc:`Alert Reporting API <alert-statistics-api>`: Get aggregated statistics and counts for different alert types
43-
* :doc:`Custom Alert API <send-alerts-api>`: Send alerts programmatically from external systems
43+
* :doc:`Send Alerts API <send-alerts-api>`: Send alerts programmatically from external systems or via integrations
4444
* :doc:`Configuration Changes API <configuration-changes-api>`: Track configuration changes in your environment
4545

4646
Additional Pro Features
@@ -64,4 +64,4 @@ To access these features:
6464
2. **Self-hosted Commercial**: Contact support@robusta.dev for enterprise plans with self-hosted UI
6565
3. **API Access**: Generate API keys in the Robusta platform under **Settings** → **API Keys**
6666

67-
For detailed API documentation and examples, see :doc:`Alert History Import and Export API <exporting-data>`.
67+
For detailed API documentation and examples, see the individual API references listed above.

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

Lines changed: 92 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,44 @@
11
Send Alerts API
2-
==============================================
2+
===============
3+
4+
Why Send Your Alerts to Robusta?
5+
---------------------------------
6+
7+
Benefits include:
8+
9+
* Persistent alert history on a filterable timeline
10+
* Centralized view of alerts from all your monitoring systems (multiple Prometheus instances, cloud services, custom tools)
11+
* AI investigation of alerts
12+
* Correlations between alerts and Kubernetes deploys
13+
* and more!
14+
15+
.. image:: /images/robusta-ui-timeline.png
16+
:alt: Prometheus Alert History
17+
18+
Integration Methods
19+
-------------------
20+
21+
There are two main ways to send alerts to Robusta:
22+
23+
1. **Pre-built Integrations**: Use our existing integrations for AlertManager, Nagios, SolarWinds, and other monitoring systems. See :doc:`Alert Sources <../index>`.
24+
25+
2. **Programmatic API**: Send alerts directly using our REST API (detailed below).
26+
27+
Send Alerts API
28+
---------------
329

430
.. note::
5-
This feature is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.
31+
This API is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.
632

733
Use this endpoint to send alert data to Robusta. You can send up to 1000 alerts in a single request.
834

935
.. _send-alerts-api:
1036

1137
POST https://api.robusta.dev/api/alerts
12-
----------------------------------------------------
38+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1339

1440
Request Body Schema
15-
^^^^^^^^^^^^^^^^^^^^^^^^
41+
""""""""""""""""""""
1642

1743
The request body must include the following fields:
1844

@@ -34,7 +60,7 @@ The request body must include the following fields:
3460
- Yes
3561

3662
Alert Schema
37-
^^^^^^^^^^^^
63+
""""""""""""
3864

3965
Each alert in the ``alerts`` list must follow the specific schema, which includes the following fields:
4066

@@ -116,7 +142,7 @@ Each alert in the ``alerts`` list must follow the specific schema, which include
116142
- No
117143

118144
Example Request
119-
^^^^^^^^^^^^^^^
145+
"""""""""""""""
120146

121147
Here is an example of a ``POST`` request to send a list of alerts:
122148

@@ -155,7 +181,7 @@ In this request, replace the following placeholders:
155181
- ``API-KEY``: Your API Key for authentication. You can generate this token by navigating to **Settings** -> **API Keys** -> **New API Key**.
156182

157183
Request Headers
158-
^^^^^^^^^^^^^^^^^^^^
184+
"""""""""""""""
159185

160186
.. list-table::
161187
:widths: 30 70
@@ -169,10 +195,10 @@ Request Headers
169195
- Must be set to ``application/json``.
170196

171197
Response Format
172-
^^^^^^^^^^^^^^^^^^^^
198+
"""""""""""""""
173199

174200
Success Response
175-
""""""""""""""""
201+
~~~~~~~~~~~~~~~~
176202

177203
If the request is successful, the API will return the following response:
178204

@@ -185,7 +211,7 @@ If the request is successful, the API will return the following response:
185211
- **Status Code**: `200 OK`
186212

187213
Error Response
188-
""""""""""""""
214+
~~~~~~~~~~~~~~
189215

190216
If there is an error in processing the request, the API will return the following format:
191217

@@ -196,4 +222,59 @@ If there is an error in processing the request, the API will return the followin
196222
"error_code": 123
197223
}
198224
199-
- **Status Code**: Varies based on the error (e.g., `400 Bad Request`, `500 Internal Server Error`).
225+
- **Status Code**: Varies based on the error (e.g., `400 Bad Request`, `500 Internal Server Error`).
226+
227+
Troubleshooting
228+
---------------
229+
230+
.. tab-set::
231+
232+
.. tab-item:: General Issues
233+
234+
**Not receiving alerts in Robusta UI?**
235+
236+
1. **Just installed?** Wait 10 minutes after installation for all components to initialize
237+
2. **Check your specific integration:** Each alert source has its own troubleshooting guide on its documentation page
238+
3. **Verify authentication:** Ensure API keys and webhook URLs are correctly configured
239+
240+
.. tab-item:: AlertManager
241+
242+
**Not receiving alerts?**
243+
244+
1. **Verify routing configuration:**
245+
246+
- Ensure Robusta is the first receiver in your AlertManager configuration, or
247+
- All previous receivers have ``continue: true`` set
248+
- See configuration examples in your specific alert source documentation
249+
250+
2. **Check logs for errors:**
251+
252+
- Review AlertManager logs for webhook errors
253+
- Check Prometheus Operator logs (if using kube-prometheus-stack)
254+
- Look for errors in Robusta runner logs
255+
256+
3. **Check pod health (embedded Prometheus stack):**
257+
258+
- Verify all Prometheus and AlertManager pods are running
259+
- Look for OOMKills and increase memory limits if needed
260+
- See :doc:`Embedded Prometheus troubleshooting <../alertmanager-integration/embedded-prometheus>`
261+
262+
**Alerts arriving but missing Kubernetes context?**
263+
264+
Check :doc:`Alert Label Mapping </setup-robusta/additional-settings>` to customize how Prometheus labels map to Kubernetes resources.
265+
266+
Testing Your Integration
267+
------------------------
268+
269+
Each alert source has specific testing methods:
270+
271+
* **Standard AlertManager**: Use ``robusta demo-alert`` command
272+
* **Cloud Services**: Check the specific service's documentation for test procedures
273+
* **Custom API**: Use the curl example above with test data
274+
275+
Refer to your specific integration documentation for detailed testing steps.
276+
277+
Need More Help?
278+
---------------
279+
280+
* Join our `Slack community <https://bit.ly/robusta-slack>`_ for direct support

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,11 @@
8383

8484
configuration/exporting/robusta-pro-features
8585
setup-robusta/alertsui
86-
configuration/exporting/exporting-data
87-
configuration/alertmanager-integration/troubleshooting-alertmanager
86+
configuration/exporting/send-alerts-api
87+
configuration/exporting/configuration-changes-api
88+
configuration/exporting/alert-export-api
89+
configuration/exporting/alert-statistics-api
90+
configuration/exporting/namespace-resources-api
8891

8992
.. toctree::
9093
:maxdepth: 4

0 commit comments

Comments
 (0)