Skip to content

Commit 8fde0e5

Browse files
committed
docs
1 parent 7993d67 commit 8fde0e5

6 files changed

Lines changed: 79 additions & 97 deletions

File tree

Lines changed: 18 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:hide-toc:
22

33

4-
Alert Sources
5-
================================
4+
Prometheus & AlertManager
5+
=========================
66
.. toctree::
77
:hidden:
88
:maxdepth: 1
@@ -16,88 +16,60 @@ Alert Sources
1616
victoria-metrics
1717
grafana-alert-manager
1818
embedded-prometheus
19-
troubleshooting-alertmanager
20-
alert-custom-prometheus
2119

2220

23-
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.
2422

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

29-
If you installed Robusta's :ref:`Embedded Prometheus Stack`, then Prometheus is pre-integrated and no setup is necessary. Otherwise, choose a guide below.
30-
31-
.. _alertmanager-setup-options:
32-
33-
Prometheus & AlertManager Setup
34-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25+
**Choose your setup:**
3526

3627
.. grid:: 1 1 2 3
3728
:gutter: 3
3829

3930

40-
.. grid-item-card:: :octicon:`book;1em;` In-cluster Prometheus
31+
.. grid-item-card:: Prometheus in same cluster
4132
:class-card: sd-bg-light sd-bg-text-light
4233
:link: alert-manager
4334
:link-type: doc
4435

45-
Prometheus, running in the same K8s cluster as Robusta
46-
47-
.. grid-item-card:: :octicon:`book;1em;` Centralized Prometheus
36+
.. grid-item-card:: Prometheus outside cluster
4837
:class-card: sd-bg-light sd-bg-text-light
4938
:link: outofcluster-prometheus
5039
:link-type: doc
5140

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

66-
Amazon Managed Service for Prometheus
67-
68-
.. grid-item-card:: :octicon:`book;1em;` Coralogix
46+
.. grid-item-card:: Azure Managed Prometheus
6947
:class-card: sd-bg-light sd-bg-text-light
70-
:link: coralogix_managed_prometheus
48+
:link: azure-managed-prometheus
7149
:link-type: doc
7250

73-
Coralogix Managed Prometheus
74-
75-
.. grid-item-card:: :octicon:`book;1em;` Google Managed Prometheus
51+
.. grid-item-card:: Google Managed Prometheus
7652
:class-card: sd-bg-light sd-bg-text-light
7753
:link: google-managed-prometheus
7854
:link-type: doc
7955

80-
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
8160

82-
.. grid-item-card:: :octicon:`book;1em;` Victoria Metrics
61+
.. grid-item-card:: VictoriaMetrics
8362
:class-card: sd-bg-light sd-bg-text-light
8463
:link: victoria-metrics
8564
:link-type: doc
8665

87-
VictoriaMetrics, running in the same K8s cluster as Robusta
88-
89-
90-
.. grid-item-card:: :octicon:`book;1em;` Grafana AlertManager
66+
.. grid-item-card:: Grafana Alerts
9167
:class-card: sd-bg-light sd-bg-text-light
9268
:link: grafana-alert-manager
9369
:link-type: doc
9470

95-
Special instructions when using Grafana alerts
96-
97-
.. grid-item-card:: :octicon:`book;1em;` Embedded Prometheus
71+
.. grid-item-card:: Install Prometheus with Robusta
9872
:class-card: sd-bg-light sd-bg-text-light
9973
:link: embedded-prometheus
10074
:link-type: doc
10175

102-
All-in-one package of Robusta + kube-prometheus-stack (optional)
103-

docs/configuration/exporting/custom-webhooks.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Custom Webhooks
22
===============
33

4-
Send alerts to Robusta from any monitoring system that supports HTTP webhooks.
4+
Send alerts from any monitoring system to Robusta via HTTP webhooks.
55

66
.. 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.
7+
This feature requires Robusta Pro (SaaS or self-hosted commercial plans).
88

99
Overview
1010
--------
1111

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.
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.
1313

1414
Webhook Endpoint
1515
----------------

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Robusta Pro Features
44
.. note::
55
These features are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version.
66

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.
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.
88

99
Custom Alert Ingestion
1010
-----------------------
@@ -38,20 +38,20 @@ Features include:
3838
AI Analysis
3939
-----------
4040

41-
Robusta Pro includes advanced AI-powered investigation capabilities to help you understand and resolve alerts faster.
41+
Optional AI-powered alert investigation using HolmesGPT.
4242

