Merge branch 'master' into ROB-1033-custom-owners

Author: RoiGlinik

.github/workflows/test_robusta.yaml

@@ -19,7 +19,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: 3.11
 
       # setup a KIND cluster for tests which need a kubernetes image
       - name: Create k8s Kind Cluster

docs/_static/custom.css

@@ -298,6 +298,37 @@ h3 {
     margin-bottom: 20px !important;
 }
 
+/* Back to Top Button */
+.back-to-top {
+    position: fixed;
+    bottom: 30px;
+    right: 30px;
+    width: 50px;
+    height: 50px;
+    background-color: var(--md-primary-fg-color);
+    color: white;
+    border-radius: 50%;
+    text-align: center;
+    line-height: 50px;
+    font-size: 20px;
+    text-decoration: none;
+    opacity: 0;
+    visibility: hidden;
+    z-index: 1000;
+    transition: opacity 0.3s, visibility 0.3s;
+    box-shadow: 0 2px 5px rgba(0, 0, 0, 0.3);
+    cursor: pointer;
+}
+
+.back-to-top.visible {
+    opacity: 0.7;
+    visibility: visible;
+}
+
+.back-to-top:hover {
+    opacity: 1;
+}
+
 .sd-sphinx-override p {
     margin-bottom: 0px;
 }

docs/_templates/base.html

@@ -1,6 +1,10 @@
 {% extends '!base.html' %}
 {% block site_meta %}
 {{ super() }}
+<!-- Back to Top Button -->
+<a href="#" class="back-to-top" aria-label="Back to top">
+  <span>↑</span>
+</a>
 <!-- PostHog and Segment -->
 <script>
   !function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
@@ -27,6 +31,26 @@
     document.getElementById('__palette_1').onclick = () => refreshRobustaLogo(true);
     document.getElementById('__palette_2').onclick = () => refreshRobustaLogo(false);
 
+    // Back to top button functionality
+    const backToTopButton = document.querySelector('.back-to-top');
+    
+    // Show button when page is scrolled down
+    window.addEventListener('scroll', function() {
+      if (window.pageYOffset > 300) {
+        backToTopButton.classList.add('visible');
+      } else {
+        backToTopButton.classList.remove('visible');
+      }
+    });
+    
+    // Smooth scroll to top when button is clicked
+    backToTopButton.addEventListener('click', function(e) {
+      e.preventDefault();
+      window.scrollTo({
+        top: 0,
+        behavior: 'smooth'
+      });
+    });
   }, false);
 </script>
 {% endblock %}

docs/conf.py

@@ -123,9 +123,56 @@
     "catalog/triggers/prometheus.html": "/master/configuration/alertmanager-integration/index.html",
     "playbook-reference/prometheus-examples/alert-remediation.html": "/master/playbook-reference/automatic-remediation-examples/index.html",
     "configuration/ai-analysis.html": "/master/configuration/holmesgpt/index.html",
