包含仪表盘

本指南介绍如何将预配置的仪表盘添加到数据源 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. 点击要导入的仪表盘旁边的“导入”。仪表盘将导入到您的插件中。

结论

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