grafana-cli

What it does

How to write it

grafana cli [--homepath DIR] plugins|admin COMMAND
curl -H "Authorization: Bearer TOKEN" http://HOST:3000/api/...

Main parts

CLI commands

plugins install NAME [VERSION]

Install a plugin.

plugins ls / update-all / remove NAME

Manage plugins.

admin reset-admin-password PASS

Reset the admin password.

admin data-migration encrypt-datasource-passwords

Encrypt old data source passwords.

Most used

Nothing matches this filter.

$ run as a normal user# run as root (or with sudo)

1. 1Install on RHEL

   #cat /etc/yum.repos.d/grafana.repo
   [grafana]
   baseurl=https://rpm.grafana.com
   gpgcheck=1
   gpgkey=https://rpm.grafana.com/gpg.key
   #dnf install -y grafana
   #systemctl enable --now grafana-server

2. 2Run in a container

   $podman run -d --name grafana -p 3000:3000 -e GF_SECURITY_ADMIN_PASSWORD__FILE=/run/secrets/grafana_admin -v grafana-data:/var/lib/grafana docker.io/grafana/grafana:11.3.0

3. 3Provision a Prometheus data source from a file

   #cat /etc/grafana/provisioning/datasources/prometheus.yml
   apiVersion: 1
   datasources:
     - name: Prometheus
       type: prometheus
       url: http://localhost:9090
       isDefault: true

4. 4Provision dashboards from a folder in Git

   #cat /etc/grafana/provisioning/dashboards/default.yml
   apiVersion: 1
   providers:
     - name: default
       folder: Infra
       options: { path: /var/lib/grafana/dashboards }

5. 5Install a plugin

   #grafana cli plugins install grafana-piechart-panel
   #systemctl restart grafana-server

6. 6Reset the admin password

   #grafana cli admin reset-admin-password 'N3w-Strong-Pass!'

7. 7Use the HTTP API with a service account token

   $export GRAFANA_TOKEN=glsa_exampletokenonly_0000000000000000
   $curl -s -H "Authorization: Bearer $GRAFANA_TOKEN" http://localhost:3000/api/search?query=node | jq '.[].title'

8. 8Export a dashboard to JSON for Git

   $curl -s -H "Authorization: Bearer $GRAFANA_TOKEN" http://localhost:3000/api/dashboards/uid/rYdddlPWk | jq '.dashboard' > dashboards/node.json

9. 9Check health

   $curl -s http://localhost:3000/api/health

10. 10Turn on SSO with Keycloak

    #cat /etc/grafana/grafana.ini
    [auth.generic_oauth]
    enabled = true
    name = Keycloak
    client_id = grafana
    client_secret = $__file{/etc/grafana/oauth_secret}
    auth_url = https://sso.lab.local/realms/lab/protocol/openid-connect/auth
    token_url = https://sso.lab.local/realms/lab/protocol/openid-connect/token
    api_url = https://sso.lab.local/realms/lab/protocol/openid-connect/userinfo

11. 11Read the logs

    #journalctl -u grafana-server -n 50

Nothing matches this filter.

Files

/etc/grafana/grafana.ini

Main settings.

/etc/grafana/provisioning/

Data sources, dashboards, alerting as files.

/var/lib/grafana/

Database (grafana.db) and plugins.

/var/log/grafana/

Logs.

Exit codes