-
-
-}
+    "coverage.html": "/master/how-it-works/coverage.html",
+    "tutorials/python-profiling.html": "/master/playbook-reference/actions/python-troubleshooting.html#python-profiler",
+    "tutorials/more-tutorials.html": "/master/community-tutorials.html",
+    "common-errors.html": "/master/help.html#common-errors",
+    "user-guide/defining-playbooks.html": "/master/playbook-reference/defining-playbooks/index.html",
+    "user-guide/global-config.html": "/master/setup-robusta/additional-settings.html#global-config",
+    "user-guide/configuration-secrets.html": "master/setup-robusta/configuration-secrets.html",
+    "user-guide/additional-playbooks.html": "/master/playbook-reference/defining-playbooks/external-playbook-repositories.html",
+    "user-guide/embedded-prometheus.html": "/master/configuration/alertmanager-integration/embedded-prometheus.html#enabling-the-embedded-prometheus",
+    "user-guide/node-selector.html": "/master/setup-robusta/node-selector.html",
+    "user-guide/interactivity.html": "/master/setup-robusta/additional-settings.html#two-way-interactivity",
+    "user-guide/flow-control.html": "/master/playbook-reference/defining-playbooks/playbook-advanced.html#using-filters-to-restrict-triggers",
+    "catalog/triggers/index.html": "/master/playbook-reference/triggers/index.html",
+    "catalog/triggers/kubernetes.html": "/master/playbook-reference/triggers/kubernetes.html",
+    "catalog/triggers/smart.html": "/master/playbook-reference/triggers/kubernetes.html",
+    "catalog/triggers/scheduled.html": "/master/playbook-reference/triggers/scheduled.html",
+    "catalog/triggers/manual-triggers.html": "/master/playbook-reference/triggers/manual-triggers.html",
+    "catalog/triggers/webhook.html": "/master/playbook-reference/triggers/webhook.html",
+    "catalog/triggers/elasticsearch.html": "/master/playbook-reference/triggers/elasticsearch.html",
+    "catalog/actions/remediation.html": "/master/playbook-reference/automatic-remediation-examples/index.html",
+    "catalog/actions/change-tracking.html": "/master/playbook-reference/actions/change-tracking.html#change-tracking",
+    "catalog/actions/java-troubleshooting.html": "/master/playbook-reference/actions/java-troubleshooting.html",
+    "catalog/actions/miscellaneous.html": "/master/playbook-reference/actions/miscellaneous.html",
+    "catalog/actions/message-formatting.html":"/master/playbook-reference/actions/message-formatting.html",
+    "catalog/sinks/RobustaUI.html": "/master/configuration/sinks/RobustaUI.html",
+    "catalog/sinks/discord.html": "/master/configuration/sinks/discord.html",
+    "catalog/sinks/kafka.html": "/master/configuration/sinks/kafka.html",
+    "catalog/sinks/DataDog.html": "/master/configuration/sinks/DataDog.html",
+    "catalog/sinks/ms-teams.html": "/master/configuration/sinks/ms-teams.html",
+    "catalog/sinks/mattermost.html": "/master/configuration/sinks/mattermost.html",
+    "catalog/sinks/webex.html": "/master/configuration/sinks/webex.html",
+    "catalog/sinks/VictorOps.html": "/master/configuration/sinks/VictorOps.html",
+    "catalog/sinks/file.html": "/master/configuration/sinks/file.html",
+    "user-guide/trigger-action-binding.html": "/master/playbook-reference/defining-playbooks/playbook-basics.html#understanding-actions",
+    "advanced/privacy-and-security.html": "/master/setup-robusta/privacy-and-security.html",
+    "advanced/robusta-ui-triggers.html": "/master/setup-robusta/installation/index.html",
+    "developer-guide/actions/index.html": "/master/playbook-reference/actions/index.html",
+    "developer-guide/actions/writing-playbooks.html":"/master/playbook-reference/actions/develop-actions/writing-playbooks.html#the-basics",
+    "developer-guide/actions/playbook-repositories.html": "/master/playbook-reference/actions/develop-actions/playbook-repositories.html",
+    "developer-guide/actions/triggers-and-events.html": "/master/playbook-reference/actions/develop-actions/triggers-and-events.html",
+    "developer-guide/actions/utility-functions.html": "/master/playbook-reference/actions/develop-actions/utility-functions.html",
+    "developer-guide/actions/documenting-actions.html": "/master/playbook-reference/actions/develop-actions/documenting-actions.html",
+    "developer-guide/platform/index.html": "/master/contributing.html",
+    "developer-guide/platform/dev-setup.html": "/master/contributing.html",
+    "developer-guide/platform/coding-conventions.html": "/master/contributing.html",
+    "developer-guide/platform/docs-contributions.html": "/master/docs-contributions.html#improving-these-docs",
+    "developer-guide/platform/sinks-guide.html": "/master/configuration/sinks/sinks-development.html",
+    "user-guide/robusta-cli.html": "/master/setup-robusta/installation/index.html",
+    "advanced/index.html": "/master/setup-robusta/installation/index.html"
+} 
 
 
 # for sphinx_jinja - see https://github.com/tardyp/sphinx-jinja

docs/configuration/holmesgpt/index.rst

@@ -18,7 +18,7 @@ Robusta can integrate with `Holmes GPT <https://github.com/robusta-dev/holmesgpt
 
 When available, AI based investigations can be launched in one of two ways:
 
-1. Click the ``Ask Holmes`` button in Slack. The AI investigation will be sent back as a new message.
+1. Click the ``Ask HolmesGPT`` button in Slack. The AI investigation will be sent back as a new message.
 
 .. image:: /images/robusta-holmes-investigation.png
     :width: 600px
@@ -223,6 +223,46 @@ Choose an AI provider below and follow the instructions:
 
         Run a :ref:`Helm Upgrade <Simple Upgrade>` to apply the configuration.
 
+    .. tab-item:: Multiple providers
+        :name: multiple-providers
+
+        Starting from version *0.22.1*, Robusta supports an alternative way to configure AI models: using a YAML dictionary in your Helm values file.
+
+        This method allows you to configure multiple models at once, each with its own parameters.
+
+        Update your Helm values (``generated_values.yaml`` file) with the following configuration.
+
+        When multiple models are defined, the Robusta UI will allow users to choose a specific model when initiating an AI-based investigation.
+
+        .. admonition:: Model info
+            :class: warning
+
+            When using multiple providers, the keys differ slightly from the single-provider case.
+
+        .. code-block:: yaml
+
+          enableHolmesGPT: true
+
+          holmes:
+            modelList: # sample configuration.
+              openai:
+                model: openai/gpt-4o
+                api_key: "{{ env.API_KEY }}"
+              azure-low-budget: 
+                model : azure/team-low-budget
+                api_base : <your-api-base> # fill in the base endpoint url of your azure deployment - e.g. https://my-org.openai.azure.com/
+                api_version : "2024-06-01"
+                api_key : "{{ env.AZURE_API_KEY }}" # you can load the values from an environment variable as well.
+                temperature: 0
+              bedrock-devops: 
+                model: bedrock/anthropic.claude-3-5-sonnet-20240620-v1:0 # your bedrock model.
+                aws_region_name: us-east-1
+                aws_access_key_id: "{{ env.AWS_ACCESS_KEY_ID }}" # you can load the values from an environment variable as well.
+                aws_secret_access_key: <your-aws-secret-access-key>
+                thinking: {"type": "enabled", "budget_tokens": 1024}
+
+        Run a :ref:`Helm Upgrade <Simple Upgrade>` to apply the configuration.
+
 Configuring HolmesGPT Access to SaaS Data
 ----------------------------------------------------
 

docs/configuration/holmesgpt/toolsets/coralogix_logs.rst

@@ -41,10 +41,6 @@ Configuration
               api_key: <your coralogix API key>
               domain: eu2.coralogix.com # Your Coralogix domain
               team_hostname: my-team # Your team's hostname in coralogix, without the domain part
-              labels:
-                pod: "kubernetes.pod_name"
-                namespace: "kubernetes.namespace_name"
-                app: "kubernetes.labels.app"
 
           kubernetes/logs:
             enabled: false # Disable HolmesGPT's default logging mechanism
@@ -65,19 +61,61 @@ Configuration
             api_key: <your coralogix API key>
             domain: eu2.coralogix.com # Your Coralogix domain
             team_hostname: my-team # Your team's hostname in coralogix
-            labels:
-              pod: "kubernetes.pod_name"
-              namespace: "kubernetes.namespace_name"
-              app: "kubernetes.labels.app"
 
         kubernetes/logs:
           enabled: false # Disable HolmesGPT's default logging mechanism
 
+Advanced Configuration
+^^^^^^^^^^^^^^^^^^^^^^
+
+**Frequent logs and archive**
+
+By default, holmes fetched the logs from the `Frequent search <https://coralogix.com/docs/user-guides/account-management/tco-optimizer/logs/#frequent-search-data-high-priority>`_ 
+tier and only fetch logs from the `Archive` tier if the frequent search returned no result.
+
+This behaviour can be customised using the ``logs_retrieval_methodology`` configuration field:
+
+.. code-block:: yaml
+
+  toolsets:
+    coralogix/logs:
+      enabled: true
+      config:
+        # Possible values are:
+        #  - FREQUENT_SEARCH_ONLY
+        #  - ARCHIVE_ONLY
+        #  - ARCHIVE_FALLBACK  <- default value
+        #  - FREQUENT_SEARCH_FALLBACK
+        #  - BOTH_FREQUENT_SEARCH_AND_ARCHIVE
+        logs_retrieval_methodology: ARCHIVE_FALLBACK # default value
+        ...
+
+Here is a description of each possible log retrieval methodology:
+
+- **FREQUENT_SEARCH_ONLY** Always fetch logs using a frequent search.
+- **ARCHIVE_ONLY** Always fetch logs using the archive.
+- **ARCHIVE_FALLBACK** Use a frequent search first. If there are no results, fallback to searching archived logs. **This is the default behaviour.**
+- **FREQUENT_SEARCH_FALLBACK** Search logs in the archive first. If there are no results, fallback to searching the frequent logs.
+- **BOTH_FREQUENT_SEARCH_AND_ARCHIVE** Always use both the frequent search and the archive to fetch logs. The result contains merged data which is deduplicated and sorted by timestamp.
 
 **Search labels**
 
