跳过主内容

Grafana 插件类型和用法

注意

本文档为插件开发者讨论了插件配置、配置管理（provisioning）和用法。关于插件管理的一般信息可在插件管理中找到。

概览​

Grafana 插件开发提供了多种选项，具体取决于您想要创建的用户体验类型。无论您的需求是什么，都有受支持的插件类型可供使用

  • 面板插件 - 一种新的数据可视化方式。
  • 数据源插件 - 连接到新的数据库或其他数据源。
  • 应用插件 - 一体化的开箱即用体验。

请参阅开始使用，了解如何快速搭建每种类型插件的说明。

注意

请勿就插件开发相关主题提交支持工单。有关插件开发的帮助，请联系社区论坛。

面板（可视化）插件​

面板插件（也称为可视化）的开发允许 Grafana 使用自定义可视化，类似于现有的插件，例如Polystat 面板。

面板插件的用法​

任何已安装的 panel 类型插件都可以在仪表盘中用作、选择和配置为可视化项。

与数据源和应用相比，目前不支持在Grafana 组织层面配置可视化项。

注意

随着最近推出的Grafana Scenes，您可以在 Scenes 实现中使用任何已安装的 panel 类型插件作为可视化项。

数据源插件​

在插件开发中，您可以创建新的数据源插件，以便 Grafana 与新的数据库配合使用，类似于现有的插件，例如MongoDB 或 Google BigQuery。数据源插件可以添加到前端和后端。

数据源插件的用法​

当您想使用第三方服务提供的数据用于 Grafana 仪表盘、探索、告警等时，可以创建和配置 Grafana 数据源。

对于任何已安装的 datasource 类型插件，您可以根据每个Grafana 组织创建和配置任意数量的数据源。创建零到无限个数据源后，它们将持久保存在 Grafana 的数据库中。

注意

为了区分 Grafana 数据源和数据源插件，我们有时将后者称为数据源实例，即配置好的 Grafana 数据源，其 plugin id 类型为 datasource。

数据源插件的全局配置​

使用 Grafana 配置文件配置您的应用plugin_id。

信息

并非所有插件都支持此类配置。详细信息请参阅特定插件的 readme。

数据源的配置管理（Provisioning）​

数据源也可以使用 Grafana 的配置管理功能进行配置，以便您可以在 Grafana 启动时或按需将 Grafana 定义为代码，作为 GitOps 方法的一部分。

请注意，必须先安装 datasource 类型的插件，然后才能进行配置管理。

仪表盘捆绑​

数据源插件可以通过在 plugin.json 文件中引用仪表盘 JSON 文件（包括 property 和 type=dashboard）来包含仪表盘。Grafana 在导入时会将仪表盘放置在 General 文件夹中。

应用插件​

应用插件（也称为应用）的开发允许您创建开箱即用的解决方案，例如Redis 应用。您可以选择性地捆绑数据源和面板，以及提供自定义页面、Scenes 和 UI 扩展。

应用插件的用法​

当您想要利用或为第三方服务创建定制的监控视图，并可选择使用自定义页面或 UI 扩展时，配置 Grafana 应用。对于任何已安装的 app 类型插件，您可以每个Grafana 组织启用一次，它们将持久保存在 Grafana 的数据库中。

注意

为了区分 Grafana 应用和应用插件，我们有时将后者称为应用实例，即配置好的 Grafana 应用，其 plugin id 类型为 app。

应用插件的全局配置​

使用Grafana 配置文件配置您的应用plugin_id。

信息

并非所有插件都支持此类配置。详细信息请参阅特定插件的 readme。

应用插件的配置管理（Provisioning）​

应用也可以使用 Grafana 的配置管理功能进行配置，以便您可以在 Grafana 启动时或按需将 Grafana 定义为代码，作为 GitOps 方法的一部分。

请注意，必须先安装插件，然后才能成功进行配置管理，其 plugin id 类型为 app。

应用捆绑​

应用插件类型允许您在其中嵌套其他插件；换句话说，可以在同一个包中捆绑或包含多个插件。

仪表盘捆绑​

应用插件可以通过在 plugin.json 中引用仪表盘 JSON 文件（包括 property 和 type=dashboard）来包含仪表盘。Grafana 在导入时会将仪表盘放置在 General 文件夹中，这将在应用启用时自动发生。