[Rob 1901] custom rule label (#1957)

* add changes to rules

* added docs

* added update to labels/rules on helm upgrade

* bugfix

* updates labels correctly after helm upgrade

Author: Avi-Robusta

docs/setup-robusta/alertsui.rst

@@ -66,6 +66,29 @@ Choose the appropriate instructions below, based on whether you use the Promethe
 
       Then perform a :ref:`Helm Upgrade <Simple Upgrade>`.
 
+      
+Customizing PrometheusRule Labels and Group Name
+**************************************************
+
+When you create alerts in the Robusta Alerts UI, they are synced to your cluster as PrometheusRule CRDs. You can customize the labels and group name that are applied to these UI-created rules.
+
+Add the following to your ``globalConfig`` section in ``generated_values.yaml``:
+
+.. code-block:: yaml
+
+   globalConfig:
+     # Custom group name for PrometheusRule alerts created from the Robusta Alerts UI
+     prometheus_rule_group_name: "robusta-rule-group"
+     
+     # Custom labels to add to PrometheusRule metadata for rules created from the UI
+     prometheus_rule_custom_labels:
+       my_label: "my_value"
+
+Then perform a :ref:`Helm Upgrade <Simple Upgrade>`.
+
+.. note::
+   These settings only apply to PrometheusRules created from the Robusta Alerts UI.
+
 
 Disabling the Feature
 ---------------------------------

helm/robusta/values.yaml

@@ -34,6 +34,11 @@ globalConfig:
   signing_key: ""
   custom_annotations: []
   custom_severity_map: {}
+  
+  # Custom group name for PrometheusRule alerts managed by Robusta UI
+  prometheus_rule_group_name: "kubernetes-apps"
+  # Custom labels to add to PrometheusRule metadata for alert selection
+  prometheus_rule_custom_labels: {}
 
 # see https://docs.robusta.dev/master/user-guide/configuration/additional-settings.html#relabel-prometheus-alerts
 alertRelabel: []

src/robusta/core/sinks/robusta/robusta_sink.py

@@ -95,7 +95,7 @@ def __init__(self, sink_config: RobustaSinkConfigWrapper, registry):
         self.__prometheus_discovery_util = PrometheusDiscoveryUtils(
             discovery_period_sec=self.__discovery_period_sec, registry=registry
         )
-        self.__rrm_checker = RRM(dal=self.dal, cluster=self.cluster_name, account_id=self.account_id)
+        self.__rrm_checker = RRM(dal=self.dal, cluster=self.cluster_name, account_id=self.account_id, registry=registry)
         self.__pods_running_count: int = 0
 
         self.registry.subscribe("scan_updated", self)

src/robusta/core/sinks/robusta/rrm/prometheus_alert_resource_manager.py

@@ -19,6 +19,8 @@ def __init__(
         self,
         cluster: str,
         resource_kind: ResourceKind,
+        custom_labels: Dict[str, str],
+        group_name: Optional[str] = None,
     ):
         super().__init__(resource_kind, cluster)
         self.__sleep = RRM_PERIOD_SEC
@@ -30,7 +32,8 @@ def __init__(
         self.__label_selector = f"{self.__identification_label}={self.__identification_label_value}"
         self.__plural = "prometheusrules"
         self.__group = "monitoring.coreos.com"
-        self.__group_name = "kubernetes-apps"
+        self.__group_name = group_name or "kubernetes-apps"
+        self.__custom_labels = custom_labels
         self.__version = "v1"
         self.__k8_apiVersion = f"{self.__group}/{self.__version}"
         self.__kind = "PrometheusRule"
@@ -72,17 +75,22 @@ def __exisiting_rules_objects_map(self) -> Optional[Dict[str, Dict]]:
 
         return result
 
+    def __get_labels(self) -> Dict:
+        labels = {
+            "release": RELEASE_NAME,
+            "role": "alert-rules",
+            self.__identification_label: self.__identification_label_value,
+        }
+        labels.update(self.__custom_labels)
+        return labels
+
     def __get_snapshot_body(self, name: str, rules: List[dict]):
         return {
             "apiVersion": self.__k8_apiVersion,
             "kind": self.__kind,
             "metadata": {
                 "name": name,
-                "labels": {
-                    "release": RELEASE_NAME,
-                    "role": "alert-rules",
-                    self.__identification_label: self.__identification_label_value,
-                },
+                "labels": self.__get_labels(),
             },
             "spec": {"groups": [{"name": self.__group_name, "rules": rules}]},
         }
@@ -100,6 +108,12 @@ def __create_cr_rules(
                     existing_cr_obj["spec"]["groups"] = [{}]
 
                 existing_cr_obj["spec"]["groups"][0]["rules"] = rules
+                # Update group name and labels - if helm chart is upgraded with new group name + labels, it will be updated here
+                existing_cr_obj["spec"]["groups"][0]["name"] = self.__group_name
+                if not existing_cr_obj.get("metadata"):
+                    existing_cr_obj["metadata"] = {}
+                # Overwrite labels - if helm chart is upgraded with new custom labels, existing labels will be updated
+                existing_cr_obj["metadata"]["labels"] = self.__get_labels()
 
                 # If a custom object with the given name already exists then replace the existing custom object with
                 # the updated one.

src/robusta/core/sinks/robusta/rrm/rrm.py

@@ -13,15 +13,20 @@
 
 # robusta resource management
 class RRM:
-    def __init__(self, dal: AccountResourceFetcher, cluster: str, account_id: str):
+    def __init__(self, dal: AccountResourceFetcher, cluster: str, account_id: str, registry):
         self.dal = dal
         self.cluster = cluster
         self.__sleep = RRM_PERIOD_SEC
         self.__latest_revision: Optional[datetime] = None
+        global_config = registry.get_global_config()
+        custom_labels = global_config.get("prometheus_rule_custom_labels", {})
+        group_name = global_config.get("prometheus_rule_group_name")
         self.__resource_handler_map: Dict[ResourceKind, BaseResourceHandler] = {
             ResourceKind.PrometheusAlert: PrometheusAlertResourceHandler(
                 cluster=self.cluster,
-                resource_kind=ResourceKind.PrometheusAlert
+                resource_kind=ResourceKind.PrometheusAlert,
+                custom_labels=custom_labels,
+                group_name=group_name
             )
         }