Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Grafana toolset docs #1737

Merged
merged 2 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/configuration/holmesgpt/toolsets/grafana.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ from your Grafana instance.
enabled: true
config:
api_key: <your grafana API key>
url: https://grafana-url
url: https://xxxxxxx.grafana.net # Your Grafana cloud account URL

You can optionally tweak the search terms used by the toolset. This is only needed if your Loki logs settings for pod,
namespace and node differ from the defaults listed below. To do so, add these search keys to the configuration:
Expand All @@ -36,7 +36,7 @@ namespace and node differ from the defaults listed below. To do so, add these se
enabled: true
config:
api_key: <your grafana API key>
url: https://grafana-url
url: https://xxxxxxx.grafana.net # Your Grafana cloud account URL
pod_name_search_key: "pod"
namespace_search_key: "namespace"
node_name_search_key: "node"
Expand Down Expand Up @@ -86,7 +86,7 @@ your Grafana instance.
enabled: true
config:
api_key: <your grafana API key>
url: https://grafana-url
url: https://xxxxxxx.grafana.net # Your Grafana cloud account URL

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

Expand All @@ -106,3 +106,13 @@ Capabilities
- Lists Tempo traces ids that exceed a specified minimum duration in a given time range
* - fetch_tempo_trace_by_id
- Retrieves detailed information about a Tempo trace using its trace ID. Use this to investigate a trace.


Getting Grafana URL
-----------------------

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

.. image:: /images/grafana-url-for-holmes.png
:width: 600
:align: center
2 changes: 1 addition & 1 deletion docs/configuration/holmesgpt/toolsets/slab.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Slab
====

By enabling this toolset, HolmesGPT will be able to consult runbooks from Slab pages.
Retrieve your Slab `API token <https://help.slab.com/en/articles/6545629-developer-tools-api-webhooks>`_ prior to configuring this toolset.
Retrieve your Slab `API token <https://help.slab.com/en/articles/6545629-developer-tools-api-webhooks>`_ prior to configuring this toolset. Do note that Slab API is only available for Slab premium users. See `here <https://help.slab.com/en/articles/6545629-developer-tools-api-webhooks>`_.

Configuration
-------------
Expand Down
Binary file added docs/images/grafana-url-for-holmes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading