Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
96a440d
docs: reorganize integrations page to focus on alert forwarding
aantn Jul 15, 2025
e6945b4
docs: move sinks from Integrations to Notifications & Routing section
aantn Jul 15, 2025
1a00d80
docs: fix integration page hierarchy and remove redundancy
aantn Jul 15, 2025
6453e54
docs: major reorganization - separate Alert Sources, AI Analysis, and…
aantn Jul 15, 2025
d26f620
docs: improve notifications navigation with proper hierarchy
aantn Jul 15, 2025
2db9341
docs: move Nagios and SolarWinds to top-level Alert Sources
aantn Jul 15, 2025
7909e2d
docs: make Alert Sources overview more concise and actionable
aantn Jul 15, 2025
70ace66
docs: remove negative labels like 'legacy' and 'enterprise'
aantn Jul 15, 2025
8f447cd
docs: add helpful link to webhook documentation for other systems
aantn Jul 15, 2025
a431002
docs: fix webhook link to point to correct API documentation
aantn Jul 15, 2025
a8178f7
docs: move webhook API to Alert Sources section where it belongs
aantn Jul 15, 2025
a1cfef6
docs: switch from horizontal tabs to left sidebar navigation
aantn Jul 15, 2025
2fdd287
switch to sidebar navigation
aantn Jul 15, 2025
745ed97
clarify on pro features
aantn Jul 15, 2025
7993d67
put robusta pro features in the right place
aantn Jul 15, 2025
8fde0e5
docs
aantn Jul 21, 2025
ac04986
Update index.rst
aantn Jul 21, 2025
6e56877
fixes
aantn Jul 21, 2025
f4a96e1
Improve documentation content and organization (#1883)
pavangudiwada Jul 29, 2025
042370e
Merge branch 'master' into update-integrations-page
aantn Jul 30, 2025
9510c8a
Updated Robusta signup link
pavangudiwada Jul 30, 2025
5cb7041
Merge branch 'master' into update-integrations-page
pavangudiwada Jul 30, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/community-tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Here are more tutorials from the Robusta community:
* **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>`_
* `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>`_
* `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>`_
* `Kubernetes troubleshooting and automation using Robusta <https://xxradar.medium.com/kubernetes-troubleshooting-and-automation-using-robusta-13f113fcdc36>`_ by `Philippe Bogaerts <https://twitter.com/xxradar>`_
* `Kubernetes troubleshooting and automation using Robusta <https://xxradar.medium.com/kubernetes-troubleshooting-and-automation-using-robusta-13f113fcdc36>`_ by `Philippe Bogaerts <https://twitter.com/xxradar>`_
* `Enhancing Kubernetes Monitoring Automation with Robusta <https://naren4b.hashnode.dev/enhancing-kubernetes-monitoring-automation-with-robusta>`_ by `Naren P <https://naren4b.hashnode.dev/>`_
4 changes: 1 addition & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,11 @@
"features": [
"navigation.instant",
"navigation.top",
"navigation.tabs",
"navigation.tabs.sticky",
"search.share",
"toc.follow",
"toc.sticky",
],
"globaltoc_collapse": False,
"globaltoc_collapse": True,
"social": [
{
"icon": "fontawesome/brands/github",
Expand Down
88 changes: 18 additions & 70 deletions docs/configuration/alertmanager-integration/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
:hide-toc:


Integrating with Prometheus
================================
Prometheus & AlertManager
=========================
.. toctree::
:hidden:
:maxdepth: 1
Expand All @@ -16,112 +16,60 @@ Integrating with Prometheus
victoria-metrics
grafana-alert-manager
embedded-prometheus
troubleshooting-alertmanager
alert-custom-prometheus
nagios
solarwinds


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

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

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.

.. _alertmanager-setup-options:

Setup Instructions
^^^^^^^^^^^^^^^^^^
**Choose your setup:**

.. grid:: 1 1 2 3
:gutter: 3


.. grid-item-card:: :octicon:`book;1em;` In-cluster Prometheus
.. grid-item-card:: Prometheus in same cluster
:class-card: sd-bg-light sd-bg-text-light
:link: alert-manager
:link-type: doc

Prometheus, running in the same K8s cluster as Robusta

.. grid-item-card:: :octicon:`book;1em;` Centralized Prometheus
.. grid-item-card:: Prometheus outside cluster
:class-card: sd-bg-light sd-bg-text-light
:link: outofcluster-prometheus
:link-type: doc

Prometheus, Thanos, Mimir, etc, not running in the same K8s cluster as Robusta

.. grid-item-card:: :octicon:`book;1em;` Azure Managed Prometheus
:class-card: sd-bg-light sd-bg-text-light
:link: azure-managed-prometheus
:link-type: doc

Azure Monitor managed service for Prometheus

.. grid-item-card:: :octicon:`book;1em;` AWS Managed Prometheus
.. grid-item-card:: AWS Managed Prometheus
:class-card: sd-bg-light sd-bg-text-light
:link: eks-managed-prometheus
:link-type: doc

Amazon Managed Service for Prometheus

.. grid-item-card:: :octicon:`book;1em;` Coralogix
.. grid-item-card:: Azure Managed Prometheus
:class-card: sd-bg-light sd-bg-text-light
:link: coralogix_managed_prometheus
:link: azure-managed-prometheus
:link-type: doc

Coralogix Managed Prometheus

.. grid-item-card:: :octicon:`book;1em;` Google Managed Prometheus
.. grid-item-card:: Google Managed Prometheus
:class-card: sd-bg-light sd-bg-text-light
:link: google-managed-prometheus
:link-type: doc

Google Managed Prometheus (GMP)
.. grid-item-card:: Coralogix
:class-card: sd-bg-light sd-bg-text-light
:link: coralogix_managed_prometheus
:link-type: doc

.. grid-item-card:: :octicon:`book;1em;` Victoria Metrics
.. grid-item-card:: VictoriaMetrics
:class-card: sd-bg-light sd-bg-text-light
:link: victoria-metrics
:link-type: doc

VictoriaMetrics, running in the same K8s cluster as Robusta


.. grid-item-card:: :octicon:`book;1em;` Grafana AlertManager
.. grid-item-card:: Grafana Alerts
:class-card: sd-bg-light sd-bg-text-light
:link: grafana-alert-manager
:link-type: doc

Special instructions when using Grafana alerts

.. grid-item-card:: :octicon:`book;1em;` Embedded Prometheus
.. grid-item-card:: Install Prometheus with Robusta
:class-card: sd-bg-light sd-bg-text-light
:link: embedded-prometheus
:link-type: doc

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


Other Alerting Systems
^^^^^^^^^^^^^^^^^^^^^^

Robusta can also receive alerts from non-prometheus monitoring tools like Nagios and SolarWinds:

.. grid:: 1 1 2 3
:gutter: 3

.. grid-item-card:: :octicon:`bell;1em;` Nagios
:class-card: sd-bg-light sd-bg-text-light
:link: nagios
:link-type: doc

Send Nagios alerts to Robusta using a webhook-based integration.

.. grid-item-card:: :octicon:`bell;1em;` SolarWinds
:class-card: sd-bg-light sd-bg-text-light
:link: solarwinds
:link-type: doc

Forward SolarWinds alerts to Robusta via webhook for centralized visibility.
3 changes: 3 additions & 0 deletions docs/configuration/alertmanager-integration/nagios.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Nagios Integration with Robusta
===============================

.. note::
This feature is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.

This guide explains how to set up Nagios to send alert webhooks to Robusta.

Requirements
Expand Down
3 changes: 3 additions & 0 deletions docs/configuration/alertmanager-integration/solarwinds.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
SolarWinds Integration with Robusta
===================================

.. note::
This feature is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.

This guide explains how to configure SolarWinds to send alert webhooks directly to Robusta.

Requirements
Expand Down
59 changes: 59 additions & 0 deletions docs/configuration/exporting/custom-webhooks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Custom Webhooks
===============

Send alerts from any monitoring system to Robusta via HTTP webhooks.

.. note::
This feature requires Robusta Pro (SaaS or self-hosted commercial plans).

Overview
--------

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.

Webhook Endpoint
----------------

Send alerts to Robusta using the following endpoint:

.. code-block:: bash

POST https://api.robusta.dev/api/alerts

Authentication
--------------

You'll need your API key and account ID:

1. **Account ID**: Found in your ``generated_values.yaml`` file
2. **API Key**: Generate this in the Robusta platform under **Settings** → **API Keys** → **New API Key**

For detailed API documentation including request format, authentication, and examples, see :doc:`Alert History Import and Export API <exporting-data>`.

Quick Example
-------------

Here's a simple example of sending a custom alert:

.. code-block:: bash
Comment thread
pavangudiwada marked this conversation as resolved.

curl --location --request POST 'https://api.robusta.dev/api/alerts' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"account_id": "YOUR_ACCOUNT_ID",
"alerts": [
{
"title": "Test Service Down",
"description": "The Test Service is not responding.",
"source": "monitoring-system",
"priority": "high",
"aggregation_key": "test-service-issues"
}
]
}'
Comment thread
pavangudiwada marked this conversation as resolved.

Next Steps
----------

For complete API documentation including all available fields and response formats, see :doc:`Alert History Import and Export API <exporting-data>`.
15 changes: 10 additions & 5 deletions docs/configuration/exporting/exporting-data.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
Alert History Import and Export API
==============================================

The Robusta SaaS platform exposes several HTTP APIs:
.. note::
This feature is available with the Robusta SaaS platform and self-hosted commercial plans. It is not available in the open-source version.

* :ref:`API to export alerts <alert-export-api>`
* :ref:`API to fetch aggregate alert statistics <alert-reporting-api>`
* :ref:`API to send alerts <send-alerts-api>`
* :ref:`API to send configuration changes <send-configuration-changes-api>`
The Robusta SaaS platform exposes several HTTP APIs for exporting data and sending alerts:

* :ref:`API to export alerts <alert-export-api>` - Export historical alert data
* :ref:`API to fetch aggregate alert statistics <alert-reporting-api>` - Get aggregated alert statistics
* :ref:`API to send alerts <send-alerts-api>` - Send custom alerts programmatically
* :ref:`API to send configuration changes <send-configuration-changes-api>` - Track configuration changes

For a simpler webhook integration guide, see :doc:`Custom Webhooks <custom-webhooks>`.

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.

Expand Down
67 changes: 67 additions & 0 deletions docs/configuration/exporting/robusta-pro-features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Robusta Pro Features
====================

.. note::
These features are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version.

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.

Custom Alert Ingestion
-----------------------

Send alerts to Robusta from any monitoring system using HTTP webhooks.

:doc:`Custom Webhooks <custom-webhooks>`
Send alerts from any system that supports HTTP webhooks, including custom monitoring solutions.

:doc:`Nagios Integration <../alertmanager-integration/nagios>`
Forward alerts from Nagios to Robusta for enrichment and automation.

:doc:`SolarWinds Integration <../alertmanager-integration/solarwinds>`
Configure SolarWinds to send alert webhooks directly to Robusta.

Data Export and Reporting APIs
-------------------------------

Export alert history and generate reports using Robusta's REST APIs.

:doc:`Alert History Import and Export API <exporting-data>`
Comprehensive API for exporting alert history, generating reports, and sending custom alerts programmatically.

Features include:

* **Alert Export API**: Export historical alert data with filtering by time range, alert name, and account
* **Alert Reporting API**: Get aggregated statistics and counts for different alert types
* **Custom Alert API**: Send alerts programmatically from external systems
* **Configuration Changes API**: Track configuration changes in your environment

AI Analysis
-----------

Optional AI-powered alert investigation using HolmesGPT.

:doc:`AI Analysis (HolmesGPT) <../holmesgpt/index>`
Automatically analyze Kubernetes alerts, logs, and metrics. Get potential root causes and remediation suggestions.

Additional Pro Features
-----------------------

Additional capabilities in Robusta Pro:

* **Web UI**: Manage alerts, playbooks, and configuration through a browser interface
* **Alert Templates**: Create Prometheus alerts without writing PromQL
* **Historical Data**: Query alert history and trends
* **Enterprise Support**: Production support and SLA options

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

Getting Started
---------------

To access these features:

1. **Robusta SaaS**: `Sign up for free <https://platform.robusta.dev/signup>`_ to get started with the full platform
2. **Self-hosted Commercial**: Contact support@robusta.dev for enterprise plans with self-hosted UI
3. **API Access**: Generate API keys in the Robusta platform under **Settings** → **API Keys**

For detailed API documentation and examples, see :doc:`Alert History Import and Export API <exporting-data>`.
Loading