Grafana Dashboards¶
Connect HolmesGPT to Grafana for dashboard analysis, query extraction, and understanding your monitoring setup. This integration enables investigation of dashboard configurations and extraction of Prometheus queries for deeper analysis.
Prerequisites¶
A Grafana service account token with the following permissions:
- Basic role → Viewer
Configuration¶
Add the following to ~/.holmes/config.yaml. Create the file if it doesn't exist:
toolsets:
grafana/dashboards:
enabled: true
config:
api_key: <your grafana service account token>
url: <your grafana url> # e.g. https://acme-corp.grafana.net or http://localhost:3000
# Optional: Additional headers for all requests
# headers:
# X-Custom-Header: "custom-value"
After making changes to your configuration, run:
To test, run:
Capabilities¶
| Tool Name | Description |
|---|---|
| grafana_search_dashboards | Search for dashboards and folders by query, tags, UIDs, or folder locations |
| grafana_get_dashboard_by_uid | Retrieve complete dashboard JSON including all panels and queries |
| grafana_get_home_dashboard | Get the home dashboard configuration |
| grafana_get_dashboard_tags | List all tags used across dashboards for categorization |
Advanced Configuration¶
SSL Verification¶
For self-signed certificates, you can disable SSL verification:
toolsets:
grafana/dashboards:
enabled: true
config:
url: https://grafana.internal
api_key: <your api key>
verify_ssl: false # Disable SSL verification (default: true)
External URL¶
If HolmesGPT accesses Grafana through an internal URL but you want clickable links in results to use a different URL:
toolsets:
grafana/dashboards:
enabled: true
config:
url: http://grafana.internal:3000 # Internal URL for API calls
external_url: https://grafana.example.com # URL for links in results
api_key: <your api key>
How it Works¶
Dashboard Query Extraction¶
When HolmesGPT retrieves a dashboard, it can extract and analyze Prometheus queries from dashboard panels. This is particularly useful for:
- Understanding what metrics a dashboard monitors
- Extracting queries for further investigation with the Prometheus toolset
- Analyzing dashboard time ranges and variable usage
Example Usage¶
Finding dashboards by tag:
Analyzing a specific dashboard:
Extracting queries for investigation: