Merge branch 'master' into ROB-859-robusta-telemetry

Author: moshemorad

.github/workflows/deploy-docs.yaml

@@ -47,7 +47,7 @@ jobs:
       uses: google-github-actions/setup-gcloud@v2
       if: needs.has-secrets.outputs.docs
       with:
-        project_id: ${{ secrets.GKE_PROD_PROJECT }
+        project_id: ${{ secrets.GKE_PROD_PROJECT }}
 
     - name: Set up Python
       uses: actions/setup-python@v2

docs/configuration/holmesgpt/toolsets/aws.rst

@@ -15,21 +15,7 @@ Configuration
 
   .. md-tab-item:: Robusta Helm Chart
 
-    .. code-block:: yaml
-
-        holmes:
-            additionalEnvVars:
-                - name: AWS_ACCESS_KEY_ID
-                  value: AKIAIOSFODNN7EXAMPLE
-                - name: AWS_SECRET_ACCESS_KEY
-                  value: =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
-                - name: AWS_DEFAULT_REGION
-                  value: us-west-2
-            toolsets:
-                aws/security:
-                    enabled: true
-
-    .. include:: ./_toolset_configuration.inc.rst
+    This builtin toolset is currently only available in HolmesGPT CLI.
 
   .. md-tab-item:: Holmes CLI
 
@@ -52,10 +38,10 @@ Configuration
               enabled: true
 
 
-    To test, run: 
+    To test, run:
 
     .. code-block:: yaml
-      
+
         holmes ask "Are there any security misconfigurations my signup application, particularly in the database?"
 
 Capabilities
@@ -122,10 +108,10 @@ Configuration
           aws/rds:
               enabled: true
 
-    To test, run: 
+    To test, run:
 
     .. code-block:: yaml
-      
+
         holmes ask "Why is my signup application slow, also look into the database"
 
 

docs/configuration/holmesgpt/toolsets/prometheus.rst

@@ -24,7 +24,7 @@ Configuration
                 prometheus/metrics:
                     enabled: true
                     config:
-                        prometheus_url: ...
+                        prometheus_url: http://<prometheus host>:9090
                         metrics_labels_time_window_hrs: 48 # default value
                         metrics_labels_cache_duration_hrs: 12 # default value
                         fetch_labels_with_labels_api: false # default value
@@ -46,7 +46,7 @@ Configuration
             prometheus/metrics:
                 enabled: true
                 config:
-                    prometheus_url: ...
+                    prometheus_url: http://<prometheus host>:9090
                     metrics_labels_time_window_hrs: 48 # default value
                     metrics_labels_cache_duration_hrs: 12 # default value
                     fetch_labels_with_labels_api: false # default value
@@ -62,13 +62,26 @@ in PromQL are actually available.
 
 Below is the full list of options for this toolset:
 
+- **prometheus_url** A base URL for prometheus. This should include the protocol (e.g. `https`) and the port.
 - **metrics_labels_time_window_hrs** Represents the time window, in hours, over which labels are fetched. This avoids fetching obsolete labels. Set it to ``null`` to let HolmesGPT fetch labels regardless of when they were generated.
 - **metrics_labels_cache_duration_hrs** How long are labels cached, in hours. Set it to ``null`` to disable caching.
 - **fetch_labels_with_labels_api** Uses prometheus `labels API <https://prometheus.io/docs/prometheus/latest/querying/api/#getting-label-names>`_ to fetch labels instead of the `series API <https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers>`_. In some cases setting to True can improve the performance of the toolset, however there will be an increased number of HTTP calls to prometheus. You can experiment with both as they are functionally identical.
 - **fetch_metadata_with_series_api** Uses the `series API <https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers>`_ instead of the `metadata API <https://prometheus.io/docs/prometheus/latest/querying/api/#querying-metric-metadata>`_. You should only set this value to `true` if the metadata API is disabled or not working. HolmesGPT's ability to select the right metric will be negatively impacted because the series API does not return key metadata like the metrics/series description or their type (gauge, histogram, etc.).
 - **tool_calls_return_data** Experimental. If true, the prometheus data will be available to HolmesGPT. In some cases, HolmesGPT will be able to detect memory leaks or other anomalies. This is disabled by default to reduce the likelyhood of reaching the input token limit.
 - **headers** Extra headers to pass to all prometheus http requests. Use this to pass authentication. Prometheus `supports basic authentication <https://prometheus.io/docs/guides/basic-auth/>`_.
 
+**Finding the prometheus URL**
+
+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:
+
+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.
+
+
 Capabilities
 ------------
 .. include:: ./_toolset_capabilities.inc.rst