Skip to content

Commit 195894f

Browse files
committed
doc: improve prometheus toolset docs. add details for prometheus_url
1 parent bc0cfd5 commit 195894f

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

docs/configuration/holmesgpt/toolsets/prometheus.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Configuration
2424
prometheus/metrics:
2525
enabled: true
2626
config:
27-
prometheus_url: http://robusta-kube-prometheus-st-prometheus:9090
27+
prometheus_url: http://<prometheus host>:9090
2828
metrics_labels_time_window_hrs: 48 # default value
2929
metrics_labels_cache_duration_hrs: 12 # default value
3030
fetch_labels_with_labels_api: false # default value
@@ -46,7 +46,7 @@ Configuration
4646
prometheus/metrics:
4747
enabled: true
4848
config:
49-
prometheus_url: http://robusta-kube-prometheus-st-prometheus:9090
49+
prometheus_url: http://<prometheus host>:9090
5050
metrics_labels_time_window_hrs: 48 # default value
5151
metrics_labels_cache_duration_hrs: 12 # default value
5252
fetch_labels_with_labels_api: false # default value
@@ -70,6 +70,18 @@ Below is the full list of options for this toolset:
7070
- **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.
7171
- **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/>`_.
7272

73+
**Finding the prometheus URL**
74+
75+
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.
76+
77+
If not, follow these steps:
78+
79+
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.
80+
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.
81+
3. Run ``kubectl describe service <service-name> -n <namespace>`` to get details about the service, including the cluster IP and port.
82+
4. Set the DNS or the cluster IP as well as the port to the configuration field ``prometheus_url`` as mentioned above.
83+
84+
7385
Capabilities
7486
------------
7587
.. include:: ./_toolset_capabilities.inc.rst

0 commit comments

Comments
 (0)