Skip to content

Commit 7993d67

Browse files
aantnaantn
committed
put robusta pro features in the right place
1 parent 745ed97 commit 7993d67

4 files changed

Lines changed: 151 additions & 22 deletions

File tree

‎docs/configuration/exporting/custom-webhooks.rst‎

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 to Robusta from any monitoring system that supports HTTP webhooks.
5+
6+
.. note::
7+
This feature is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.
8+
9+
Overview
10+
--------
11+
12+
Robusta can receive alerts from any monitoring system that can send HTTP webhooks. This makes it easy to integrate with systems like Nagios, SolarWinds, or custom monitoring solutions.
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

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

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 provides a comprehensive monitoring platform that includes the open-source runner plus a full SaaS UI, advanced integrations, and enterprise APIs. Most users choose Robusta Pro to get the complete Robusta experience with all capabilities and minimal setup.
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+
Robusta Pro includes advanced AI-powered investigation capabilities to help you understand and resolve alerts faster.
42+
43+
:doc:`AI Analysis (Holmes GPT) <../holmesgpt/index>`
44+
Use AI to investigate Kubernetes alerts, analyze logs, and get remediation suggestions automatically.
45+
46+
Additional Pro Features
47+
-----------------------
48+
49+
Beyond the APIs and AI analysis listed above, Robusta Pro includes:
50+
51+
* **Full SaaS UI**: Complete web interface for managing alerts, playbooks, and configuration
52+
* **Managed Prometheus Alerts**: Create and customize Prometheus alerts with templates, without needing to know PromQL
53+
* **Advanced Analytics**: Historical alert data, trends, and reporting dashboards
54+
* **Enterprise Support**: Dedicated support for production deployments
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://home.robusta.dev/ui/>`_ 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>`.

‎docs/index.rst‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1+
:hide-toc:
12

23
.. toctree::
3-
:maxdepth: 4
4-
:caption: Home
4+
:maxdepth: 1
5+
:caption: 📖 Overview
56
:hidden:
67

78
self
8-
9-
.. toctree::
10-
:maxdepth: 4
11-
:caption: How it works
12-
:hidden:
13-
149
how-it-works/architecture
1510
how-it-works/oss-vs-saas
1611
how-it-works/coverage
@@ -33,14 +28,8 @@
3328
🔥 Prometheus & AlertManager <configuration/alertmanager-integration/index>
3429
🔔 Nagios <configuration/alertmanager-integration/nagios>
3530
🌐 SolarWinds <configuration/alertmanager-integration/solarwinds>
36-
🔗 Custom Webhooks <configuration/exporting/exporting-data>
31+
🔗 Custom Webhooks <configuration/exporting/custom-webhooks>
3732

38-
.. toctree::
39-
:maxdepth: 4
40-
:caption: 🤖 AI Analysis
41-
:hidden:
42-
43-
configuration/holmesgpt/index
4433

4534
.. toctree::
4635
:maxdepth: 4
@@ -65,6 +54,15 @@
6554
Cost Savings - KRR <configuration/resource-recommender>
6655
K8s Misconfigurations - Popeye <configuration/cluster-misconfigurations>
6756

57+
.. toctree::
58+
:maxdepth: 4
59+
:caption: 💼 Robusta Pro Features
60+
:hidden:
61+
62+
configuration/exporting/robusta-pro-features
63+
configuration/holmesgpt/index
64+
configuration/exporting/exporting-data
65+
6866
.. toctree::
6967
:maxdepth: 4
7068
:caption: Help
@@ -74,8 +72,8 @@
7472
contributing
7573
community-tutorials
7674

77-
Better Prometheus Alerts (and more) for Kubernetes
78-
=====================================================
75+
Welcome to Robusta
76+
====================
7977

8078
.. grid:: 1 1 2 2
8179
:margin: 0

0 commit comments

Comments
 (0)