Grafana CLI 命令行工具完全指南

Grafana CLI 命令行工具完全指南

grafana The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more. 项目地址: https://gitcode.com/gh_mirrors/gr/grafana

概述

Grafana CLI 是 Grafana 服务器附带的一个小型可执行工具，运行在与 Grafana 服务器相同的机器上。它为管理员提供了通过命令行管理 Grafana 实例的能力，包括插件管理和系统管理功能。本文将全面介绍 Grafana CLI 的使用方法、命令语法和实用技巧。

运行环境准备

要使用 Grafana CLI，您需要确保：

1. 已将 Grafana 的二进制文件路径添加到系统的 PATH 环境变量中
2. 或者可以直接在 Grafana 的 bin 目录下执行 ./grafana cli
3. 也可以指定完整的二进制文件路径执行

权限说明：

• 在 Linux 系统上，某些命令（如插件安装/卸载）需要 sudo 权限
• 在 Windows 系统上，需要以管理员身份运行 PowerShell

命令语法结构

Grafana CLI 的基本命令格式如下：

grafana cli [全局选项] 命令 [命令选项] [参数...]

全局选项详解

全局选项允许您临时覆盖 Grafana 的默认配置，这些设置仅对当前执行的命令有效。

常用全局选项

1. 帮助信息 (-h/--help)

   grafana cli -h
   

   显示所有可用命令和默认路径信息

2. 版本信息 (-v/--version)

   grafana cli -v
   

   显示当前 Grafana CLI 版本

3. 插件目录覆盖 (--pluginsDir)

   grafana cli --pluginsDir "/custom/plugins/path" plugins install <plugin-id>
   

   临时指定插件安装目录

4. 插件仓库覆盖 (--repo)

   grafana cli --repo "https://custom.repo/plugins" plugins install <plugin-id>
   

   从非默认仓库安装插件

5. 调试模式 (--debug)

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

   启用详细日志输出

高级全局选项

1. 配置覆盖 (--configOverrides)

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

   临时修改配置参数

2. Homepath 覆盖 (--homepath)

   grafana cli --homepath "/usr/share/grafana" admin reset-admin-password newpass
   

   指定 Grafana 安装目录

3. 配置文件覆盖 (--config)

   grafana cli --config "/etc/grafana/custom.ini" admin reset-admin-password newpass
   

   使用指定的配置文件

插件管理命令

Grafana CLI 提供了完整的插件生命周期管理功能。

插件查询

1. 列出所有可用插件：

   grafana cli plugins list-remote
   

2. 列出已安装插件：

   grafana cli plugins ls
   

插件安装

1. 安装最新版本插件：

   grafana cli plugins install <plugin-id>
   

2. 安装指定版本插件：

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

插件更新

1. 更新所有插件：

   grafana cli plugins update-all
   

2. 更新单个插件：

   grafana cli plugins update <plugin-id>
   

插件卸载

grafana cli plugins remove <plugin-id>

系统管理命令

这些命令适用于 Grafana 4.1 及以上版本。

管理员密码重置

grafana cli admin reset-admin-password <新密码>

注意事项：

• 默认操作 admin 用户 (ID=1)
• 如果 admin 用户 ID 不是 1，需要使用 --user-id 参数
• 可能需要指定 --homepath 参数

数据迁移与加密

1. 加密数据源密码：

   grafana cli admin data-migration encrypt-datasource-passwords
   

   将密码从非安全字段迁移到 secure_json_data 字段

最佳实践建议

1. 插件管理：

   • 定期使用 update-all 命令保持插件最新
   • 在生产环境安装插件前，先在测试环境验证

2. 密码重置：

   • 优先通过 UI 界面修改密码
   • 仅在忘记密码时使用 CLI 重置
   • 重置后立即修改为复杂密码

3. 安全建议：

   • 避免使用 --insecure 选项
   • 谨慎使用全局配置覆盖
   • 确保插件来源可信

常见问题解决

1. 插件安装失败：

   • 检查网络连接
   • 验证插件 ID 是否正确
   • 确保有足够的目录权限

2. 密码重置无效：

   • 确认使用了正确的 --homepath 参数
   • 检查配置文件路径是否正确
   • 验证数据库连接配置

3. 命令执行报错：

   • 添加 --debug 选项查看详细错误
   • 检查 Grafana 服务是否已停止

通过掌握 Grafana CLI 的这些功能和技巧，您可以更高效地管理 Grafana 实例，特别是在自动化部署和批量管理场景中，CLI 工具将大大提升您的工作效率。

grafana The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more. 项目地址: https://gitcode.com/gh_mirrors/gr/grafana