Skip to content

Commit

Permalink
doc: update Prometheus troolset docs to reflect new features
Browse files Browse the repository at this point in the history
  • Loading branch information
nherment committed Mar 11, 2025
1 parent 5cbc5e2 commit a6c5f5b
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions docs/configuration/holmesgpt/toolsets/prometheus.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
Prometheus
==========

By enabling this toolset, HolmesGPT will be able to analyze prometheus metrics and generate graphs from these metrics.
This gives HolmesGPT the ability to detect memory leak patterns, CPU throttling, high latency for your APIs, etc.
By enabling this toolset, HolmesGPT will be able to generate graphs from prometheus metrics as well as help you write and
validate prometheus queries.

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

Configuration
-------------
Expand All @@ -12,33 +16,44 @@ Configuration
holmes:
toolsets:
opensearch/status:
prometheus/metrics:
enabled: true
config:
prometheus_url: http://robusta-kube-prometheus-st-prometheus.default.svc.cluster.local:9090
It is also possible to set the ``PROMETHEUS_URL`` environment variable instead of the above ``prometheus_url`` config key.

.. include:: ./_toolset_configuration.inc.rst

Prior to generating a PromQL query, HolmesQPT tends to list the available metrics. This is done to ensure the metrics used
in PromQL are actually available. The result of the request to fetch the labels available for each metric is cached. The
request and the caching behaviour (TTL) can be tweaked:
in PromQL are actually available.

Below is the full list of options for this toolset:

.. code-block:: yaml
holmes:
toolsets:
opensearch/status:
prometheus/metrics:
enabled: true
config:
prometheus_url: ...
metrics_labels_time_window_hrs: 48 # default value
metrics_labels_cache_duration_hrs: 12 # default value
fetch_labels_with_labels_api: false # default value
fetch_metadata_with_series_api: false # default value
tool_calls_return_data: false # default value
headers:
Authorization: "Basic <base_64_encoded_string>"
- **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/>`_.

Capabilities
------------
Expand Down

0 comments on commit a6c5f5b

Please sign in to comment.