You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is also possible to set the ``PROMETHEUS_URL`` environment variable instead of the above ``prometheus_url`` config key.
21
26
22
27
.. include:: ./_toolset_configuration.inc.rst
23
28
24
29
Prior to generating a PromQL query, HolmesQPT tends to list the available metrics. This is done to ensure the metrics used
25
-
in PromQL are actually available. The result of the request to fetch the labels available for each metric is cached. The
26
-
request and the caching behaviour (TTL) can be tweaked:
30
+
in PromQL are actually available.
31
+
32
+
Below is the full list of options for this toolset:
27
33
28
34
.. code-block:: yaml
29
35
30
36
holmes:
31
37
toolsets:
32
-
opensearch/status:
38
+
prometheus/metrics:
33
39
enabled: true
34
40
config:
35
41
prometheus_url: ...
36
42
metrics_labels_time_window_hrs: 48# default value
37
43
metrics_labels_cache_duration_hrs: 12# default value
44
+
fetch_labels_with_labels_api: false # default value
45
+
fetch_metadata_with_series_api: false # default value
46
+
tool_calls_return_data: false # default value
47
+
headers:
48
+
Authorization: "Basic <base_64_encoded_string>"
38
49
39
50
40
51
- **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.
41
52
- **metrics_labels_cache_duration_hrs** How long are labels cached, in hours. Set it to ``null`` to disable caching.
53
+
- **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.
54
+
- **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.).
55
+
- **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.
56
+
- **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/>`_.
0 commit comments