feat(buttons): add button enricher (#1943)

* feat(buttons): add static and templated button enricher

* fix quotation marks

* unify button enricher, fine-tune missing templates, skip if url is empty

---------

Co-authored-by: arik <alon.arik@gmail.com>

Author: adamantal

docs/playbook-reference/actions/event-enrichment.rst

@@ -122,6 +122,8 @@ These actions enrich Prometheus alerts and only support the :ref:`on_prometheus_
 
 .. robusta-action:: playbooks.robusta_playbooks.alerts_integration.template_enricher
 
+.. robusta-action:: playbooks.robusta_playbooks.alerts_integration.button_enricher
+
 .. robusta-action:: playbooks.robusta_playbooks.alerts_integration.stack_overflow_enricher
 
 .. robusta-action:: playbooks.robusta_playbooks.alerts_integration.default_enricher

docs/playbook-reference/prometheus-examples/link-alert-enrichment.rst

@@ -10,7 +10,7 @@ Implementation
 
 In this example, we add links to the alert ``KubeContainerCPURequestAlert`` that we created in a :ref:`previous tutorial <Create Custom Prometheus Alerts>`.
 
-Add the following YAML to the ``customPlaybooks`` Helm value and :ref:`update Robusta <Simple Upgrade>`.
+Below there are three alternatives ways to enrich the alert with links. Apply the YAML to the ``customPlaybooks`` Helm value and :ref:`update Robusta <Simple Upgrade>`.
 
 .. code-block:: yaml
 
@@ -29,6 +29,10 @@ Add the following YAML to the ``customPlaybooks`` Helm value and :ref:`update Ro
           :scroll: Playbook <https://playbook-url/|Handling High Resource Utilization>
           :github: Adjust CPU requests <https://github.com/YourRepository/|in the `Prod-sre` repository>
           :notion: Internal Docs on <https://notion.com/path-to-docs/|Customizing CPU requests>
+    - button_enricher:
+        button_text: "Playbook for ${team}"
+        button_url: "https://playbook-url/team/${team}"
+
 
 .. code-annotations::
     1. We're using custom emojis here that correspond to GitHub and Notion logos. Before you configure this, follow `this guide <https://slack.com/intl/en-gb/help/articles/206870177-Add-customised-emoji-and-aliases-to-your-workspace>`_ to add emojis to your workspace.

playbooks/robusta_playbooks/alerts_integration.py

@@ -50,7 +50,6 @@
 from robusta.core.reporting.blocks import TableBlockFormat
 from robusta.utils.parsing import format_event_templated_string
 
-
 class SeverityParams(ActionParams):
     """
     :var severity: severity level that should be silenced.
@@ -379,6 +378,20 @@ class TemplateParams(ActionParams):
     template: str = ""
 
 
+def _get_labels(event: KubernetesResourceEvent, default_value: str = "<missing>") -> Dict[str, Any]:
+    labels: Dict[str, Any] = defaultdict(lambda: default_value)
+    if isinstance(event, PrometheusKubernetesAlert):
+        labels.update(event.alert.labels)
+        labels.update(event.alert.annotations)
+        labels.update(vars(event.get_alert_subject()))
+        labels["kind"] = labels["subject_type"].value
+    elif isinstance(event, KubernetesResourceEvent):
+        labels.update(vars(event.get_subject()))
+        labels["kind"] = labels["subject_type"].value
+
+    return labels
+
+
 @action
 def template_enricher(event: KubernetesResourceEvent, params: TemplateParams):
     """
@@ -395,22 +408,45 @@ def template_enricher(event: KubernetesResourceEvent, params: TemplateParams):
     The template can include all markdown directives supported by Slack.
     Note that Slack markdown links use a different format than GitHub.
     """
-    labels: Dict[str, Any] = defaultdict(lambda: "<missing>")
-    if isinstance(event, PrometheusKubernetesAlert):
-        labels.update(event.alert.labels)
-        labels.update(event.alert.annotations)
-        labels.update(vars(event.get_alert_subject()))
-        labels["kind"] = labels["subject_type"].value
-    elif isinstance(event, KubernetesResourceEvent):
-        labels.update(vars(event.get_subject()))
-        labels["kind"] = labels["subject_type"].value
-
+    labels = _get_labels(event)
     template = Template(params.template)
     event.add_enrichment(
         [MarkdownBlock(template.safe_substitute(labels))],
     )
 
 
+class TemplatedButtonParams(ActionParams):
+    """
+    :var button_text: The templated text of the button
+    :var button_url: The templated URL of the button
+    """
+    button_text: str
+    button_url: str
+
+
+@action
+def button_enricher(event: KubernetesResourceEvent, params: TemplatedButtonParams):
+    """
+    Create a button with a templated text and URL.
+    You can inject the k8s subject info and additionally on Prometheus alerts, any of the alert's Prometheus labels.
+
+    Common variables to use are ${name}, ${kind}, ${namespace}, and ${node}
+
+    A variable like ${foo} will be replaced by the value of info/label foo.
+    If it isn't present, then the text will be skipped.
+
+    If the button_url is empty, then the button will not be added.
+
+    Check example for adding a template link.
+
+    """
+    labels = _get_labels(event, default_value="")
+    button_text = Template(params.button_text).safe_substitute(labels)
+    button_url = Template(params.button_url).safe_substitute(labels)
+    if button_url.strip() != "":
+        event.add_link(Link(url=button_url, name=button_text))
+
+
 class SearchTermParams(ActionParams):
     """
     :var search_term: StackOverflow search term