包含仪表盘

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

结论

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