Skip to content

Commit 4105732

Browse files
aantnclaude
andauthored
More doc improvements (#1890)
* 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 * Update disable-oomkill-notifications.rst * Update alert-builtin-enrichment.rst * revert changes * small sphinx fixes * unify prometheus terminology * Update alert-custom-prometheus.rst * Update index.rst * Update index.rst --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5124e21 commit 4105732

22 files changed

Lines changed: 75 additions & 88 deletions

docs/configuration/alertmanager-integration/alert-custom-prometheus.rst

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,37 +23,35 @@ Prerequisites
2323
* Kube-Prometheus-Stack, installed via Robusta or seperately.
2424
* Enable global rule selection for the Prometheus operator. Add the following config to your ``generated_values.yaml``. (By default Prometheus Operator picks up only certain new alerts, here we tell it to pick up all new alerts)
2525

26-
.. grid-item::
26+
.. md-tab-set::
2727

28-
.. md-tab-set::
28+
.. md-tab-item:: Robusta Prometheus
2929

30-
.. md-tab-item:: Robusta Prometheus
31-
32-
.. code-block:: yaml
33-
34-
kube-prometheus-stack:
35-
prometheus:
36-
prometheusSpec:
37-
ruleNamespaceSelector: {} # (1)
38-
ruleSelector: {} # (2)
39-
ruleSelectorNilUsesHelmValues: false # (3)
40-
41-
.. code-annotations::
42-
1. Add a namespace if you want Prometheus to identify rules created in specific namespaces. Leave ``{}`` to detect rules from any namespace.
43-
2. Add a label if you want Prometheus to detect rules with a specific selector. Leave ``{}`` to detect rules with any label.
44-
3. When set to `false`, Prometheus detects rules that are created directly, not just rules created using helm values file.
45-
46-
.. md-tab-item:: Other Prometheus
47-
48-
.. code-block:: yaml
30+
.. code-block:: yaml
4931
32+
kube-prometheus-stack:
5033
prometheus:
5134
prometheusSpec:
5235
ruleNamespaceSelector: {} # (1)
5336
ruleSelector: {} # (2)
5437
ruleSelectorNilUsesHelmValues: false # (3)
5538
56-
.. code-annotations::
39+
.. code-annotations::
40+
1. Add a namespace if you want Prometheus to identify rules created in specific namespaces. Leave ``{}`` to detect rules from any namespace.
41+
2. Add a label if you want Prometheus to detect rules with a specific selector. Leave ``{}`` to detect rules with any label.
42+
3. When set to `false`, Prometheus detects rules that are created directly, not just rules created using helm values file.
43+
44+
.. md-tab-item:: Other Prometheus
45+
46+
.. code-block:: yaml
47+
48+
prometheus:
49+
prometheusSpec:
50+
ruleNamespaceSelector: {} # (1)
51+
ruleSelector: {} # (2)
52+
ruleSelectorNilUsesHelmValues: false # (3)
53+
54+
.. code-annotations::
5755
1. Add a namespace if you want Prometheus to identify rules created in specific namespaces. Leave ``{}`` to detect rules from any namespace.
5856
2. Add a label if you want Prometheus to detect rules with a specific selector. Leave ``{}`` to detect rules with any label.
5957
3. When set to `false`, Prometheus detects rules that are created directly, not just rules created using helm values file.

docs/configuration/alertmanager-integration/alert-manager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Here's how to integrate an existing Prometheus with Robusta in the same cluster:
77
* Point Robusta at Prometheus so it can query metrics and silence alerts
88
* Robusta will attempt auto-detection, so this is not always necessary!
99

10-
If your Prometheus is in a different cluster, refer to :ref:`Centralized Prometheus`.
10+
If your Prometheus is in a different cluster, refer to :ref:`External Prometheus`.
1111

1212
Send Alerts to Robusta
1313
============================

docs/configuration/alertmanager-integration/embedded-prometheus.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ Apply the change by performing a :ref:`Helm Upgrade <Simple Upgrade>`.
5454
Troubleshooting
5555
---------------------
5656

57-
Encountering issues with your Prometheus? Follow this guide to resolve some :ref:`common errors <Common Errors>`.
57+
Encountering issues with your Prometheus? Follow this guide to resolve some :doc:`common errors </help>`.
5858

docs/configuration/alertmanager-integration/google-managed-prometheus.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Prerequisites
99
****************
1010
An instance of Google Managed Prometheus with the following components configured:
1111

12-
* Prometheus Frontend (`Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/query#ui-prometheus>`_)
13-
* Node Exporter (`Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/node_exporter>`_)
14-
* Scraping configuration for Kubelet and cAdvisor (`Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/kubelet-cadvisor>`_)
15-
* Kube State Metrics (`Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/kube_state_metrics>`_)
12+
* Prometheus Frontend (`Frontend Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/query#ui-prometheus>`_)
13+
* Node Exporter (`Node Exporter Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/node_exporter>`_)
14+
* Scraping configuration for Kubelet and cAdvisor (`Kubelet/cAdvisor Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/kubelet-cadvisor>`_)
15+
* Kube State Metrics (`Kube State Metrics Instructions <https://cloud.google.com/stackdriver/docs/managed-prometheus/exporters/kube_state_metrics>`_)
1616

1717
Send Alerts to Robusta
1818
********************************************

docs/configuration/alertmanager-integration/index.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,36 +28,36 @@ Connect Robusta to your Prometheus setup to get enriched alerts with logs, event
2828
:gutter: 3
2929

3030

31-
.. grid-item-card:: Prometheus in same cluster
31+
.. grid-item-card:: In-cluster Prometheus
3232
:class-card: sd-bg-light sd-bg-text-light
3333
:link: alert-manager
3434
:link-type: doc
3535

36-
.. grid-item-card:: Prometheus outside cluster
36+
.. grid-item-card:: External Prometheus
3737
:class-card: sd-bg-light sd-bg-text-light
3838
:link: outofcluster-prometheus
3939
:link-type: doc
4040

41-
.. grid-item-card:: AWS Managed Prometheus
42-
:class-card: sd-bg-light sd-bg-text-light
43-
:link: eks-managed-prometheus
44-
:link-type: doc
45-
4641
.. grid-item-card:: Azure Managed Prometheus
4742
:class-card: sd-bg-light sd-bg-text-light
4843
:link: azure-managed-prometheus
4944
:link-type: doc
5045

51-
.. grid-item-card:: Google Managed Prometheus
46+
.. grid-item-card:: AWS Managed Prometheus
5247
:class-card: sd-bg-light sd-bg-text-light
53-
:link: google-managed-prometheus
48+
:link: eks-managed-prometheus
5449
:link-type: doc
5550

5651
.. grid-item-card:: Coralogix
5752
:class-card: sd-bg-light sd-bg-text-light
5853
:link: coralogix_managed_prometheus
5954
:link-type: doc
6055

56+
.. grid-item-card:: Google Managed Prometheus
57+
:class-card: sd-bg-light sd-bg-text-light
58+
:link: google-managed-prometheus
59+
:link-type: doc
60+
6161
.. grid-item-card:: VictoriaMetrics
6262
:class-card: sd-bg-light sd-bg-text-light
6363
:link: victoria-metrics

docs/configuration/alertmanager-integration/nagios.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Ensure Robusta is part of a contact group or explicitly included in your alert d
7474
}
7575
7676
Step 4: Create the Bash Command Script
77-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7878