43-
:doc:`AI Analysis (Holmes GPT) <../holmesgpt/index>`
44-
Use AI to investigate Kubernetes alerts, analyze logs, and get remediation suggestions automatically.
43+
:doc:`AI Analysis (HolmesGPT) <../holmesgpt/index>`
44+
Automatically analyze Kubernetes alerts, logs, and metrics. Get potential root causes and remediation suggestions.
4545

4646
Additional Pro Features
4747
-----------------------
4848

49-
Beyond the APIs and AI analysis listed above, Robusta Pro includes:
49+
Additional capabilities in Robusta Pro:
5050

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
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
5555

5656
For more details on the differences between open-source and SaaS, see :doc:`Open Source vs SaaS <../../how-it-works/oss-vs-saas>`.
5757

docs/configuration/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
:hide-toc:
22

3-
Alert Sources Overview
4-
==========================
3+
Alert Sources
4+
=============
55

6-
Forward alerts from your monitoring system to Robusta for enrichment and automation.
6+
Connect your monitoring system to Robusta. When alerts fire, Robusta automatically enriches them with context and applies your automation rules.
77

8-
Choose your monitoring system:
8+
**Choose your setup:**
99

1010
.. grid:: 1 1 2 3
1111
:gutter: 3
@@ -15,20 +15,20 @@ Choose your monitoring system:
1515
:link: alertmanager-integration/index
1616
:link-type: doc
1717

18-
**Most popular**. Works with any Prometheus-compatible stack
18+
Standard Prometheus integration. Works with any PromQL-based stack.
1919

2020
.. grid-item-card:: :octicon:`bell;1em;` Nagios
2121
:class-card: sd-bg-light sd-bg-text-light
2222
:link: alertmanager-integration/nagios
2323
:link-type: doc
2424

25-
**Nagios monitoring**. Forward alerts via webhook
25+
Forward Nagios alerts via webhook integration.
2626

2727
.. grid-item-card:: :octicon:`bell;1em;` SolarWinds
2828
:class-card: sd-bg-light sd-bg-text-light
2929
:link: alertmanager-integration/solarwinds
3030
:link-type: doc
3131

32-
**SolarWinds monitoring**. Forward alerts via webhook
32+
Forward SolarWinds alerts via webhook integration.
3333

34-
Don't see your system? Robusta accepts alerts from any system that can send :doc:`HTTP webhooks <exporting/exporting-data>`.
34+
**Other systems?** Robusta accepts alerts from any monitoring system via :doc:`HTTP webhooks <exporting/custom-webhooks>`.

docs/how-it-works/oss-vs-saas.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
Open Source vs SaaS
22
################################
33

4-
There are several ways to use Robusta:
4+
Robusta has three deployment options:
55

6-
- Robusta OSS: Send data to external destinations like Slack. No UI.
7-
- Robusta OSS + `SaaS UI <https://home.robusta.dev/ui/>`_: The full experience.
8-
- Robusta OSS + Self-hosted UI: The on-prem experience.
6+
- **Open Source**: MIT-licensed engine that sends alerts to Slack, Teams, etc. No web UI.
7+
- **SaaS**: Open source engine + hosted web UI with additional features.
8+
- **Self-hosted**: Open source engine + on-premise web UI (enterprise plans).
99

10-
Which option is right for me?
11-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10+
**Which should I choose?**
1211

13-
Most people use Robusta with the SaaS platform enabled. This gives you the full Robusta experience, with all capabilities and minimum hassle.
14-
15-
That said, the choice is yours. You can use the open-source without the SaaS platform, or you can self-host the SaaS platform via our enterprise plans.
12+
Most teams use the SaaS option for the complete feature set without infrastructure overhead. The open source version works well if you only need basic alert routing to external systems.
1613

1714
Pricing
1815
^^^^^^^^^^^^

docs/index.rst

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@
2424
:caption: 🚨 Alert Sources
2525
:hidden:
2626

27-
configuration/index
28-
🔥 Prometheus & AlertManager <configuration/alertmanager-integration/index>
29-
🔔 Nagios <configuration/alertmanager-integration/nagios>
30-
🌐 SolarWinds <configuration/alertmanager-integration/solarwinds>
31-
🔗 Custom Webhooks <configuration/exporting/custom-webhooks>
27+
Overview <configuration/index>
28+
Prometheus & AlertManager <configuration/alertmanager-integration/index>
29+
Nagios <configuration/alertmanager-integration/nagios>
30+
SolarWinds <configuration/alertmanager-integration/solarwinds>
31+
Custom Webhooks <configuration/exporting/custom-webhooks>
3232