-You can tweak the labels used by the toolset to identify kubernetes resources. This is only needed if your
-logs settings for ``pod``, ``namespace``, and ``app`` differ from the defaults in the example above.
+You can tweak the labels used by the toolset to identify kubernetes resources. This is **optional** and only needed if your
+logs settings for ``pod``, ``namespace``, ``application`` and ``subsystem`` differ from the defaults in the example below.
+
+.. code-block:: yaml
+
+  toolsets:
+    coralogix/logs:
+      enabled: true
+      config:
+        labels: # OPTIONAL: tweak the filters used by HolmesGPT if your coralogix configuration is non standard
+          namespace: "kubernetes.namespace_name"
+          pod: "kubernetes.pod_name"
+          application: "coralogix.metadata.applicationName"
+          subsystem: "coralogix.metadata.subsystemName"
+        ...
+
 
 You can verify what labels to use by attempting to run a query in the coralogix ui:
 
@@ -111,5 +149,5 @@ Capabilities
 
    * - Tool Name
      - Description
-   * - coralogix_fetch_logs
-     - Retrieve logs from Coralogix
+   * - fetch_coralogix_logs_for_resource
+     - Retrieve logs using coralogix

docs/configuration/holmesgpt/toolsets/prometheus.rst

@@ -24,7 +24,7 @@ Configuration
                 prometheus/metrics:
                     enabled: true
                     config:
-                        prometheus_url: http://<prometheus host>:9090
+                        prometheus_url: http://<prometheus host>:9090 # e.g. http://robusta-kube-prometheus-st-prometheus.default.svc.cluster.local:9090
                         headers:
                             Authorization: "Basic <base_64_encoded_string>"
 
@@ -41,7 +41,7 @@ Configuration
             prometheus/metrics:
                 enabled: true
                 config:
-                    prometheus_url: http://<prometheus host>:9090
+                    prometheus_url: http://<prometheus host>:9090 # e.g. http://robusta-kube-prometheus-st-prometheus.default.svc.cluster.local:9090
                     headers:
                         Authorization: "Basic <base_64_encoded_string>"
 
@@ -78,13 +78,11 @@ Below is the full list of options for this toolset:
 
 The best way to find the prometheus URL is to use "ask holmes". This only works if your cluster is live and already connected to Robusta.
 
-If not, follow these steps:
+If not, you can often find the prometheus URL by running the following command (several results may be shown - pick the best match):
 
-1. Run ``kubectl get services -n <monitoring-namespace>`` to list all services. Replace ``<monitoring-namespace>`` with the namespace where Prometheus is deployed. This is often ``monitoring`` or ``prometheus``. You can also run ``kubectl get services -A`` which will list all services in all namespaces.
-2. Identify which are the namespace and name of your Prometheus service. You can set up port forwarding to test if the service is correct and if Prometheus is reachable.
-3. Run ``kubectl describe service <service-name> -n <namespace>`` to get details about the service, including the cluster IP and port.
-4. Set the DNS or the cluster IP as well as the port to the configuration field ``prometheus_url`` as mentioned above.
+.. code-block:: bash
 
