Merge branch 'master' into holmes-upgrade-bugfix

Author: Avi-Robusta

docs/configuration/alertmanager-integration/_testing_integration.rst

@@ -3,12 +3,43 @@ Verify it Works
 
 Send a dummy alert to AlertManager:
 
-.. code-block:: bash
+.. tab-set::
 
-    robusta demo-alert
+    .. tab-item:: Robusta CLI
+
+        If you have the Robusta CLI installed, you can send a test alert using the following command:
+
+        .. code-block:: bash
+
+            robusta demo-alert
+
+    .. tab-item:: Robusta UI
+
+        In the Robusta UI, go to the "Clusters" tab, choose the right cluster and click "Simulate Alert".
+        
+        .. image:: /images/robusta-ui-simulate-alert-1.png
+           :alt: Choose the cluster
+           :width: 900
+           :align: center
+
+        Then 
+
+        1. Check **Send alert with no resource**.
+        2. Provide a name for the alert in the **Alert name (identifier)** field (e.g., "Testing Prod AlertManager").
+        3. Select **Alert Manager** under the "Send alert to" section.
+        4. Click the **Simulate Alert** button to send the test alert.
+
+        .. image:: /images/robusta-ui-simulate-alert-2.png
+           :alt: Send Test Alert
+           :width: 600
+           :align: center
 
 If everything is setup properly, this alert will reach Robusta. It will show up in the Robusta UI, Slack, and other configured sinks.
 
+.. note::
+
+    It might take a few minutes for the alert to arrive due to AlertManager's `group_wait` and `group_interval` settings. More info `here <https://prometheus.io/docs/alerting/latest/configuration/#:~:text=How%20long%20to%20wait%20before%20sending%20a%20notification%20about%20new%20alerts%20that%0A%23%20are%20added%20to%20a%20group%20of%20alerts%20for%20which%20an%20initial%20notification%20has%0A%23%20already%20been%20sent>`_.
+
 .. details:: I configured AlertManager, but I'm not receiving alerts?
     :class: warning
 

docs/configuration/alertmanager-integration/victoria-metrics.rst

@@ -8,26 +8,48 @@ You will need to configure two integrations: one to send alerts to Robusta and a
 Send Alerts to Robusta
 ============================
 
-To configure, edit AlertManager's configuration:
+Add the following to your Victoria Metrics Alertmanager configuration (e.g., Helm values file or VMAlertmanagerConfig CRD):
+
+.. code-block:: yaml
+
+    receivers:
+      - name: 'robusta'
+      webhook_configs:
+          - url: 'http://<ROBUSTA-HELM-RELEASE-NAME>-runner.<NAMESPACE>.svc.cluster.local/api/alerts'
+          send_resolved: true # (3)
+
+    route: # (1)
+      routes:
+      - receiver: 'robusta'
+          group_by: [ '...' ]
+          group_wait: 1s
+          group_interval: 1s
+          matchers:
+          - severity =~ ".*"
+          repeat_interval: 4h
+          continue: true # (2)
+
+.. code-annotations::
+    1. Put Robusta's route as the first route, to guarantee it receives alerts. If you can't do so, you must guarantee all previous routes has ``continue: true`` set.
+    2. Keep sending alerts to receivers defined after Robusta.
+    3. Important, so Robusta knows when alerts are resolved.
 
-.. include:: ./_alertmanager-config.rst
 
 .. include:: ./_testing_integration.rst
 
-Configure Metric Querying
+Configure Metrics Querying
 ====================================
 
-Metrics querying lets Robusta pull metrics and create silences.
+Robusta can query metrics and create silences using Victoria Metrics. If both are in the same Kubernetes cluster, Robusta can auto-detect the Victoria Metrics service. To verify, go to the "Apps" tab in Robusta, select an application, and check for usage graphs.
 
-Add the following to ``generated_values.yaml`` and :ref:`update Robusta <Simple Upgrade>`.
+If auto-detection fails you must add the ``prometheus_url`` parameter and :ref:`update Robusta <Simple Upgrade>`.
 
 .. code-block:: yaml
 
     globalConfig: # this line should already exist
         # add the lines below
-        alertmanager_url: "http://ALERT_MANAGER_SERVICE_NAME.NAMESPACE.svc.cluster.local:9093"
-        grafana_url: ""
-        prometheus_url: "http://VICTORIA_METRICS_SERVICE_NAME.NAMESPACE.svc.cluster.local:8429"
+        alertmanager_url: "http://<VM_ALERT_MANAGER_SERVICE_NAME>.<NAMESPACE>.svc.cluster.local:9093" # Example:"http://vmalertmanager-victoria-metrics-vm.default.svc.cluster.local:9093/"        
+        prometheus_url: "http://VM_Metrics_SERVICE_NAME.NAMESPACE.svc.cluster.local:8429" # Example:"http://vmsingle-vmks-victoria-metrics-k8s-stack.default.svc.cluster.local:8429"
         # Add any labels that are relevant to the specific cluster (optional)
         # prometheus_additional_labels:
         #   cluster: 'CLUSTER_NAME_HERE'

docs/configuration/holmesgpt/toolsets/grafanaloki.rst

@@ -1,10 +1,10 @@
 .. _toolset_grafana_loki:
 
-Loki (Grafana)
-===============
+Loki
+====
 
