跳到主要内容

提供测试环境

开发者经常问我们将插件发布到 Grafana 插件目录需要多久进行审核。虽然我们无法提供估算时间,但我们一直在寻找缩短周期时间的方法。

到目前为止,插件审核中最耗时的部分是创建合适的测试环境,以便我们验证其行为。这一步骤通常涉及插件开发者和审核团队之间的多次往返沟通。

为了大幅缩短审核时间,开发者可以通过预置其插件来自行提供测试环境。预置(Provisioning)是指在插件的Docker 开发环境中准备和配置测试环境的过程。

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

预置(Provisioning)有几个好处

  • 显著加快审核时间。如果您在提交插件之前对其进行预置,等待审核的时间将大大缩短。
  • 更容易贡献。通过提供一个开箱即用的工作示例,那些有意为您的插件做出贡献的人可以轻松地尝试对插件进行添加并提交拉取请求(pull requests)。
  • 更容易设置端到端测试。通过预置仪表盘,可以在本地开发和 CI 环境中针对特定场景运行端到端测试。
  • 提高清晰度。我们发现,预置的插件使技术娴熟的用户更容易理解插件的工作原理。

提供测试环境的机制

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

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

插件开发者需要做什么?

注意

预置不是必需的;它是插件提交过程中的一个可选部分,可以加快审核速度。

  1. 当您运行 create-plugin 工具时,它会根据所选的插件类型生成一个名为 provisioning 的文件夹以及其他文件。
  2. 当您运行 Docker 开发环境时,这些文件将用于自动安装(如果适用,还会启用)您的插件和一个示例仪表盘。
  3. 我们建议您使用并更新示例仪表盘,以便在开发过程中持续验证行为。并且,酌情配置您的插件,使其能够返回数据。
注意

如果插件是使用旧版本的 create-plugin 工具构建(scaffold)的,可以运行一个新命令来追溯性地添加预置文件。