跳到主要内容

包含仪表盘

本指南解释了如何将预配置的仪表盘添加到 Grafana 数据源插件中。通过将预配置的仪表盘集成到插件中，您可以为用户提供即用型模板，让他们无需从头构建仪表盘。

我们将引导您完成将仪表盘捆绑到插件中的过程。该过程包括创建仪表盘、将其添加到插件中，然后将其导入到插件中。

步骤 1：创建仪表盘​

首先创建要与插件捆绑的仪表盘。create-plugin 提供的 开发环境 可以帮助创建和测试仪表盘。

导出仪表盘​

在此步骤中，我们将仪表盘导出为 JSON 文件，以便将其与插件源代码一起放在文件中。

  1. 在 Grafana 中打开您的仪表盘。
  2. 单击仪表盘左上角的 分享 图标。
  3. 单击 导出。
  4. 选择 导出以供外部共享，然后单击 保存到文件。

使用此选项导出将直接数据源引用替换为占位符。这确保了导入仪表盘时，仪表盘可以使用用户的数据源实例。

步骤 2：将仪表盘添加到插件中​

  1. 在插件项目的 src 目录下创建一个 dashboards 文件夹。

  2. 将导出的仪表盘 JSON 文件移动到新的 dashboards 文件夹中。

    myorg-myplugin-datasource/
    └── src/
        ├── dashboards/
        │   └── overview.json
        ├── module.ts
        └── plugin.json

  3. 更新 plugin.json 文件，以包含对新仪表盘资源的引用，指定仪表盘文件在 src 文件夹中的相对路径。

    src/plugin.json
    {
      "includes": [
        {
          "name": "overview",
          "path": "dashboards/overview.json",
          "type": "dashboard"
        }
      ]
    }
    提示

    确保路径相对于 src 目录。这是插件在构建前端后能够从 dist 目录正确引用仪表盘 JSON 文件所必需的。

  4. 将仪表盘添加到插件后，重新构建插件并重启 Grafana 以应用新配置。

步骤 3：将仪表盘导入到插件中​

要测试新创建的仪表盘，请导入仪表盘

  1. 创建或编辑数据源的现有实例。
  2. 单击 仪表盘 以列出所有包含的仪表盘。
  3. 在您要导入的仪表盘旁边单击 导入。该仪表盘将被导入到您的插件中。

保持仪表盘最新​

Grafana 仪表盘架构会随着时间演变，不定期更新的仪表盘可能会过时。过时的仪表盘在加载时可能需要耗时的迁移，或者可能无法与较新的 Grafana 功能正常工作。以下是确保仪表盘保持最新的方法

  1. 按照上面 步骤 3 中的步骤导入您的仪表盘。此过程会自动运行所需的任何迁移，将仪表盘更新到最新的架构。
  2. 加载后，单击仪表盘顶部菜单中的 导出 按钮，然后选择 导出为 JSON。
  3. 务必勾选选项 导出仪表盘以用于另一个实例。
  4. 通过以下任一方式保存更新后的仪表盘：
    • 单击 下载文件 并替换现有 JSON 文件
    • 使用 复制到剪贴板 并将内容粘贴到现有 JSON 文件中
  5. （可选）为帮助用户识别最新的仪表盘版本，请递增 JSON 文件根级别的 version 号（例如，从 1 到 2）。这清楚地表明了仪表盘何时更新了新功能或修复。

结论​

通过将仪表盘与插件捆绑，您可以显著改善用户的入门体验。预配置的仪表盘消除了用户从头设置通用变量、面板或查询的需要。这可以极大地提高用户满意度和效率！