Skip to content

Commit 6e56877

Browse files
aantnaantn
committed
fixes
1 parent ac04986 commit 6e56877

3 files changed

Lines changed: 43 additions & 104 deletions

File tree

‎docs/how-it-works/usage-faq.rst‎

Lines changed: 6 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,13 @@ Usage FAQ
44

55
Does Robusta have Builtin Alerts?
66
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7-
Yes. Robusta includes built-in alerts based on Prometheus and direct APIServer monitoring.
87

9-
These alerts work out of the box without any configuration.
8+
Yes, you can install all-in-one bundle to install Robusta along with well-tested enriched alerts.
109

11-
You can also :ref:`write your own Prometheus alerts <Create Custom Prometheus Alerts>`.
10+
If you already have alerts, you can skip the bundle and send your existing alerts to Robusta instead. They'll be enriched with extra context.
1211

13-
What Events Can Robusta Listen to?
14-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15-
16-
Robusta listens to:
17-
18-
* Prometheus alerts
19-
* CrashLoopBackOffs
20-
* OOMKills
21-
* Job Failures
22-
* Other APIServer errors
23-
* Updates to Kubernetes Deployments and other resources
24-
25-
See the full list in :ref:`All Triggers <Triggers Reference>`.
26-
27-
Want Robusta to respond to a custom event? Just send your event to Robusta by webhook.
28-
29-
What Actions Can Robusta Take?
30-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31-
32-
Actions typically do one of the following:
33-
34-
* Correlate existing observability data
35-
* Perform high-fidelity data collection (e.g. fetch heap dumps)
36-
* Remediate problems
37-
* Silence false alarms
38-
39-
See the full list in :ref:`All Actions <Actions Reference>`.
40-
41-
For examples, see :ref:`What are Playbooks?`.
42-
43-
Where Can Robusta Send Notifications?
44-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45-
46-
In Robusta, destinations are called *sinks*. Here are some built-in sinks:
47-
48-
* Chat apps: *Slack, MSTeams, Discord, and Telegram*
49-
* Incident management tools: *PagerDuty and OpsGenie*
50-
* Monitoring Platforms: *DataDog and the Robusta SaaS*
12+
Can Robusta monitor alerts from outside Kubernetes?
13+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14+
Robusta OSS is designed for Kubernetes environments and requires both Kubernetes and Prometheus to provide the most value.
5115

52-
See the full list in :ref:`Sinks Reference`.
16+
Robusta Pro extends beyond Kubernetes and can ingest alerts from any monitoring system via webhook, including Nagios, SolarWinds, and custom sources. These alerts get the same AI analysis and correlation features.

‎docs/index.rst‎

Lines changed: 9 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
self
99
how-it-works/architecture
1010
how-it-works/oss-vs-saas
11-
how-it-works/coverage
1211
how-it-works/usage-faq
1312
how-it-works/alert-builtin-enrichment
1413

@@ -77,60 +76,29 @@
7776
Welcome to Robusta
7877
====================
7978

79+
Robusta transforms basic Prometheus alerts into actionable insights with full Kubernetes context, and magical automation.
80+
8081
.. grid:: 1 1 1 2
8182
:margin: 0
8283
:padding: 0
8384
:gutter: 3
8485

8586
.. grid-item::
8687

87-
Robusta OSS enriches Prometheus alerts with Kubernetes context.
88-
89-
When Prometheus alerts fire, Robusta automatically adds pod logs, events, and metrics. Robusta Pro adds web UI, AI analysis, and support for non-Kubernetes monitoring systems.
90-
91-
.. raw:: html
92-
93-
<br>
88+
**How Robusta Improves Alerts:**
9489

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
90+
* **Auto-investigate** - Correlate alerts with logs and events
91+
* **AI analysis** - Root causes and remediation steps
92+
* **Smart routing** - Route based on context
10093
* **Self-healing** - Automatic remediation rules
10194
* **Change tracking** - Correlate alerts with deployments
10295

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).
96+
Connect to your existing Prometheus or install our all-in-one bundle (based on kube-prometheus-stack). Need to go beyond Kubernetes? `Try Robusta Pro <https://home.robusta.dev>`_.
11097

11198
.. grid-item::
11299

113-
.. md-tab-set::
114-
115-
.. md-tab-item:: Alert Enrichment
116-
117-
.. image:: /images/prometheus-alert-with-robusta.png
118-
:width: 800px
119-
120-
.. md-tab-item:: AI Investigation
121-
122-
.. image:: /images/ai-analysis.png
123-
:width: 800px
124-
125-
.. md-tab-item:: Kubernetes Problems
126-
127-
.. image:: /images/oomkillpod.png
128-
:width: 800px
129-
130-
.. md-tab-item:: JIRA Integration
131-
132-
.. image:: /images/jira_example.png
133-
:width: 800px
100+
.. image:: /images/prometheus-alert-with-robusta.png
101+
:width: 400px
134102

