外部插件开发
重要提示
Kibana 插件接口处于不断开发的状态。由于变化率很高,我们无法为插件提供向后兼容性。Kibana 强制要求安装的插件必须与 Kibana 本身的版本相匹配。因此,插件开发人员必须为每个新的 Kibana 版本发布其插件的新版本。
大多数直接为 Kibana 代码库贡献代码的开发人员都是在插件内部编写代码,因此我们的 贡献 文档是最好的入门起点。但是,在 Kibana 代码库之外开发插件时会有一些差异。此处将介绍这些差异。
如果您是从代码库内插件文档过来的,请注意以下事项
- 位置。 外部插件位于您的 Kibana 检出根目录下的
plugins/目录中。此目录在 git 中被忽略 —— 您的插件不会与 Kibana 源代码一起被跟踪。 - 清单。 外部插件使用扁平化的
kibana.json清单(与代码库内的kibana.jsonc架构不同)。使用node scripts/generate_plugin来以正确的格式生成脚手架。 - 构建。 外部插件的浏览器包不由 Kibana 优化器构建。在插件目录内的一个专用终端中运行
yarn dev --watch,同时在另一个终端中运行yarn start—— 参见 插件工具。