菜单
文档面包屑箭头 Grafana 文档面包屑箭头 Grafana 服务器 CLI
Enterprise 开源

Grafana 服务器 CLI

Grafana 服务器 CLI 是一个与 Grafana 服务器捆绑在一起的小型可执行文件。您可以在 Grafana 服务器运行的同一台机器上运行它。Grafana 服务器 CLI 具有 `plugins` 和 `admin` 命令,以及全局选项。

列出所有命令和选项

grafana cli -h

运行 Grafana 服务器 CLI

要运行 Grafana 服务器 CLI,请将 Grafana 二进制文件的路径添加到您的 `PATH` 环境变量中。或者,如果您的当前目录是 `bin` 目录,请运行 `./grafana cli`。否则,您可以指定二进制文件的完整路径。例如,在 Linux 上是 `/usr/share/grafana/bin/grafana`,在 Windows 上是 `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe`,并使用 `grafana cli` 运行它。

注意

某些命令(例如安装或移除插件)在 Linux 上需要 `sudo`。如果您在 Windows 上,请以管理员身份运行 Windows PowerShell。

Grafana CLI 命令语法

Grafana 服务器 CLI 中命令的通用语法是

bash
grafana cli [global options] command [command options] [arguments...]

全局选项

Grafana 服务器 CLI 允许您临时覆盖某些 Grafana 默认设置。除了 `--help` 和 `--version`,大多数全局选项仅供开发者使用。

每个全局选项仅适用于使用它的命令。例如,`--pluginsDir value` 不会永久更改 Grafana 保存插件的位置。它仅更改您应用该选项的命令中的位置。

显示 Grafana 服务器 CLI 帮助

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

示例

bash
grafana cli -h

显示 Grafana 服务器 CLI 版本

`--version` 或 `-v` 打印当前运行的 Grafana 服务器 CLI 版本。

示例

bash
grafana cli -v

覆盖默认插件目录

`--pluginsDir value` 覆盖本地 Grafana 实例存储插件的路径。如果您想在默认目录(“/var/lib/grafana/plugins”)[$GF_PLUGIN_DIR] 之外的其他位置安装、更新或移除插件,请使用此选项。

示例

bash
grafana cli --pluginsDir "/var/lib/grafana/devplugins" plugins install <plugin-id>

覆盖默认插件仓库 URL

`--repo value` 允许您从非默认 Grafana 仓库下载、安装或更新插件。

示例

bash
grafana cli --repo "https://example.com/plugins" plugins install <plugin-id>

覆盖默认插件 .zip URL

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

示例

bash
grafana cli --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>

覆盖传输层安全

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

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

示例

bash
grafana cli --insecure --pluginUrl https://company.com/grafana/plugins/<plugin-id>-<plugin-version>.zip plugins install <plugin-id>

启用调试日志记录

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

示例

bash
grafana cli --debug plugins install <plugin-id>

覆盖配置设置

`--configOverrides` 是一个命令行参数,其作用类似于环境变量覆盖。

例如,您可以使用它将日志记录重定向到另一个文件(也许是为了在 Grafana Cloud 中记录插件安装),或者在重置 admin 密码时,如果您对一些重要的配置值(例如数据库位置)使用了非默认值,也可以使用它。

示例

bash
grafana cli --configOverrides cfg:default.paths.log=/dev/null plugins install <plugin-id>

覆盖 homepath 值

设置 Grafana 安装/home 路径,默认为工作目录。如果您在使用 CLI 时已经在 Grafana 安装目录下,则无需使用此选项。

示例

bash
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>

覆盖配置文件

`--config value` 覆盖 Grafana 期望配置文件的默认位置。有关配置 Grafana 和默认配置文件位置的更多信息,请参阅配置

示例

bash
grafana cli --config "/etc/configuration/" admin reset-admin-password mynewpassword

插件命令

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

所有列出的命令都适用于 Grafana 的默认仓库和目录。您可以使用全局选项覆盖默认设置。

列出可用插件

bash
grafana cli plugins list-remote

安装插件的最新版本

bash
grafana cli plugins install <plugin-id>

安装插件的特定版本

bash
grafana cli plugins install <plugin-id> <version>

列出已安装插件

bash
grafana cli plugins ls

更新所有已安装插件

bash
grafana cli plugins update-all

更新单个插件

bash
grafana cli plugins update <plugin-id>

移除单个插件

bash
grafana cli plugins remove <plugin-id>

Admin 命令

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

显示所有 admin 命令

bash
grafana cli admin

重置 admin 密码

`grafana cli admin reset-admin-password ` 使用 CLI 重置 admin 用户的密码。如果您丢失了 admin 密码,可能需要这样做。默认情况下,此命令使用 admin 用户的默认 ID,即 1。如果您知道 admin 用户的 ID,可以使用 `--user-id` 标志指定用户 ID。如果未指定 `--user-id` 标志且命令无法找到 admin 用户,它将返回当前 admin 用户的用户名和 ID 列表。您可以从该列表中确定 admin 用户的 ID,并再次使用 `--user-id` 标志运行命令。

如果使用了两个标志来设置 homepath 和配置文件路径,则运行命令会返回此错误

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

要纠正此问题,请使用 `--homepath` 全局选项为该命令指定 Grafana 默认 homepath

bash
grafana cli --homepath "/usr/share/grafana" admin reset-admin-password <new password>

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

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

重置 admin 密码

如果您使用 Homebrew 安装了 Grafana,可以使用以下命令重置 admin 密码

bash
/opt/homebrew/opt/grafana/bin/grafana cli --config /opt/homebrew/etc/grafana/grafana.ini --homepath /opt/homebrew/opt/grafana/share/grafana --configOverrides cfg:default.paths.data=/opt/homebrew/var/lib/grafana admin reset-admin-password <new password>

迁移数据并加密密码

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

`encrypt-datasource-passwords` 将密码从未加密字段迁移到 secure_json_data 字段。除非发生错误,否则返回 `ok`。可安全地多次执行。

示例

bash
grafana cli admin data-migration encrypt-datasource-passwords