跳到主要内容

Grafana 插件类型和用法

注意

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

概述​

Grafana 插件开发允许多种选择，具体取决于您想要创建的用户体验类型。无论您的需求是什么，都有支持的插件类型可用于您的预期用途

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

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

注意

请勿针对与插件开发相关的主题打开支持工单。如需插件开发方面的帮助，请联系社区论坛。

面板（可视化）插件​

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

面板插件的用法​

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

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

注意

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

数据源插件​

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

数据源插件的用法​

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

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

注意

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

数据源插件的全局配置​

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

信息

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

数据源的配置​

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

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

仪表板捆绑​

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

应用插件​

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

应用插件的用法​

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

注意

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

应用插件的全局配置​

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

信息

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

应用插件的配置​

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

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

应用的捆绑​

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

仪表板捆绑​

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