Grafana 插件类型和用法

注意

本文档讨论了插件配置、配置和用法，适用于插件开发者。有关插件管理的一般信息，请参阅 插件管理。

概述

Grafana 插件开发允许根据您希望创建的用户体验类型进行多种选择。无论您的需求是什么，都有一款支持的插件类型适合您的需求

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

请参考 开始 了解如何快速搭建 每种类型 的插件。

注意

不要为与插件开发相关的问题打开支持工单。有关插件开发的帮助，请联系 社区论坛。

面板（可视化）插件

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

面板插件的用法

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

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

注意

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

数据源插件

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

数据源插件的使用

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

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

注意

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

数据源插件的全球配置

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

信息

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

数据源配置

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

请注意，在配置之前必须安装类型为datasource的插件。

仪表板捆绑

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

应用程序插件

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

应用插件的使用

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

注意

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

应用插件的全球配置

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

信息

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

应用插件的提供

应用也可以使用 Grafana 的 提供功能 来提供，这样您可以将 Grafana 作为代码的一部分定义在 GitOps 方法中，在 Grafana 启动时或按需。

请注意，在提供之前必须安装插件，以便使用类型为 app 的 plugin id 成功。

应用的捆绑

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

仪表板的捆绑

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