7979
Save this as `notify-robusta.sh`, ensure it's executable (`chmod +x notify-robusta.sh`), and Nagios can access it.
8080

docs/configuration/alertmanager-integration/outofcluster-prometheus.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Centralized Prometheus
1+
External Prometheus
22
**************************************
33

44
Follow this guide to connect Robusta to a central Prometheus (e.g. Thanos/Mimir), running outside the cluster monitored by Robusta.
@@ -50,7 +50,7 @@ This integration lets your central Prometheus send alerts to Robusta, as if they
5050
Filtering Prometheus Queries by Cluster
5151
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5252

53-
If the same centralized Prometheus is used for many clusters, you will want to add a cluster name to all queries.
53+
If the same external Prometheus is used for many clusters, you will want to add a cluster name to all queries.
5454

5555
You can do so with the ``prometheus_url_query_string`` parameter, shown below:
5656

docs/configuration/holmesgpt/custom_toolsets.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@ First `create a GitHub Personal Access Token with fine-grained permissions <http
281281
type: "string"
282282
description: "Name of the repository."
283283
required: true
284+
284285
To test, run:
285286

286287
.. code-block:: bash

docs/configuration/holmesgpt/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AI Analysis
1515
Why use HolmesGPT?
1616
^^^^^^^^^^^^^^^^^^^
1717

18-
Robusta can integrate with `Holmes GPT <https://github.com/robusta-dev/holmesgpt>`_ to analyze health issues on your cluster, and to run AI based root cause analysis for alerts.
18+
Robusta integrates with `HolmesGPT <https://github.com/robusta-dev/holmesgpt>`_ to provide AI-powered root cause analysis for your alerts. It automatically investigates issues by analyzing logs, metrics, and Kubernetes state.
1919

2020
This requires a Robusta SaaS account, and for the Robusta UI sink to be enabled. (We have plans to support HolmesGPT in a pure OSS mode in the near future. Stay tuned!)
2121

docs/configuration/holmesgpt/toolsets/opensearch_logs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _toolset_opensearch_logs:
22

33
OpenSearch logs
4-
==============
4+
===============
55

66
By enabling this toolset, HolmesGPT will fetch pod logs from `OpenSearch <https://opensearch.org/>`_.
77

0 commit comments

Comments
 (0)