Skip to content

Commit 0577e2f

Browse files
committed
doc: add new config for tempo Holmes toolset
1 parent 132d02c commit 0577e2f

1 file changed

Lines changed: 30 additions & 10 deletions

File tree

docs/configuration/holmesgpt/toolsets/grafanatempo.rst

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Check out this `video <https://www.loom.com/share/f969ab3af509444693802254ab0407
1818
Getting Grafana URL
1919
-----------------------
2020

21-
You can find the Grafana URL required for Loki and Tempo in your Grafana cloud account settings.
21+
You can find the Grafana URL required for Loki and Tempo in your Grafana cloud account settings.
2222

2323
.. image:: /images/grafana-url-for-holmes.png
2424
:width: 600
@@ -39,7 +39,15 @@ Configuration
3939
enabled: true
4040
config:
4141
api_key: <your grafana API key>
42-
url: https://grafana-url
42+
url: <your grafana url> # e.g. https://acme-corp.grafana.net
43+
grafana_datasource_uid: <the UID of the loki data source in Grafana>
44+
labels:
45+
pod: "k8s.pod.name"
46+
namespace: "k8s.namespace.name"
47+
deployment: "k8s.deployment.name"
48+
node: "k8s.node.name"
49+
service: "service.name"
50+
4351
4452
.. include:: ./_toolset_configuration.inc.rst
4553

@@ -54,14 +62,27 @@ Configuration
5462
enabled: true
5563
config:
5664
api_key: <your grafana service account token>
57-
url: <your grafana url> # e.g. https://acme-corp.grafana.net
65+
url: <your grafana url> # e.g. https://acme-corp.grafana.net
66+
grafana_datasource_uid: <the UID of the loki data source in Grafana>
67+
labels:
68+
pod: "k8s.pod.name"
69+
namespace: "k8s.namespace.name"
70+
deployment: "k8s.deployment.name"
71+
node: "k8s.node.name"
72+
service: "service.name"
5873
59-
To test, run:
74+
To test, run:
6075

6176
.. code-block:: yaml
62-
77+
6378
holmes ask "The payments DB is very slow, check tempo for any trace data"
6479
80+
**Search labels**
81+
82+
You can tweak the labels used by the toolset to identify kubernetes resources. This is only needed if the trace
83+
labels differ from the defaults in the example above.
84+
85+
6586
Capabilities
6687
^^^^^^^^^^^^
6788
.. include:: ./_toolset_capabilities.inc.rst
@@ -72,10 +93,9 @@ Capabilities
7293

7394
* - Tool Name
7495
- Description
75-
* - list_all_datasources
76-
- Fetches All the data sources in Grafana
77-
* - fetch_tempo_traces_by_min_duration
78-
- Lists Tempo traces ids that exceed a specified minimum duration in a given time range
96+
* - fetch_tempo_tags
97+
- List the tags available in Tempo
98+
* - fetch_tempo_traces
99+
- Lists Tempo traces. At least one of `service_name`, `pod_name` or `deployment_name` argument is required.
79100
* - fetch_tempo_trace_by_id
80101
- Retrieves detailed information about a Tempo trace using its trace ID. Use this to investigate a trace.
81-

0 commit comments

Comments
 (0)