3333

3434
.. toctree::
3535
:maxdepth: 4
3636
:caption: 🔔 Notifications & Routing
3737
:hidden:
3838

39-
notification-routing/index
39+
Overview <notification-routing/index>
4040
notification-routing/configuring-sinks
4141
📧 Sink Reference <configuration/sinks/index>
4242
Routing (Scopes) <notification-routing/routing-with-scopes>
@@ -51,6 +51,7 @@
5151
:hidden:
5252

5353
playbook-reference/index
54+
configuration/alertmanager-integration/alert-custom-prometheus
5455
Cost Savings - KRR <configuration/resource-recommender>
5556
K8s Misconfigurations - Popeye <configuration/cluster-misconfigurations>
5657

@@ -62,10 +63,11 @@
6263
configuration/exporting/robusta-pro-features
6364
configuration/holmesgpt/index
6465
configuration/exporting/exporting-data
66+
configuration/alertmanager-integration/troubleshooting-alertmanager
6567

6668
.. toctree::
6769
:maxdepth: 4
68-
:caption: Help
70+
:caption: Help
6971
:hidden:
7072

7173
help
@@ -75,25 +77,36 @@
7577
Welcome to Robusta
7678
====================
7779

78-
.. grid:: 1 1 2 2
80+
.. grid:: 1 1 1 2
7981
:margin: 0
8082
:padding: 0
83+
:gutter: 3
8184

8285
.. grid-item::
8386

84-
Robusta extends Prometheus/VictoriaMetrics/Coralogix (and more) with features like:
87+
Robusta enriches Prometheus alerts with Kubernetes context.
8588

86-
* :doc:`Smart Grouping <notification-routing/notification-grouping>` - reduce notification spam with Slack threads 🧵
87-
* :ref:`AI Investigation <AI Analysis>` - Kickstart your alert investigations with AI (optional)
88-
* :ref:`Alert Enrichment <Automatically Investigate a Prometheus Alert>` - see pods log and other data alongside your alerts
89-
* :ref:`Self-Healing <Automatic Remediation>` - define auto-remediation rules for faster fixes
90-
* :ref:`Advanced Routing <Defining Sinks>` by team, namespace, k8s metadata and more
91-
* :ref:`K8s Problem-Detection <Triggers Reference>` - alert on OOMKills or failing Jobs without PromQL
92-
* :ref:`Change Tracking <Track Kubernetes Changes>` - correlate alerts and Kubernetes rollouts
93-
* :ref:`Auto-Resolve <Jira>` - send alerts, resolve them when updated (e.g. in Jira)
94-
* :ref:`Dozens of Integrations <Integrations Overview>` - Slack, Teams, Jira, and more
89+
When Prometheus alerts fire, Robusta automatically adds pod logs, events, and metrics. Connect to your existing Prometheus setup.
9590

96-
Bring your own Prometheus or install our :ref:`preconfigured bundle <Embedded Prometheus Stack>`.
91+
.. raw:: html
92+
93+
<br>
94+
95+
**What happens when an alert fires:**
96+
97+
* **Auto-investigate** - Logs, events, and metrics attached
98+
* **AI analysis** - Root causes and fixes suggested
99+
* **Smart routing** - Right team, right channel
100+
* **Self-healing** - Automatic remediation rules
101+
* **Change tracking** - Correlate alerts with deployments
102+
103+
.. raw:: html
104+
105+
<br>
106+
107+
**Works with your existing setup**
108+
109+
Connect to your existing Prometheus or install our all-in-one bundle (based on kube-prometheus-stack).
97110

98111
.. grid-item::
99112

@@ -119,10 +132,10 @@ Welcome to Robusta
119132
.. image:: /images/jira_example.png
120133
:width: 800px
121134

122-
Who uses Robusta?
123-
-------------------------------------
135+
Ready to get started?
136+
---------------------
124137

125-
Robusta is used in production by hundreds of teams, from cloud-native pioneers to the Fortune 500.
138+
Join hundreds of teams already running Robusta in production.
126139

127140
.. button-ref:: ../setup-robusta/installation/index
128141
:color: primary

0 commit comments

Comments
 (0)