+    kubectl get svc --all-namespaces -o jsonpath='{range .items[*]}{.metadata.name}{"."}{.metadata.namespace}{".svc.cluster.local:"}{.spec.ports[0].port}{"\n"}{end}' | grep prometheus | grep -Ev 'operat|alertmanager|node|coredns|kubelet|kube-scheduler|etcd|controller' | awk '{print "http://"$1}'
 
 Capabilities
 ------------

docs/configuration/holmesgpt/toolsets/robusta.rst

@@ -3,7 +3,7 @@ Robusta :checkmark:`_`
 .. include:: ./_toolset_enabled_by_default.inc.rst
 
 By enabling this toolset, HolmesGPT will be able to fetch alerts metadata. It allows HolmesGPT to fetch information
-about specific issues when chatting using "Ask Holmes". This toolset is not necessary for Root Cause Analysis.
+about specific issues when chatting using "Ask HolmesGPT". This toolset is not necessary for Root Cause Analysis.
 
 Configuration
 -------------

docs/configuration/sinks/Opsgenie.rst

@@ -14,7 +14,9 @@ We can add Prometheus alert labels into Opsgenie alert extra details by setting
 Configuring the OpsGenie sink
 ------------------------------------------------
 
-.. admonition:: Add this to your generated_values.yaml
+The OpsGenie sink supports static and dynamic team routing, optional fallback teams, tagging, and enrichment with Kubernetes labels.
+
+.. admonition:: Add this to your `generated_values.yaml`
 
     .. code-block:: yaml
 
@@ -23,13 +25,32 @@ Configuring the OpsGenie sink
             name: ops_genie_sink
             api_key: OpsGenie integration API key  # configured from OpsGenie team integration
             teams:
-            - "noc"
-            - "sre"
+            - "noc"                  # Static team
+            - "$labels.team"  # Dynamic routing based on alert labels or annotations.
+                              # For example, if an alert subject has `team=infra`, it routes to the "infra" team.
+                              # Use $labels.<label_name> or $annotations.<label_name> as placeholders.
+            default_team: "oncall"   # Optional fallback team for Dynamic team routing
             tags:
             - "prod a"
             extra_details_labels: false # optional, default is false
 
-Save the file and run
+In this example:
+
+- Alerts will be routed to the **"noc"** team by default.
+- If the alert includes a **"team" label**, it will also be routed to the value of that label.
+- If the **"team" label is missing**, the alert will be routed to the **"oncall"** team as a fallback.
+- The tag **"prod a"** will be included with every alert.
+- Kubernetes labels **will not be added** to alert details, as `extra_details_labels` is set to `false`.
+
+.. note::
+
+   - Dynamic team routing using label-based templates (e.g., ``$labels.team``) is only supported on **OpsGenie Standard** or **Enterprise** plans.
+     If you are on a Free or Essentials plan, these templates will not function as expected.
+
+   - The API key must be from a **Global API Integration** for dynamic routing to work.
+     If you use a **team-specific API key**, alerts will be routed **only to that team**.
+
+Save the file and apply the configuration:
 
 .. code-block:: bash
    :name: cb-add-opsgenie-sink

src/robusta/core/model/base_params.py

@@ -83,7 +83,7 @@ class ResourceInfo(BaseModel):
 class HolmesParams(ActionParams):
 
     holmes_url: Optional[str]
-
+    model: Optional[str]
     @validator("holmes_url", allow_reuse=True)
     def validate_protocol(cls, v):
         if v and not v.startswith("http"):  # if the user configured url without http(s)
@@ -251,6 +251,7 @@ class HolmesWorkloadHealthChatParams(HolmesParams):
     conversation_history: Optional[list[dict]] = None
 
 
+
 class NamespacedResourcesParams(ActionParams):
     """
     :var name: Resource name