这是存档文档v9.0.去最新版本

;Grafana CLI

Grafana CLI

Grafana CLI是一个与Grafana服务器绑定的小型可执行文件。它可以在运行Grafana服务器的同一台机器上执行。Grafana CLI有插件而且管理命令,以及全局选项。

查询所有命令和选项。

grafana-cli - h

调用Grafana CLI

要调用Grafana CLI,请在文件中添加Grafana二进制文件的路径路径环境变量。或者,如果您的当前目录是箱子目录,使用。/ grafana-cli.否则,可以指定CLI的全路径。例如,在Linux上/usr/share/grafana/bin/grafana-cli在Windows上C:\Program Files\ GrafanaLabs \ grafana \ bin \ grafana-cli.exe

注意:一些命令,如安装或删除插件,需要sudo在Linux上。如果您使用的是Windows系统,请以管理员身份运行Windows PowerShell。

Grafana CLI命令语法

Grafana CLI命令的通用语法是:

Grafana-cli[全局选项]command[命令选项][参数…]

全局选项

Grafana CLI允许您临时覆盖某些Grafana默认设置。除了——帮助而且——版本,大多数全局选项仅供开发人员使用。

每个全局选项只应用于使用它的命令。例如,——pluginsDir价值不会永久改变Grafana保存插件的位置。它只会为应用该选项的命令更改它。

显示Grafana CLI帮助

——帮助- h显示帮助,包括默认路径和Docker配置信息。

例子:

grafana-cli - h

显示Grafana CLI版本

——版本- v打印当前运行的Grafana CLI的版本。

例子:

grafana-cli - v

覆盖默认插件目录

——pluginsDir价值覆盖本地Grafana实例存储插件的路径。如果你想在默认目录("/var/lib/grafana/plugins") [$GF_PLUGIN_DIR]之外的地方安装、更新或删除插件,请使用此选项。

例子:

grafana-cli——pluginsDir "/var/lib/grafana/devplugins" plugins install 

覆盖默认插件repo URL

——回购价值除了默认的Grafana repo,允许你从其他存储库下载、安装或更新插件。

例子:

Grafana-cli——repo "https://example.com/plugins" plugins install 

覆盖默认插件.zip URL

——pluginUrl价值允许您从本地URL下载包含插件的.zip文件,而不是从默认的Grafana源下载。

例子:

grafana-cli——pluginUrl https://company.com/grafana/plugins/-.zip plugins install  .zip

覆盖传输层安全性

警告:关闭TLS是一个重大的安全风险。我们不建议使用此选项。

——不安全允许您关闭传输层安全(TLS)验证(不安全)。如果你从非默认源下载插件,你可能需要这样做。

例子:

grafana-cli——insecure——pluginUrl https://company.com/grafana/plugins/-.zip plugins install  .zip

启用调试日志记录

——调试- d启用调试日志记录。调试输出返回并显示在终端中。

例子:

Grafana-cli——debug plugins install 

重写配置设置

——configOverrides是一个命令行参数,其作用类似于环境变量重写。

例如,您可以使用它将日志重定向到另一个文件(可能是Grafana Cloud中的日志插件安装),或者在重置管理员密码时使用一些重要配置值(如数据库所在位置)的非默认值。

例子:

grafana-cli——configOverrides cfg:default.paths.log=/dev/null plugins install  .log

覆盖主路径值

设置Grafana安装/home路径,默认为工作目录。如果使用命令行操作时在Grafana安装目录下,则不需要使用此选项。

例子:

grafana-cli——homeepath "/usr/share/grafana" admin reset-admin-password <新密码>

覆盖配置文件

——配置值重写Grafana期望配置文件的默认位置。指配置有关配置Grafana和默认配置文件位置的更多信息。

例子:

Grafana-cli——config "/etc/configuration/" admin reset-admin-password mynewpassword

插件命令

Grafana CLI允许您安装、升级和管理您的Grafana插件。有关安装插件的更多信息,请参阅插件页面

所有列出的命令都适用于Grafana默认存储库和目录。您可以使用全局选项

列出可用的插件

Grafana-cli plugins list-remote

安装插件的最新版本

Grafana-cli plugins install 

安装插件的特定版本

Grafana-cli plugins install  

已安装插件列表

Grafana-cli plugins ls

更新所有已安装的插件

Grafana-cli插件更新全部

更新一个插件

Grafana-cli plugins update 

移除一个插件

移除

管理命令

管理命令仅在Grafana 4.1及更高版本中可用。

显示所有管理命令

grafana-cli管理

重置admin密码

Grafana-cli admin reset-admin-password <新密码>使用实例通过CLI重置admin用户密码。如果您丢失了管理密码,您可能需要这样做。

如果有两个标志被用来设置主路径和配置文件路径,那么运行该命令将返回以下错误:

找不到配置默认值,请确保home路径命令行参数已设置或工作目录是home路径

要纠正此错误,请使用——homepathglobal选项用于指定Grafana的默认路径:

grafana-cli——homeepath "/usr/share/grafana" admin reset-admin-password <新密码>

如果您没有丢失管理员密码,我们建议您在“用户首选项”或“服务器管理员>用户”选项卡中更改用户密码。

如果需要在脚本中设置密码,则可以使用Grafana用户API

数据迁移和密码加密

数据迁移运行一个脚本,用于迁移或清理数据库中的数据。

encrypt-datasource-passwords将密码从不安全字段迁移到secure_json_data字段。返回好吧除非出现错误。可以安全执行多次。

例子:

Grafana-cli admin data-migration encrypt-datasource-passwords