使用嵌套插件
Grafana 应用程序插件可以嵌套数据源(包括前端和后端)以及面板插件,以便您提供完整的用户体验。
开始之前
搭建应用程序插件骨架。有关说明,请参阅构建应用程序插件的教程。
嵌套插件的结构
嵌套插件位于应用程序插件的 src
文件夹内。它们通常遵循与插件相同的结构,并拥有自己的 plugin.json
,但没有自己的 package.json
或 .config
文件夹。
以下是一个嵌套数据源插件的示例
./src
├── README.md
├── components
+├── nested-datasource
+│ ├── components
+│ │ ├── ConfigEditor.tsx
+│ │ └── QueryEditor.tsx
+│ ├── datasource.ts
+│ ├── img
+│ ├── module.ts
+│ ├── plugin.json
+│ └── types.ts
├── img
│ └── logo.svg
├── module.ts
└── plugin.json
何时使用嵌套插件
当您有一个想要与应用程序插件一起分发的数据源或面板插件时,
每个嵌套数据源都可以有自己的后端,独立于应用程序插件的后端。
注意
请注意,插件 nested-datasource
没有自己的 package.json
。嵌套插件文件夹的名称不重要。
如何向应用程序插件添加嵌套插件
-
创建一个将成为嵌套插件的新插件
重要从您的应用程序插件目录外部开始。
使用
create-plugin
工具生成新插件npx @grafana/create-plugin@latest
选择所需的插件类型(数据源或面板),提供一个名称,并使用与您的应用程序插件相同的组织。
-
准备嵌套插件
将新生成的插件的
src
文件夹重命名为一个反映其特定用途的名称(例如,nested-datasource
)。 -
集成到您的应用程序插件中
将重命名的
src
文件夹直接复制到您的应用程序插件的src
文件夹内。您可以安全地忽略其他生成的文件(如package.json
、.config
等)。您的应用程序中不需要这些文件。 -
(可选)将您的数据源添加到预配的数据源
如果您要添加嵌套数据源,请记得将其添加到预配数据源的 YAML 配置文件中。有关更多详细信息,请参阅有关预配 Grafana 的文档。
-
(可选)清理您的目录
您现在可以删除最初生成的嵌套插件的整个目录。
通过这些步骤,您的应用程序插件现在包含了嵌套数据源或面板的源代码,可供进一步开发。