-By enabling this toolset, HolmesGPT will fetch node and pods logs from `Loki <https://grafana.com/oss/loki/>`_
-by proxying through a `Grafana <https://grafana.com/oss/grafana/>`_ instance.
+By enabling this toolset, HolmesGPT will fetch node and pods logs from `Loki <https://grafana.com/oss/loki/>`_.
+Loki can be accessed directly or by proxying through a `Grafana <https://grafana.com/oss/grafana/>`_ instance.
 
 You **should** enable this toolset to replace the default :ref:`kubernetes/logs <toolset_kubernetes_logs>`
 toolset if all your kubernetes/pod logs are consolidated inside Loki. It will make it easier for HolmesGPT
@@ -13,8 +13,14 @@ to fetch incident logs, including the ability to precisely consult past logs.
 
 .. include:: ./_toolsets_that_provide_logging.inc.rst
 
+
+Proxying through Grafana
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This is the recommended approach because we intend to add more capabilities to the toolset that are only available with Grafana.
+
 Prerequisites
-^^^^^^^^^^^^^
+-------------
 
 A `Grafana service account token <https://grafana.com/docs/grafana/latest/administration/service-accounts/>`_
 with the following permissions:
@@ -24,8 +30,7 @@ with the following permissions:
 
 Check out this `video <https://www.loom.com/share/f969ab3af509444693802254ab040791?sid=aa8b3c65-2696-4f69-ae47-bb96e8e03c47>`_ on creating a Grafana service account token.
 
-Getting Grafana URL
------------------------
+**Getting Grafana URL**
 
 You can find the Grafana URL required for Loki in your Grafana cloud account settings.
 
@@ -34,8 +39,7 @@ You can find the Grafana URL required for Loki in your Grafana cloud account set
   :align: center
 
 
-Obtaining the datasource UID
------------------------------------
+**Obtaining the datasource UID**
 
 You may have multiple Loki data sources setup in Grafana. HolmesGPT uses a single Loki datasource to
 fetch the logs and it needs to know the UID of this datasource.
@@ -74,8 +78,8 @@ A simple way to get the datasource UID is to access the Grafana API by running t
     # with UID "klja8hsa-8a9c-4b35-1230-7baab22b02ee"
 
 
-Configuration
-^^^^^^^^^^^^^
+Configuration (grafana proxy)
+-----------------------------
 
 
 .. md-tab-set::
@@ -92,9 +96,6 @@ Configuration
               api_key: <your grafana API key>
               url: https://xxxxxxx.grafana.net # Your Grafana cloud account URL
               grafana_datasource_uid: <the UID of the loki data source in Grafana>
-              labels:
-                pod: "pod"
-                namespace: "namespace"
 
           kubernetes/logs:
             enabled: false # Disable HolmesGPT's default logging mechanism
@@ -115,19 +116,102 @@ Configuration
             api_key: <your grafana API key>
             url: https://xxxxxxx.grafana.net # Your Grafana cloud account URL
             grafana_datasource_uid: <the UID of the loki data source in Grafana>
-            labels:
-                pod: "pod"
-                namespace: "namespace"
 
         kubernetes/logs:
           enabled: false # Disable HolmesGPT's default logging mechanism
 
+Direct connection
+^^^^^^^^^^^^^^^^^
+
+The toolset can directly connect to a Loki instance without proxying through a Grafana instance.
+This is done by not setting the ``grafana_datasource_uid`` field. Not setting this field makes HolmesGPT
+assume that it is directly connecting to Loki.
+
+Configuration (direct connection)
+---------------------------------
+
+.. md-tab-set::
+
+  .. md-tab-item:: Robusta Helm Chat
+
+    .. code-block:: yaml
+
+      holmes:
+        toolsets:
+          grafana/loki:
+            enabled: true
+            config:
+              url: http://loki.logging
+              headers:
+                X-Scope-OrgID: "<tenant id>" # Set the X-Scope-OrgID if loki multitenancy is enabled
+
+          kubernetes/logs:
+            enabled: false # Disable HolmesGPT's default logging mechanism
+
+
+    .. include:: ./_toolset_configuration.inc.rst
+
+  .. md-tab-item:: Holmes CLI
+
+    Add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
+
+    .. code-block:: yaml
+
+      toolsets:
+        grafana/loki:
+          enabled: true
+          config:
+            url: http://loki.logging
+            headers:
+              X-Scope-OrgID: "<tenant id>" # Set the X-Scope-OrgID if loki multitenancy is enabled
+
+        kubernetes/logs:
+          enabled: false # Disable HolmesGPT's default logging mechanism
+
+
+Advanced configuration
+^^^^^^^^^^^^^^^^^^^^^^
 
 **Search labels**
 
 You can tweak the labels used by the toolset to identify kubernetes resources. This is only needed if your
 Loki logs settings for ``pod``, and ``namespace`` differ from the defaults in the example above.
 
+
+.. md-tab-set::
+
+  .. md-tab-item:: Robusta Helm Chat
+
+    .. code-block:: yaml
+
+      holmes:
+        toolsets:
+          grafana/loki:
+            enabled: true
+            config:
+              url: ...
+              labels:
+                  pod: "pod"
+                  namespace: "namespace"
+
+    .. include:: ./_toolset_configuration.inc.rst
+
+  .. md-tab-item:: Holmes CLI
+
+    Add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
+
+    .. code-block:: yaml
+
+      toolsets:
+        grafana/loki:
+          enabled: true
+          config:
+            url: ...
+            labels:
+                pod: "pod"
+                namespace: "namespace"
+
+
 Use the following commands to list Loki's labels and determine which ones to use:
 
 .. code-block:: bash