GrafanaのCLIツールを改めてまとめる 2025年
GrafanaのCLIツールを改めてまとめる 2025年
Grafanaに、データソースやパネルなど、任意のプラグインをインストールする際にお世話になるのが、Grafana Server CLIです。
私は、2021年ごろにGrafanaを初めて触って、Zabbixのプラグインをgrafana cliを使ってインストールした思い出があります。
GrafanaのCLI周りも、歴史が積み重なって変化を遂げたようなので、まとめて行きたいと思います。
grafana-cli※削除予定
Grafanaをにインストールした際に、付属でインストールされる小さな実行バイナリです。
削除予定なのは、検証しているなかで初めて知りました。将来的にこのバイナリは削除され、後述のgrafanaのcliコマンドに統合されるようです。
grafana-cliでできることは、Grafanaプラグインの管理と、adminパスワードリセットなどのGrafanaのシステム管理と、小さく限定されています。
詳細は、次々項grafanaのcliコマンドで説明します。
grafana
ツール、実行バイナリとしてのgrafanaです。
grafana-cliの移行先として、grafanaバイナリのcliコマンドが案内されます。
Deprecation warning: The standalone 'grafana-cli' program is deprecated and will be removed in the future. Please update all uses of 'grafana-cli' to 'grafana cli'
grafanaのバイナリ自体は、cliとserverコマンドが具備されていることが、ヘルプからわかります。
/usr/share/grafana $ grafana -h
NAME:
grafana - Grafana server and command line interface
USAGE:
grafana [global options] command [command options]
VERSION:
12.3.1
AUTHOR:
Grafana Project <hello@grafana.com>
COMMANDS:
cli run the grafana cli
server run the grafana server
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
grafana cli
grafana-cliの移行先である、実行バイナリとしてのgrafanaのcliコマンドです。(混乱してきた...)
/usr/share/grafana $ grafana cli -h
NAME:
grafana cli - run the grafana cli
USAGE:
grafana cli [command options]
COMMANDS:
plugins Manage plugins for grafana
admin Grafana admin commands
help, h Shows a list of commands or help for one command
grafana cliのplugins
Grafanaのプラグインを、インストール、削除するといった、プラグイン管理ができます。筆者はよく、grafana cli plugins lsをして、プラグインが正常に読み込めてるかを確認します。
/usr/share/grafana $ grafana cli plugins -h
NAME:
grafana cli plugins - Manage plugins for grafana
USAGE:
grafana cli plugins [command options]
COMMANDS:
install install <plugin id> <plugin version (optional)>
list-remote list remote available plugins
list-versions list-versions <plugin id>
update, upgrade update <plugin id>
update-all, upgrade-all update all your installed plugins
ls list installed plugins (excludes core plugins)
uninstall, remove uninstall <plugin id>
help, h Shows a list of commands or help for one command
grafana cliのadmin
Grafanaそのものの、システム管理コマンドです。Grafanaを初期構築した際のadminのパスワードをリセットしたり、GrafanaのDBマイグレなんかもできるんですね。
/usr/share/grafana $ grafana cli admin -h
NAME:
grafana cli admin - Grafana admin commands
USAGE:
grafana cli admin [command options]
COMMANDS:
reset-admin-password reset-admin-password <new password>
data-migration Runs a script that migrates or cleanups data in your database
secrets-migration Runs a script that migrates secrets in your database
secrets-consolidation Runs an operation that re-encrypts all encrypted values in your database with new data keys
help, h Shows a list of commands or help for one command
grafanactl
ここで、詳細調べきれておらず、概要までとなります。
Grafanaのドキュメントだけ読む限り、Observability as codeとして、ダッシュボードやデータソースなど、複雑化していくリソースについて、プログラム的にスケールするための戦略・思想が掲げられたと読み取れます。
GrafanaのObservability as codeを実践するためのツールとして、Git Sync、Foundation SDK、そしてGrafana CLI(grafanactl)があのですね。
まとめ
grafana-cliが統合される件は、ブログを書いて初めて知り、grafanactlまで存在するところまで発見できました。歴史の積み重ねを実感しました。どこかで精緻したいと思います。
参考
実行環境
- Grafanaのコンテナイメージに、grafana-cliもあるので、当環境で確認しています
- 取得手順:
docker run -d -p 3000:3000 --name=grafana grafana/grafana
Discussion