Skip to content

Commit bbb7481

Browse files
aantnclaude
andauthored
Add deprecation notices to legacy sink documentation pages (#2097)
* docs(sinks): mark sinks as legacy and point users to HolmesGPT Add a prominent banner to every sink page noting it documents a legacy sink in Robusta classic. Users are directed to HolmesGPT, which uses triggered workflows + MCP servers to investigate and route alerts agentically instead of statically forwarding notifications. For Slack and MS Teams, point users at the platform Slack & Teams settings page to connect HolmesGPT directly. * docs(sinks): soften legacy banner wording Remove the disparaging 'instead of blindly forwarding' clause from the legacy sink banners; close positively on intelligent per-alert triage. * docs(sinks): add platform alert-triage link to legacy banners Reference both the triggered workflows page and the platform alert triage page (platform.robusta.dev/holmes/alerts-triage) as ways to set up agentic alert routing. * docs(sinks): reword legacy banner opener Change opener from 'You probably want...' to 'For new setups, we recommend...' for a more positive, forward-looking tone. * docs(sinks): simplify legacy banner CTA Drop the MCP servers reference (confusing in this context) and point users to Alerts Triage for alerts or Triggered Workflows for custom events. Also resolves the stale MCP-servers doc link. * docs(sinks): make Slack/Teams banners page-specific Say just 'Slack' on the Slack page and 'MS Teams' on the Teams page instead of 'Slack and Teams' (the shared settings URL still covers both). * docs: add legacy notices to sinks index, configuring-sinks, and LaunchDarkly - Sinks index and configuring-sinks: point users to HolmesGPT (Alerts Triage / Triggered Workflows), matching the per-sink banners. - LaunchDarkly: reuse the shared _legacy_banner include pointing to the Send Events API, consistent with sibling alertmanager-integration pages. * docs(sinks): clarify Slack/Teams banner flows Separate the three flows that share one HolmesGPT bot: interactive chat (@mention), automatic Alerts Triage for alerts, and Triggered Workflows for custom events — instead of conflating them. * docs: fix build errors and refresh RobustaUI sink page - region_box: support :emphasize-lines: on the robusta-code directive (fixes 'maximum 1 argument(s) allowed' error in elasticsearch.rst) - proxies: extend a section underline that was too short - RobustaUI sink: drop outdated/k8s-specific overview and the loom gif, point to home.robusta.dev, and note that the namespace/cluster monitoring features are Robusta classic (not HolmesGPT) * docs(sinks): rewrite legacy banner to lead with HolmesGPT benefits Replace the abstract 'statically forward / agentically' wording with a benefits-first explanation: HolmesGPT triages alerts (investigates, finds root cause, escalates only what matters) vs. deterministic sinks that just forward everything. Then point to Alerts Triage / Triggered Workflows. --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent d831859 commit bbb7481

27 files changed

Lines changed: 264 additions & 14 deletions

docs/_ext/region_box.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
from html import escape
2828

2929
from docutils import nodes
30+
from docutils.parsers.rst import directives
31+
from sphinx.util import parselinenos
3032
from sphinx.util.docutils import SphinxDirective
3133

3234

@@ -68,6 +70,9 @@ class RobustaCodeDirective(SphinxDirective):
6870
required_arguments = 0
6971
optional_arguments = 1
7072
final_argument_whitespace = False
73+
option_spec = {
74+
"emphasize-lines": directives.unchanged_required,
75+
}
7176

7277
def run(self):
7378
language = self.arguments[0] if self.arguments else "text"
@@ -83,6 +88,17 @@ def run(self):
8388
container = nodes.container(classes=["robusta-region-box", "robusta-region-box--code"])
8489
literal = nodes.literal_block(code, code)
8590
literal["language"] = language
91+
92+
emphasize_spec = self.options.get("emphasize-lines")
93+
if emphasize_spec:
94+
try:
95+
nlines = len(code.split("\n"))
96+
hl_lines = [x + 1 for x in parselinenos(emphasize_spec, nlines) if 0 <= x < nlines]
97+
except ValueError:
98+
hl_lines = []
99+
if hl_lines:
100+
literal["highlight_args"] = {"hl_lines": hl_lines}
101+
86102
container += literal
87103
return [container]
88104

docs/configuration/alertmanager-integration/launchdarkly.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. include:: ../_legacy_banner.rst
2+
13
LaunchDarkly Integration with Robusta
24
=====================================
35

docs/configuration/sinks/DataDog.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
DataDog
22
##########
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your cluster to the Datadog events API.
515

616
Example Output:

docs/configuration/sinks/Opsgenie.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
Opsgenie
22
##########
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your Kubernetes cluster to the OpsGenie alerts API.
515

616
To configure OpsGenie, We need an OpsGenie API key. It can be configured using the OpsGenie team integration.

docs/configuration/sinks/PagerDuty.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
PagerDuty
22
##########
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can send three types of data to `PagerDuty <https://www.pagerduty.com/>`_:
515

616
* `Change Events <https://support.pagerduty.com/docs/change-events>`_ - for example, when Deployments are updated

docs/configuration/sinks/RobustaUI.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
11
Robusta UI
22
#################
33

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

6-
- **AI Assistant**: Solve alerts faster with an AI assistant that highlights relevant observability data
7-
- **Alert Timeline**: View Prometheus alerts across multiple clusters and spot correlations with a powerful timeline view
8-
- **Change Tracking**: Correlate alerts with changes to your infrastructure or applications, with Robusta’s automatic change tracking for Kubernetes
9-
10-
.. raw:: html
11-
12-
<div style="text-align: center;">
13-
<a href="https://www.loom.com/share/89c7e098d9494d79895738e0b06091f0" target="_blank" rel="noopener noreferrer">
14-
<img src="https://cdn.loom.com/sessions/thumbnails/89c7e098d9494d79895738e0b06091f0-f508768968f50b46-full-play.gif">
15-
</a>
16-
</div>
6+
For the full list of platform features, see `home.robusta.dev <https://home.robusta.dev>`_.
177

188

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

38+
.. note::
39+
40+
This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT.
41+
4842
By default, inactive Robusta clusters will be kept in the UI for 6 months **data retention**. (4380 hours)
4943

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

69-
By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval.
63+
.. note::
64+
65+
This is a Robusta classic feature for Kubernetes monitoring and does not apply to HolmesGPT.
66+
67+
By default, the Robusta UI sink discovers the standard resources in all namespaces using the standard discovery interval.
7068
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.
7169

7270
To configure this, use the ``namespace_discovery_seconds`` and ``namespaceMonitoredResources`` settings in the Robusta UI sink:

docs/configuration/sinks/ServiceNow.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
ServiceNow
22
#################
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your Kubernetes cluster by creating
515
issues in ServiceNow.
616

docs/configuration/sinks/VictorOps.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
VictorOps
22
##########
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your Kubernetes cluster to the VictorOps alerts API.
515

616
| To configure VictorOps, a VictorOps REST endpoint (url) is needed.

docs/configuration/sinks/YandexMessenger.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
Yandex Messenger
22
#################
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your Kubernetes cluster to Yandex Messenger chats, channels or private conversations.
515

616
.. note::

docs/configuration/sinks/discord.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
Discord
22
#################
33

4+
.. admonition:: This page documents a legacy sink in Robusta classic
5+
:class: warning
6+
7+
For new setups, we recommend `HolmesGPT <https://holmesgpt.dev/>`_ instead.
8+
9+
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.
10+
11+
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.
12+
13+
414
Robusta can report issues and events in your Kubernetes cluster to Discord.
515

616
.. image:: /images/discord_example.png

0 commit comments

Comments
 (0)