grafana-wtf 0.16.0

grafana-wtf find

grafana-wtf log

Install grafana-wtf

pip install grafana-wtf

Configure Grafana

Please take these steps to create an API key with your Grafana instance:

• Go to https://daq.example.org/grafana/org/apikeys.

• Choose “New API Key”.

  • Key name: grafana-wtf

  • Role: Admin

• From the output curl -H "Authorization: Bearer eyJrIjoiWHg...dGJpZCI6MX0=" ..., please take note of the Bearer token. This is your Grafana API key.

Grafana connection

To configure to which Grafana instance to connect to, and how to authenticate, use the --grafana-url and --grafana-token command line options.

Alternatively, before running grafana-wtf, you can define URL and access token of your Grafana instance by using environment variables:

export GRAFANA_URL=https://daq.example.org/grafana/
export GRAFANA_TOKEN=eyJrIjoiWHg...dGJpZCI6MX0=

In order to accept untrusted SSL certificates, append the ?verify=no query string to the GRAFANA_URL:

export GRAFANA_URL=https://daq.example.org/grafana/?verify=no

Caching

grafana-wtf will cache HTTP responses for 300 seconds by default, in order to save resources, by not hitting the server each server. You can configure that setting by using the --cache-ttl option, or the CACHE_TTL environment variable.

When invoking the program with the --drop-cache option, it will drop its cache upfront.

General information

# Display a bunch of meta information and statistics.
grafana-wtf info --format=yaml

# Display Grafana version.
grafana-wtf info --format=json | jq -r '.grafana.version'

Explore data sources

How to find unused data sources?

# Display all data sources and the dashboards using them, as well as unused data sources.
grafana-wtf explore datasources --format=yaml

# Display names of unused datasources as a flat list.
grafana-wtf explore datasources --format=json | jq -r '.unused[].datasource.name'

Explore dashboards

How to find dashboards which use non-existing data sources?

# Display some details of all dashboards, including names of missing data sources.
grafana-wtf explore dashboards --format=yaml

# Display only dashboards which have missing data sources, along with their names.
grafana-wtf explore dashboards --format=json | \
    jq '.[] | select( .datasources_missing ) | .dashboard + {ds_missing: .datasources_missing[] | [.name]}'

How to list all queries used in all dashboards?

grafana-wtf explore dashboards --data-details --format=json | \
    jq -r '.[].details | values[] | .[].query // "null"'

Searching for strings

Find the string weatherbase throughout all dashboards and data sources:

grafana-wtf find weatherbase

Replacing strings

Replace all occurrences of ldi_v2 with ldi_v3 within dashboard with UID _JJ22OZZk:

grafana-wtf --select-dashboard=_JJ22OZZk replace ldi_v2 ldi_v3

In order to preview the changes, you should use the --dry-run option beforehand:

grafana-wtf --select-dashboard=_JJ22OZZk replace ldi_v2 ldi_v3 --dry-run

Display edit history

Watching out for recent editing activity on any dashboards?

# Display 50 most recent changes across all dashboards.
grafana-wtf log --number=50