Skip to content

Commit 3e8d9da

Browse files
aantnclaudepavangudiwada
authored
Update docs (#1874)
* docs: reorganize integrations page to focus on alert forwarding - Remove sinks/destinations from integrations overview - Restructure page to highlight "Forward Alerts to Robusta" - Add dedicated section for Prometheus, Nagios, and SolarWinds - Simplify description to focus on alert forwarding and AI analysis 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: move sinks from Integrations to Notifications & Routing section - Move sinks reference from Integrations nav to Notifications & Routing nav - Place sinks as first item in Notifications & Routing section - Remove sinks from Integrations section to reduce confusion - Keep logical grouping of alert destinations with notification routing 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: fix integration page hierarchy and remove redundancy - Redesign integrations overview to be truly high-level with categories - Rename "Integrating with Prometheus" to "Alert Sources" for broader scope - Remove duplicate content between overview and subpages - Focus overview on integration categories rather than detailed setup - Update navigation labels to match new page structure - Make user journey clearer: overview → specific alert source setup 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: major reorganization - separate Alert Sources, AI Analysis, and Automation - Rename "Integrations" section to "Alert Sources" - much clearer purpose - Create dedicated "AI Analysis" section for Holmes GPT only - Move KRR, Popeye, and data export to "Automation" section - Update Alert Sources overview to focus purely on monitoring integrations - Remove mixed content categories that confused users - Improve logical flow: Alert Sources → AI Analysis → Notifications → Automation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: improve notifications navigation with proper hierarchy - Create new notifications overview page as entry point - Reorder navigation: Overview → Configuring Sinks → Sink Reference - Fix information hierarchy so users start with concepts, not specific sinks - Prevent sphinx menu expansion pushing basic setup pages down - Add clear getting started flow and common workflows - Update sink reference title to match new structure 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: move Nagios and SolarWinds to top-level Alert Sources - Move Nagios and SolarWinds from Prometheus subpages to top-level Alert Sources - Remove confusing navigation hierarchy where non-Prometheus systems appeared under Prometheus - Clean up Prometheus page to focus purely on Prometheus/AlertManager integrations - Remove "Other Alerting Systems" section since they're now top-level - Create clearer navigation: Overview → Prometheus → Nagios → SolarWinds 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: make Alert Sources overview more concise and actionable - Remove verbose explanations and get straight to the point - Lead with clear action: "Choose your monitoring system" - Make card descriptions more direct and useful - Add practical note about webhook compatibility for other systems - Cut word count by ~60% while improving clarity 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: remove negative labels like 'legacy' and 'enterprise' - Change 'Legacy systems' to 'Nagios monitoring' - Change 'Enterprise monitoring' to 'SolarWinds monitoring' - Keep descriptions neutral and product-focused - Avoid terms that might make users feel bad about their tech choices 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add helpful link to webhook documentation for other systems - Link 'HTTP webhooks' to webhook triggers documentation - Provides users with concrete next steps if their system isn't listed - Makes the fallback option actionable rather than just informational 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: fix webhook link to point to correct API documentation - Link HTTP webhooks to exporting-data.rst which contains POST /api/alerts endpoint - This is the correct endpoint for sending alerts from any system via HTTP - Previous link was to webhook triggers which is for different use case 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: move webhook API to Alert Sources section where it belongs - Move exporting-data.rst from Automation to Alert Sources as "Custom Webhooks" - This contains the POST /api/alerts endpoint for sending alerts TO Robusta - Makes it discoverable for users wanting to integrate custom monitoring systems - Logical placement with other alert source integrations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: switch from horizontal tabs to left sidebar navigation - Remove navigation.tabs and navigation.tabs.sticky features - Add navigation.sections and navigation.expand for better sidebar - This provides more room for additional top-level sections - Makes navigation more scalable for future section additions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * switch to sidebar navigation * clarify on pro features * put robusta pro features in the right place * docs * Update index.rst * fixes * Improve documentation content and organization (#1883) * Improve documentation content and organization - Update main page alert features to match README with better descriptions - Revamp architecture page with detailed component explanations and data flow - Add links to Pro Features and pricing in Open Source vs SaaS comparison - Add community tutorial by Naren P on Kubernetes monitoring automation * Updated Robusta signup link --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Pavan Gudiwada <25551553+pavangudiwada@users.noreply.github.com> Co-authored-by: Pavan Gudiwada <pavangudiwada@users.noreply.github.com>
1 parent 1ff3f65 commit 3e8d9da

19 files changed

Lines changed: 352 additions & 249 deletions

docs/community-tutorials.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Here are more tutorials from the Robusta community:
1010
* **Video:** `Twitter challenge - Robusta.dev on 10 nodes <https://www.youtube.com/watch?v=l_zaCaY_wls>`_ by `Nuno Captain Corsair <https://twitter.com/nunixtech>`_
1111
* `Getting Started with Robusta on Digital Ocean <https://dev.to/heyrutam/getting-started-with-robusta-on-digital-ocean-3g41>`_ by `Rutam Prita Mishra <https://github.com/Rutam21>`_
1212
* `Getting Started with Robusta on Civo Cloud <https://dev.to/heyrutam/getting-started-with-robusta-on-civo-cloud-5h8f>`_ by `Rutam Prita Mishra <https://github.com/Rutam21>`_
13-
* `Kubernetes troubleshooting and automation using Robusta <https://xxradar.medium.com/kubernetes-troubleshooting-and-automation-using-robusta-13f113fcdc36>`_ by `Philippe Bogaerts <https://twitter.com/xxradar>`_
13+
* `Kubernetes troubleshooting and automation using Robusta <https://xxradar.medium.com/kubernetes-troubleshooting-and-automation-using-robusta-13f113fcdc36>`_ by `Philippe Bogaerts <https://twitter.com/xxradar>`_
14+
* `Enhancing Kubernetes Monitoring Automation with Robusta <https://naren4b.hashnode.dev/enhancing-kubernetes-monitoring-automation-with-robusta>`_ by `Naren P <https://naren4b.hashnode.dev/>`_

docs/conf.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,13 +273,11 @@
273273
"features": [
274274
"navigation.instant",
275275
"navigation.top",
276-
"navigation.tabs",
277-
"navigation.tabs.sticky",
278276
"search.share",
279277
"toc.follow",
280278
"toc.sticky",
281279
],
282-
"globaltoc_collapse": False,
280+
"globaltoc_collapse": True,
283281
"social": [
284282
{
285283
"icon": "fontawesome/brands/github",
Lines changed: 18 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:hide-toc:
22

33

4-
Integrating with Prometheus
5-
================================
4+
Prometheus & AlertManager
5+
=========================
66
.. toctree::
77
:hidden:
88
:maxdepth: 1
@@ -16,112 +16,60 @@ Integrating with Prometheus
1616
victoria-metrics
1717
grafana-alert-manager
1818
embedded-prometheus
19-
troubleshooting-alertmanager
20-
alert-custom-prometheus
21-
nagios
22-
solarwinds
2319

2420

25-
Robusta works best when integrated with Prometheus and AlertManager. When properly setup, Robusta will:
21+
Connect Robusta to your Prometheus setup to get enriched alerts with logs, events, and metrics.
2622

27-
1. Show your existing Prometheus alerts in Robusta, enriched with extra information
28-
2. Fetch relevant metrics from Prometheus and show them on related alerts
29-
3. Fetch metrics from Prometheus and show them in the Robusta UI (optional, only relevant for UI users)
23+
**Already using Robusta's embedded Prometheus?** No setup needed - skip this page.
3024

31-
If you installed Robusta's :ref:`Embedded Prometheus Stack`, then everything is pre-integrated and not setup is necessary. If not, you will need follow a guide below.
32-
33-
.. _alertmanager-setup-options:
34-
35-
Setup Instructions
36-
^^^^^^^^^^^^^^^^^^
25+
**Choose your setup:**
3726

3827
.. grid:: 1 1 2 3
3928
:gutter: 3
4029

4130

42-
.. grid-item-card:: :octicon:`book;1em;` In-cluster Prometheus
31+
.. grid-item-card:: Prometheus in same cluster
4332
:class-card: sd-bg-light sd-bg-text-light
4433
:link: alert-manager
4534
:link-type: doc
4635

47-
Prometheus, running in the same K8s cluster as Robusta
48-
49-
.. grid-item-card:: :octicon:`book;1em;` Centralized Prometheus
36+
.. grid-item-card:: Prometheus outside cluster
5037
:class-card: sd-bg-light sd-bg-text-light
5138
:link: outofcluster-prometheus
5239
:link-type: doc
5340

54-
Prometheus, Thanos, Mimir, etc, not running in the same K8s cluster as Robusta
55-
56-
.. grid-item-card:: :octicon:`book;1em;` Azure Managed Prometheus
57-
:class-card: sd-bg-light sd-bg-text-light
58-
:link: azure-managed-prometheus
59-
:link-type: doc
60-
61-
Azure Monitor managed service for Prometheus
62-
63-
.. grid-item-card:: :octicon:`book;1em;` AWS Managed Prometheus
41+
.. grid-item-card:: AWS Managed Prometheus
6442
:class-card: sd-bg-light sd-bg-text-light
6543
:link: eks-managed-prometheus
6644
:link-type: doc
6745

68-
Amazon Managed Service for Prometheus
69-
70-
.. grid-item-card:: :octicon:`book;1em;` Coralogix
46+
.. grid-item-card:: Azure Managed Prometheus
7147
:class-card: sd-bg-light sd-bg-text-light
72-
:link: coralogix_managed_prometheus
48+
:link: azure-managed-prometheus
7349
:link-type: doc
7450

75-
Coralogix Managed Prometheus
76-
77-
.. grid-item-card:: :octicon:`book;1em;` Google Managed Prometheus
51+
.. grid-item-card:: Google Managed Prometheus
7852
:class-card: sd-bg-light sd-bg-text-light
7953
:link: google-managed-prometheus
8054
:link-type: doc
8155

82-
Google Managed Prometheus (GMP)
56+
.. grid-item-card:: Coralogix
57+
:class-card: sd-bg-light sd-bg-text-light
58+
:link: coralogix_managed_prometheus
59+
:link-type: doc
8360

84-
.. grid-item-card:: :octicon:`book;1em;` Victoria Metrics
61+
.. grid-item-card:: VictoriaMetrics
8562
:class-card: sd-bg-light sd-bg-text-light
8663
:link: victoria-metrics
8764
:link-type: doc
8865

89-
VictoriaMetrics, running in the same K8s cluster as Robusta
90-
91-
92-
.. grid-item-card:: :octicon:`book;1em;` Grafana AlertManager
66+
.. grid-item-card:: Grafana Alerts
9367
:class-card: sd-bg-light sd-bg-text-light
9468
:link: grafana-alert-manager
9569
:link-type: doc
9670

97-
Special instructions when using Grafana alerts
98-
99-
.. grid-item-card:: :octicon:`book;1em;` Embedded Prometheus
71+
.. grid-item-card:: Install Prometheus with Robusta
10072
:class-card: sd-bg-light sd-bg-text-light
10173
:link: embedded-prometheus
10274
:link-type: doc
10375

104-
All-in-one package of Robusta + kube-prometheus-stack (optional)
105-
106-
107-
Other Alerting Systems
108-
^^^^^^^^^^^^^^^^^^^^^^
109-
110-
Robusta can also receive alerts from non-prometheus monitoring tools like Nagios and SolarWinds:
111-
112-
.. grid:: 1 1 2 3
113-
:gutter: 3
114-
115-
.. grid-item-card:: :octicon:`bell;1em;` Nagios
116-
:class-card: sd-bg-light sd-bg-text-light
117-
:link: nagios
118-
:link-type: doc
119-
120-
Send Nagios alerts to Robusta using a webhook-based integration.
121-
122-
.. grid-item-card:: :octicon:`bell;1em;` SolarWinds
123-
:class-card: sd-bg-light sd-bg-text-light
124-
:link: solarwinds
125-
:link-type: doc
126-
127-
Forward SolarWinds alerts to Robusta via webhook for centralized visibility.

docs/configuration/alertmanager-integration/nagios.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Nagios Integration with Robusta
22
===============================
33

4+
.. 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.
6+
47
This guide explains how to set up Nagios to send alert webhooks to Robusta.
58

69
Requirements

docs/configuration/alertmanager-integration/solarwinds.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
SolarWinds Integration with Robusta
22
===================================
33

4+
.. 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.
6+
47
This guide explains how to configure SolarWinds to send alert webhooks directly to Robusta.
58

69
Requirements
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Custom Webhooks
2+
===============
3+
4+
Send alerts from any monitoring system to Robusta via HTTP webhooks.
5+
6+
.. note::
7+
This feature requires Robusta Pro (SaaS or self-hosted commercial plans).
8+
9+
Overview
10+
--------
11+
12+
Forward alerts from any system that can send HTTP POST requests. Robusta will automatically enrich these alerts with Kubernetes context and apply your automation rules.
13+
14+
Webhook Endpoint
15+
----------------
16+
17+
Send alerts to Robusta using the following endpoint:
18+
19+
.. code-block:: bash
20+
21+
POST https://api.robusta.dev/api/alerts
22+
23+
Authentication
24+
--------------
25+
26+
You'll need your API key and account ID:
27+
28+
1. **Account ID**: Found in your ``generated_values.yaml`` file
29+
2. **API Key**: Generate this in the Robusta platform under **Settings** → **API Keys** → **New API Key**
30+
31+
For detailed API documentation including request format, authentication, and examples, see :doc:`Alert History Import and Export API <exporting-data>`.
32+
33+
Quick Example
34+
-------------
35+
36+
Here's a simple example of sending a custom alert:
37+
38+
.. code-block:: bash
39+
40+
curl --location --request POST 'https://api.robusta.dev/api/alerts' \
41+
--header 'Authorization: Bearer YOUR_API_KEY' \
42+
--header 'Content-Type: application/json' \
43+
--data-raw '{
44+
"account_id": "YOUR_ACCOUNT_ID",
45+
"alerts": [
46+
{
47+
"title": "Test Service Down",
48+
"description": "The Test Service is not responding.",
49+
"source": "monitoring-system",
50+
"priority": "high",
51+
"aggregation_key": "test-service-issues"
52+
}
53+
]
54+
}'
55+
56+
Next Steps
57+
----------
58+
59+
For complete API documentation including all available fields and response formats, see :doc:`Alert History Import and Export API <exporting-data>`.

docs/configuration/exporting/exporting-data.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
Alert History Import and Export API
22
==============================================
33

4-
The Robusta SaaS platform exposes several HTTP APIs:
4+
.. 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.
56

6-
* :ref:`API to export alerts <alert-export-api>`
7-
* :ref:`API to fetch aggregate alert statistics <alert-reporting-api>`
8-
* :ref:`API to send alerts <send-alerts-api>`
9-
* :ref:`API to send configuration changes <send-configuration-changes-api>`
7+
The Robusta SaaS platform exposes several HTTP APIs for exporting data and sending alerts:
8+
9+
* :ref:`API to export alerts <alert-export-api>` - Export historical alert data
10+
* :ref:`API to fetch aggregate alert statistics <alert-reporting-api>` - Get aggregated alert statistics
11+
* :ref:`API to send alerts <send-alerts-api>` - Send custom alerts programmatically
12+
* :ref:`API to send configuration changes <send-configuration-changes-api>` - Track configuration changes
13+
14+
For a simpler webhook integration guide, see :doc:`Custom Webhooks <custom-webhooks>`.
1015

1116
There is an quick-start `Prometheus report-generator <https://github.com/robusta-dev/prometheus-report-generator>`_ on GitHub that demonstrates how to use the export APIs.
1217

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Robusta Pro Features
2+
====================
3+
4+
.. note::
5+
These features are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version.
6+
7+
Robusta Pro adds a web UI, additional integrations, and enterprise APIs to the open-source engine. Available as SaaS (we handle hosting) or self-hosted on-premise.
8+
9+
Custom Alert Ingestion
10+
-----------------------
11+
12+
Send alerts to Robusta from any monitoring system using HTTP webhooks.
13+
14+
:doc:`Custom Webhooks <custom-webhooks>`
15+
Send alerts from any system that supports HTTP webhooks, including custom monitoring solutions.
16+
17+
:doc:`Nagios Integration <../alertmanager-integration/nagios>`
18+
Forward alerts from Nagios to Robusta for enrichment and automation.
19+
20+
:doc:`SolarWinds Integration <../alertmanager-integration/solarwinds>`
21+
Configure SolarWinds to send alert webhooks directly to Robusta.
22+
23+
Data Export and Reporting APIs
24+
-------------------------------
25+
26+
Export alert history and generate reports using Robusta's REST APIs.
27+
28+
:doc:`Alert History Import and Export API <exporting-data>`
29+
Comprehensive API for exporting alert history, generating reports, and sending custom alerts programmatically.
30+
31+
Features include:
32+
33+
* **Alert Export API**: Export historical alert data with filtering by time range, alert name, and account
34+
* **Alert Reporting API**: Get aggregated statistics and counts for different alert types
35+
* **Custom Alert API**: Send alerts programmatically from external systems
36+
* **Configuration Changes API**: Track configuration changes in your environment
37+
38+
AI Analysis
39+
-----------
40+
41+
Optional AI-powered alert investigation using HolmesGPT.
42+
43+
:doc:`AI Analysis (HolmesGPT) <../holmesgpt/index>`
44+
Automatically analyze Kubernetes alerts, logs, and metrics. Get potential root causes and remediation suggestions.
45+
46+
Additional Pro Features
47+
-----------------------
48+
49+
Additional capabilities in Robusta Pro:
50+
51+
* **Web UI**: Manage alerts, playbooks, and configuration through a browser interface
52+
* **Alert Templates**: Create Prometheus alerts without writing PromQL
53+
* **Historical Data**: Query alert history and trends
54+
* **Enterprise Support**: Production support and SLA options
55+
56+
For more details on the differences between open-source and SaaS, see :doc:`Open Source vs SaaS <../../how-it-works/oss-vs-saas>`.
57+
58+
Getting Started
59+
---------------
60+
61+
To access these features:
62+
63+
1. **Robusta SaaS**: `Sign up for free <https://platform.robusta.dev/signup>`_ to get started with the full platform
64+
2. **Self-hosted Commercial**: Contact support@robusta.dev for enterprise plans with self-hosted UI
65+
3. **API Access**: Generate API keys in the Robusta platform under **Settings** → **API Keys**
66+
67+
For detailed API documentation and examples, see :doc:`Alert History Import and Export API <exporting-data>`.

0 commit comments

Comments
 (0)