135103
Ready to get started?
136104
---------------------

‎docs/notification-routing/index.rst‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,63 +8,70 @@ Robusta can send notifications to various destinations and route them intelligen
88
Key Concepts
99
^^^^^^^^^^^^
1010

11-
**Sinks** - Destinations where notifications are sent (Slack, Teams, Email, etc.)
11+
:doc:`Sinks <../configuration/sinks/index>` - Destinations where notifications are sent (Slack, Teams, Email, etc.)
1212

13-
**Routing** - Rules that determine which alerts go to which sinks
13+
:doc:`Routing <routing-with-scopes>` - Rules that determine which alerts go to which sinks
1414

15-
**Grouping** - Thread alerts together to reduce noise (especially in Slack)
15+
:doc:`Grouping <notification-grouping>` - Thread alerts together to reduce noise (especially in Slack)
1616

17-
**Silencing** - Temporarily disable specific notifications
17+
:doc:`Silencing <routing-silencing>` - Temporarily disable specific notifications
1818

1919
Getting Started
2020
^^^^^^^^^^^^^^^
2121

2222
.. grid:: 1 1 2 2
2323
:gutter: 3
2424

25-
.. grid-item-card:: :octicon:`gear;1em;` Configure Sinks
25+
.. grid-item-card:: Configure Sinks
2626
:class-card: sd-bg-light sd-bg-text-light
2727
:link: configuring-sinks
2828
:link-type: doc
2929

3030
Start here - learn how to set up your first notification destination
3131

32-
.. grid-item-card:: :octicon:`mail;1em;` Popular Sinks
32+
.. grid-item-card:: Popular Sinks
3333
:class-card: sd-bg-light sd-bg-text-light
3434
:link: ../configuration/sinks/slack
3535
:link-type: doc
3636

3737
Slack, Teams, Email - quick setup for common destinations
3838

39-
.. grid-item-card:: :octicon:`workflow;1em;` Smart Routing
39+
.. grid-item-card:: Smart Routing
4040
:class-card: sd-bg-light sd-bg-text-light
4141
:link: routing-with-scopes
4242
:link-type: doc
4343

4444
Send different alerts to different teams automatically
4545

46-
.. grid-item-card:: :octicon:`comment-discussion;1em;` Reduce Noise
46+
.. grid-item-card:: Reduce Noise
4747
:class-card: sd-bg-light sd-bg-text-light
4848
:link: notification-grouping
4949
:link-type: doc
5050

5151
Group related alerts in Slack threads to avoid spam
5252

53-
Common Workflows
54-
^^^^^^^^^^^^^^^^
53+
Popular Sinks
54+
^^^^^^^^^^^^^
5555

56-
**Basic Setup**: Configure a single sink (like Slack) to receive all notifications
56+
.. grid:: 1 1 2 4
57+
:gutter: 2
5758

58-
**Team Routing**: Route alerts to different channels based on namespace or labels
59-
60-
**Noise Reduction**: Enable grouping and silencing for cleaner notifications
59+
.. grid-item-card:: Slack
60+
:class-card: sd-bg-light sd-bg-text-light
61+
:link: ../configuration/sinks/slack
62+
:link-type: doc
6163

62-
**Advanced Routing**: Use scopes and filters for complex routing scenarios
64+
.. grid-item-card:: Teams
65+
:class-card: sd-bg-light sd-bg-text-light
66+
:link: ../configuration/sinks/ms-teams
67+
:link-type: doc
6368

64-
Next Steps
65-
^^^^^^^^^^
69+
.. grid-item-card:: PagerDuty
70+
:class-card: sd-bg-light sd-bg-text-light
71+
:link: ../configuration/sinks/pagerduty
72+
:link-type: doc
6673

67-
1. **Configure Your First Sink** - Start with :doc:`configuring-sinks`
68-
2. **Choose Your Destination** - Browse all available sinks in :doc:`../configuration/sinks/index`
69-
3. **Set Up Routing** - Configure intelligent routing with :doc:`routing-with-scopes`
70-
4. **Reduce Noise** - Enable grouping with :doc:`notification-grouping`
74+
.. grid-item-card:: View All Sinks
75+
:class-card: sd-bg-light sd-bg-text-light
76+
:link: ../configuration/sinks/index
77+
:link-type: doc

0 commit comments

Comments
 (0)