Grafana 插件类型和用法

注意

本文档讨论了插件开发人员的插件配置、预配和用法。有关插件管理的一般信息，请访问 插件管理。

概述

Grafana 插件开发根据您想要创建的用户体验类型提供了许多选项。无论您的需求是什么，都有一种支持的插件类型适合您的预期用途。

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

有关如何快速搭建 每种类型 插件的说明，请参阅 入门。

注意

不要为与插件开发相关的主题提交支持工单。如需获取插件开发帮助，请联系 社区论坛。

面板（可视化）插件

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

面板插件的用法

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

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

注意

随着最近引入的 Grafana 场景，您可以在场景实现中使用任何已安装的类型为 panel 的插件作为可视化。

数据源插件

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

数据源插件的用法

当您想使用第三方服务提供的数据在 Grafana 仪表板、Explore、警报等中使用时，创建并配置 Grafana 数据源。

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

注意

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

数据源插件的全局配置

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

信息

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

数据源的预配

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

请注意，必须先安装类型为 datasource 的插件，然后才能对其进行预配。

仪表板的捆绑

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

应用插件

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

应用插件的用法

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

注意

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

应用插件的全局配置

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

信息

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

应用插件的预配

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

请注意，必须先安装插件，然后才能使用类型为 app 的 plugin id 成功预配。

应用的捆绑

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

仪表板的捆绑

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