跳转到主要内容

提供测试环境

开发者经常问我们插件发布到 Grafana 插件目录 的审查需要多长时间。虽然我们 无法提供估计,但我们一直在寻找减少周期时间的方法。

插件审查中耗时最长的方面是创建一个合适的测试环境,以便我们可以验证其行为。这一步骤通常涉及插件开发者和审查团队之间的大量来回沟通。

为了极大地提高审查时间,开发者可以通过 配置 他们的插件来自行提供。配置是指在插件的 Docker 开发环境 内准备和配置测试环境的过程。

为什么插件开发者应该关心这一点?

配置有几个好处

  • 更快的审查时间。如果您在提交之前配置了插件,您的审查等待时间将大大缩短。
  • 更容易的贡献。由于提供了一个现成的可工作示例,希望为您的插件做出贡献的人可以轻松地尝试添加插件并提交拉取请求。
  • 更容易设置端到端测试。通过配置仪表板,端到端测试可以在本地开发和 CI 中针对特定场景运行。
  • 提高清晰度。我们发现,已配置的插件使技术用户更容易理解插件的工作方式。

提供测试环境的机制

Grafana可以通过一种称为配置的机制来安装和启用资源,其中资源在/provisioning目录下的YAML文件中进行配置。

从create-plugin v2.8.0版本开始,我们为所有插件类型(应用、场景应用、数据源、面板)生成配置功能,并将一个示例仪表板作为create-plugin的一部分。

插件开发者需要做什么?

注意

配置不是必需的;它是插件提交过程的可选部分,可以加快审查速度。

  1. 当你运行create-plugin工具时,它将根据所选的插件类型生成一个名为provisioning的文件夹,并包含额外的文件。
  2. 当你运行Docker开发环境时,这些文件将用于自动安装(如果适用,启用)你的插件和示例仪表板。
  3. 我们建议你使用并更新示例仪表板,以作为你开发过程的一部分,持续验证行为。并且,根据需要,配置你的插件以便它可以返回数据。
注意

如果插件是用先前版本的create-plugin搭建的,可以运行一个新命令来回顾性添加配置文件。