菜单
Grafana Cloud Enterprise 开源

设置 Grafana CLI

您可以通过两种方式配置 Grafana CLI:使用环境变量或通过配置文件。

  • 环境变量适用于 CI 环境,并支持单个上下文。
  • 配置文件可以管理多个上下文,从而更容易在不同的 Grafana 实例之间切换。

使用环境变量

Grafana CLI 通过其 REST API 与 Grafana 通信,这需要身份验证凭据。

至少设置您的 Grafana 实例的 URL 和组织 ID

bash
GRAFANA_SERVER='https://:3000' GRAFANA_ORG_ID='1' grafanactl config check

根据您的身份验证方法,您可能还需要设置

  • Grafana 服务账户的令牌(推荐)
  • 用于基本认证的用户名和密码

要持久化您的配置,请考虑创建一个上下文。

受支持环境变量的完整列表可在参考文档中找到。

定义上下文

上下文允许您轻松地在多个 Grafana 实例之间切换。默认情况下,CLI 使用名为 default 的上下文。

要配置 default 上下文

bash
grafanactl config set contexts.default.grafana.server https://:3000
grafanactl config set contexts.default.grafana.org-id 1

# Authenticate with a service account token
grafanactl config set contexts.default.grafana.token service-account-token

# Or use basic authentication
grafanactl config set contexts.default.grafana.user admin
grafanactl config set contexts.default.grafana.password admin

您可以通过相同方式定义其他上下文

bash
grafanactl config set contexts.staging.grafana.server https://staging.grafana.example
grafanactl config set contexts.staging.grafana.org-id 1

注意

在这些示例中,default 和 staging 是上下文的名称。

配置文件

Grafana CLI 将其配置存储在 YAML 文件中。CLI 按以下顺序确定配置文件的位置

  1. 如果提供了 --config 标志,则使用指定文件。
  2. 如果设置了 $XDG_CONFIG_HOME:$XDG_CONFIG_HOME/grafanactl/config.yaml
  3. 如果设置了 $HOME:$HOME/.config/grafanactl/config.yaml
  4. 如果设置了 $XDG_CONFIG_DIRS:$XDG_CONFIG_DIRS/grafanactl/config.yaml

注意

使用 grafanactl config check 命令显示当前使用的配置文件。

常用命令

检查当前配置

bash
grafanactl config check

注意

此命令有助于排除配置故障。

列出所有可用上下文

bash
grafanactl config list-contexts

切换到特定上下文

bash
grafanactl config use-context staging

查看完整配置

bash
grafanactl config view