包含仪表盘

本指南解释了如何将预配置的仪表盘添加到数据源 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. 单击要导入的仪表盘旁边的导入。仪表盘将导入到你的插件中。

结论

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