菜单
文档breadcrumb arrow Grafana 文档breadcrumb arrow 可观测性即代码breadcrumb arrow 配置资源和同步仪表盘breadcrumb arrow 使用配置好的仪表盘
Enterprise Open source

使用配置好的仪表盘

注意

Git 同步和文件路径配置是 Grafana v12 开源版和企业版中引入的实验性功能。工程和随叫随到支持不可用。除了代码注释之外，文档有限或未提供。不提供 SLA。请在 Grafana 中启用 provisioning 和 kubernetesDashboards 功能开关。这些功能在 Grafana Cloud 中不可用。

使用配置功能，您可以选择将仪表盘 JSON 文件存储在 Git 同步或本地文件路径的 GitHub 仓库中。

有关更多信息，请参阅仪表盘文档。

配置方法

使用 Git 同步或本地文件路径同步的仪表盘和文件夹称为“配置好的”资源。

在两个实验性选项中，Git 同步是配置仪表盘的推荐方法。您可以将所有新的仪表盘和现有仪表盘的更改同步到配置的 GitHub 仓库。如果您在仓库中推送更改，这些更改会镜像到您的 Grafana 实例中。有关配置 Git 同步的更多信息，请参阅设置 Git 同步。

本地路径配置

使用本地路径配置可以使指定路径中的文件在 Grafana 中可用。这些配置好的资源只能在本地文件中修改，不能在 Grafana 中修改。配置的本地路径中所做的任何更改都会在 Grafana 中更新。

请参阅设置文件配置以了解有关 Grafana 12 中本地文件配置版本的信息。

注意

使用 Administration > Provisioning 进行的实验性本地路径配置将替换 Grafana 用于引用本地文件的方法。

对于生产系统，请使用 Grafana 中已建立的文件系统配置方法。有关更多信息，请参阅配置 Grafana。

使用 Git 同步管理配置好的仪表盘

使用 Git 同步，您可以在 UI 中管理仪表盘并将其与 GitHub 仓库同步。

Git 同步更改了 Grafana 中保存到 Git 同步的仪表盘的行为

  • 保存在仓库或配置了 Git 同步的本地文件夹中的仪表盘会显示在 Grafana 的配置好的文件夹中。
  • 任何使用 Git 同步保存的仪表盘文件夹在 UI 中都有一个已配置标签。
  • 对配置好的资源的任何更改都必须通过打开拉取请求或直接提交到 main 分支来保存到仓库。

您可以将单个文件夹或多个文件夹设置为不同的仓库，最多可建立 10 个连接。

使用仪表盘的 Git 工作流

默认情况下，Git 版本控制使用基于分支的工作流进行更改。这意味着您可以：

  • 将更改提交到现有分支（例如 main），或将其保存到 GitHub 仓库中的新分支。
  • 使用拉取请求审查对仪表盘的更改。
  • 在合并前预览更改。

要了解更多关于 Git 的信息，请参阅官方 Git 文档中入门 - 关于版本控制一章的Pro Git 书籍。

添加和保存新仪表盘

当您在与 GitHub 仓库关联的配置好的文件夹中创建新仪表盘时，您遵循与创建任何新仪表盘相同的流程。有关更多信息，请参阅创建仪表盘。

创建仪表盘后，步骤类似于将仪表盘更改保存到 GitHub。

  1. 选择保存以保留新仪表盘。
  2. 输入仪表盘的标题和描述。
  3. 从文件夹下拉列表中选择配置好的文件夹。
  4. 在路径中，提供您的仓库路径，路径应以 JSON 或 YAML 文件结尾。
  5. 对于工作流，选择推送至主分支以直接将 Git 提交推送到仓库，或选择推送至新分支以创建拉取请求。
    • 分支：指定 GitHub 中的分支名称（例如，main）。此选项仅在您选择推送至新分支时出现。
  6. 选择保存。

将仪表盘更改保存到 GitHub

编辑配置好的资源时，系统会提示您保存或丢弃更改。保存更改需要您在 GitHub 仓库中打开拉取请求。

  1. 选择编辑以更新配置好的仪表盘。进行您想要的更改。

  2. 点击保存仪表盘。

  3. 在已配置仪表盘面板上，选择您要使用的选项：

    • 更新默认刷新值：选中此框，使当前的刷新间隔成为新的默认值。
    • 更新默认变量值：选中此框，使当前值成为新的默认值。
    • 路径：提供您的仓库路径，路径应以 JSON 或 YAML 文件结尾。
    • 工作流：选择推送至主分支以直接将 Git 提交推送到仓库，或选择推送至新分支以创建拉取请求。
    • 分支：指定 GitHub 中的分支名称（例如，main）。此选项仅在您选择推送至新分支时出现。
    • 评论：添加描述您所做更改的评论。

  4. 可选：选择更改标签页，查看您所做的更新与原始资源之间的差异。

  5. 选择保存。

  6. 如果您选择了推送至新分支，选择在 GitHub 中打开拉取请求以在您的仓库中打开新的 PR。GitHub 将打开，您的仪表盘代码作为 PR 的内容。

  7. 遵循您通常的 GitHub 工作流，保存并将 PR 合并到您的仓库。

移除仪表盘

您可以通过从仓库中删除仪表盘来移除配置好的仪表盘。

当 GitHub 仓库的更改同步时，Grafana 会更新。

提示

  • 使用 GitHub 拉取请求进行更改，以保持审查流程。
  • 提供清晰的提交消息描述您的更改。
  • 定期同步您的仓库以保持 Grafana 最新。
  • 查看事件标签页以监控同步状态。

使用文件配置管理配置好的仪表盘

要更新本地路径中的任何资源，您需要直接编辑文件，然后将其保存在本地。这些更改会同步到 Grafana。但是，您无法使用 Grafana UI 创建、编辑或删除这些资源。

有关更多信息，请参阅工作原理。

请参阅设置文件配置以获取配置说明。