提供测试环境
开发人员经常询问我们,将插件提交到 Grafana 插件目录 进行审核需要多长时间。虽然我们 无法提供估计,但我们一直在寻找缩短周期的方法。
到目前为止,插件审核中最耗时的部分是创建合适的测试环境,以便我们验证其行为。此步骤通常需要插件开发人员和审核团队之间进行多次来回沟通。
为了大幅缩短审核时间,开发人员可以通过 配置 他们的插件来自己提供测试环境。配置是指在插件的 Docker 开发环境 中准备和配置测试环境的过程。
为什么插件开发人员应该关心这一点?
配置有多种好处
- 更快的审核时间。如果您在提交之前配置了您的插件,您的审核等待时间将大大缩短。
- 更轻松的贡献。通过提供一个开箱即用的工作示例,潜在的插件贡献者可以轻松地尝试向插件添加内容并提出拉取请求。
- 更轻松的端到端测试设置。通过配置仪表盘,端到端测试可以在本地开发和 CI 中针对特定场景运行。
- 提高清晰度。我们发现,配置的插件让技术精通的用户更容易理解插件的工作原理。
提供测试环境的机制
Grafana 可以配置为通过称为 配置 的机制安装和启用资源,其中资源在 /provisioning
目录下的 YAML 文件中进行配置。
从 create-plugin v2.8.0 开始,我们为所有插件类型(应用程序、场景应用程序、数据源、面板)生成了配置功能,并包括了一个示例仪表盘作为 create-plugin 的一部分。
插件开发人员需要做什么?
注意
配置不是必需的;它是插件提交流程中的可选部分,可以加快审核速度。
- 运行 create-plugin 工具时,它将生成一个名为
provisioning
的文件夹,其中包含根据所选插件类型生成的额外文件。 - 运行 Docker 开发环境时,这些文件用于自动安装(如果适用,启用)您的插件和示例仪表盘。
- 我们建议您使用并更新示例仪表盘,以在开发过程中持续验证行为。并且,根据需要,配置您的插件,以便它可以返回数据。
注意
如果插件使用 create-plugin 的先前版本构建,则可以运行新的命令来追溯添加配置文件。