Skip to content
Merged
16 changes: 16 additions & 0 deletions docs/_ext/region_box.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
from html import escape

from docutils import nodes
from docutils.parsers.rst import directives
from sphinx.util import parselinenos
from sphinx.util.docutils import SphinxDirective


Expand Down Expand Up @@ -68,6 +70,9 @@ class RobustaCodeDirective(SphinxDirective):
required_arguments = 0
optional_arguments = 1
final_argument_whitespace = False
option_spec = {
"emphasize-lines": directives.unchanged_required,
}

def run(self):
language = self.arguments[0] if self.arguments else "text"
Expand All @@ -83,6 +88,17 @@ def run(self):
container = nodes.container(classes=["robusta-region-box", "robusta-region-box--code"])
literal = nodes.literal_block(code, code)
literal["language"] = language

emphasize_spec = self.options.get("emphasize-lines")
if emphasize_spec:
try:
nlines = len(code.split("\n"))
hl_lines = [x + 1 for x in parselinenos(emphasize_spec, nlines) if 0 <= x < nlines]
except ValueError:
hl_lines = []
if hl_lines:
literal["highlight_args"] = {"hl_lines": hl_lines}

container += literal
return [container]

Expand Down
2 changes: 2 additions & 0 deletions docs/configuration/alertmanager-integration/launchdarkly.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. include:: ../_legacy_banner.rst

LaunchDarkly Integration with Robusta
=====================================

Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/DataDog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
DataDog
##########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your cluster to the Datadog events API.

Example Output:
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/Opsgenie.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Opsgenie
##########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to the OpsGenie alerts API.

To configure OpsGenie, We need an OpsGenie API key. It can be configured using the OpsGenie team integration.
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/PagerDuty.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
PagerDuty
##########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can send three types of data to `PagerDuty <https://www.pagerduty.com/>`_:

* `Change Events <https://support.pagerduty.com/docs/change-events>`_ - for example, when Deployments are updated
Expand Down
24 changes: 11 additions & 13 deletions docs/configuration/sinks/RobustaUI.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
Robusta UI
#################

Take your Kubernetes monitoring to the next level with a Robusta UI integration:
The Robusta UI sink connects your Robusta installation to the Robusta SaaS platform, where you can investigate alerts with HolmesGPT, review timelines, and more.

- **AI Assistant**: Solve alerts faster with an AI assistant that highlights relevant observability data
- **Alert Timeline**: View Prometheus alerts across multiple clusters and spot correlations with a powerful timeline view
- **Change Tracking**: Correlate alerts with changes to your infrastructure or applications, with Robusta’s automatic change tracking for Kubernetes

.. raw:: html

<div style="text-align: center;">
<a href="https://www.loom.com/share/89c7e098d9494d79895738e0b06091f0" target="_blank" rel="noopener noreferrer">
<img src="https://cdn.loom.com/sessions/thumbnails/89c7e098d9494d79895738e0b06091f0-f508768968f50b46-full-play.gif">
</a>
</div>
For the full list of platform features, see `home.robusta.dev <https://home.robusta.dev>`_.


Configuring the Robusta UI Sink
Expand Down Expand Up @@ -45,6 +35,10 @@ Perform a :ref:`Helm Upgrade <Simple Upgrade>`.
Handling Short-Lived Clusters in the UI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. note::

This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT.

By default, inactive Robusta clusters will be kept in the UI for 6 months **data retention**. (4380 hours)

If you have many short-lived clusters, you can remove them from the UI automatically once they stop running.
Expand All @@ -66,7 +60,11 @@ To do so, configure a shorter retention period by setting the ``ttl_hours`` in t
Monitoring Specific Resources in Namespaces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval.
.. note::

This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT.

By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval.
However, we have a configuration to monitor custom namespaced resources, and an API is exposed via the Robusta Backend to see how many of each resource you have in a namespace.

To configure this, use the ``namespace_discovery_seconds`` and ``namespaceMonitoredResources`` settings in the Robusta UI sink:
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/ServiceNow.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
ServiceNow
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster by creating
issues in ServiceNow.

Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/VictorOps.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
VictorOps
##########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to the VictorOps alerts API.

| To configure VictorOps, a VictorOps REST endpoint (url) is needed.
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/YandexMessenger.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Yandex Messenger
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to Yandex Messenger chats, channels or private conversations.

.. note::
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/discord.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Discord
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to Discord.

.. image:: /images/discord_example.png
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/file.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
File
###########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can write issues and events in your Kubernetes cluster to a local file (in JSON format).


Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/google_chat.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Google Chat
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster by sending
messages via the `Google Chat <https://chat.google.com/>`_ app.

Expand Down
9 changes: 9 additions & 0 deletions docs/configuration/sinks/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ All Sinks
==================


.. admonition:: Sinks are a legacy feature of Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.

Robusta can send notifications to various destinations, known as sinks.

**Related Topics:**
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/jira.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Jira
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can automatically open and (optionally) resolve Jira tickets, based on issues in your Kubernetes cluster.

.. image:: /images/jira_example.png
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/kafka.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Kafka
#########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to a Kafka topic.

Configuring the Kafka sink
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/mail.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Mail
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster by sending
emails using either SMTP servers or Amazon Simple Email Service (SES).

Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/mattermost.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Mattermost
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to Mattermost.

.. image:: /images/mattermost_sink_example.png
Expand Down
13 changes: 13 additions & 0 deletions docs/configuration/sinks/ms-teams.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
MS Teams
##########

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend connecting HolmesGPT to MS Teams instead of using this legacy sink.

Open the `MS Teams settings page <https://platform.robusta.dev/settings/slack-and-teams>`_ in the Robusta platform to connect HolmesGPT to MS Teams. This adds a single HolmesGPT bot that powers all of the flows below:

- **Chat** — ``@mention`` the bot in any channel to investigate issues on demand; it replies in the thread.
- **Alerts** — let `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ automatically investigate incoming alerts and post the findings to MS Teams.
- **Custom events** — use :ref:`Triggered Workflows <defining-playbooks>` to react to arbitrary events and notify MS Teams.

These are separate flows that share the same bot: chat is interactive, while Alerts Triage and Triggered Workflows run automatically.

Robusta can report issues and events in your Kubernetes cluster to a MS Teams webhook.

.. image:: /images/msteams_sink/deployment-babysitter-teams.png
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/pushover.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Pushover
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to Pushover notification enabled devices.

.. note::
Expand Down
10 changes: 10 additions & 0 deletions docs/configuration/sinks/rocketchat.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Rocket.Chat
#################

.. admonition:: This page documents a legacy sink in Robusta classic
:class: warning

For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.

HolmesGPT triages your alerts instead of just forwarding them. Sinks are deterministic: they send every notification, unchanged, to a fixed destination, leaving you to read and prioritize each one yourself.

HolmesGPT instead uses AI to investigate each alert, surface the likely root cause, and escalate only what needs attention — so you get fewer, more actionable notifications. Set this up with `Alerts Triage <https://platform.robusta.dev/holmes/alerts-triage>`_ for alerts, or :ref:`Triggered Workflows <defining-playbooks>` for custom events.


Robusta can report issues and events in your Kubernetes cluster to Rocket.Chat.

.. image:: /images/rocketchat1.png
Expand Down
Loading
Loading