Skip to content

Commit 2304a4b

Browse files
committed
doc: update prometheus docs, add holmes CLI config
1 parent 70afbc6 commit 2304a4b

1 file changed

Lines changed: 27 additions & 15 deletions

File tree

docs/configuration/holmesgpt/toolsets/prometheus.rst

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,40 @@ validate prometheus queries.
66

77
There is also an option for Holmes to analyze prometheus metrics. When enabled, HolmesGPT can detect memory leak patterns,
88
CPU throttling, high latency for your APIs, etc. The configuration field to enable prometheus metrics analysis is
9-
`tool_calls_return_data`.
9+
``tool_calls_return_data``.
1010

1111
Configuration
1212
-------------
1313

14+
.. md-tab-set::
1415

15-
.. code-block:: yaml
16+
.. md-tab-item:: Robusta Helm Chat
1617

17-
holmes:
18-
toolsets:
19-
prometheus/metrics:
20-
enabled: true
21-
config:
22-
prometheus_url: http://robusta-kube-prometheus-st-prometheus.default.svc.cluster.local:9090
18+
.. code-block:: yaml
2319
20+
holmes:
21+
toolsets:
22+
prometheus/metrics:
23+
enabled: true
24+
config:
25+
prometheus_url: ...
26+
metrics_labels_time_window_hrs: 48 # default value
27+
metrics_labels_cache_duration_hrs: 12 # default value
28+
fetch_labels_with_labels_api: false # default value
29+
fetch_metadata_with_series_api: false # default value
30+
tool_calls_return_data: false # default value
31+
headers:
32+
Authorization: "Basic <base_64_encoded_string>"
2433
25-
It is also possible to set the ``PROMETHEUS_URL`` environment variable instead of the above ``prometheus_url`` config key.
2634
27-
.. include:: ./_toolset_configuration.inc.rst
35+
.. include:: ./_toolset_configuration.inc.rst
2836

29-
Prior to generating a PromQL query, HolmesQPT tends to list the available metrics. This is done to ensure the metrics used
30-
in PromQL are actually available.
37+
.. md-tab-item:: Holmes CLI
3138

32-
Below is the full list of options for this toolset:
39+
Add the following to **~/.holmes/config.yaml**, creating the file if it doesn't exist:
3340

34-
.. code-block:: yaml
41+
.. code-block:: yaml
3542
36-
holmes:
3743
toolsets:
3844
prometheus/metrics:
3945
enabled: true
@@ -47,6 +53,12 @@ Below is the full list of options for this toolset:
4753
headers:
4854
Authorization: "Basic <base_64_encoded_string>"
4955
56+
It is also possible to set the ``PROMETHEUS_URL`` environment variable instead of the above ``prometheus_url`` config key.
57+
58+
Prior to generating a PromQL query, HolmesQPT tends to list the available metrics. This is done to ensure the metrics used
59+
in PromQL are actually available.
60+
61+
Below is the full list of options for this toolset:
5062

5163
- **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.
5264
- **metrics_labels_cache_duration_hrs** How long are labels cached, in hours. Set it to ``null`` to disable caching.

0 commit comments

Comments
 (0)