菜单
企业版 Grafana Cloud 开源

插件管理

您可以使用插件来增强您的 Grafana 体验,插件是对 Grafana 的扩展,超越了内置的各种可视化和数据源。

本指南将向您展示如何安装由 Grafana Labs、商业合作伙伴、我们的社区构建的插件,或者您自己构建的插件

插件类型

Grafana 支持三种类型的插件

  • 面板 - 这些插件使创建和添加任何类型的面板变得容易,以显示您的数据或改进您喜欢的仪表盘。
  • 数据源 - 这些插件允许您从各种数据源(如数据库、API、日志文件等)中提取数据,并在 Grafana 中以图形、图表和仪表盘的形式显示数据。
  • 应用 - 这些插件使将数据源、面板、仪表盘和 Grafana 页面捆绑到一致的体验中。

面板插件

使用面板插件(如时钟马赛克变量面板)将新的可视化添加到您的仪表盘。

当您想要时使用面板插件

  • 可视化数据源查询返回的数据。
  • 在仪表盘之间导航。
  • 控制外部系统,例如智能家居设备。

数据源插件

数据源插件添加了对新数据库的支持,例如Google BigQuery

数据源插件与外部数据源进行通信,并以 Grafana 能够理解的格式返回数据。通过添加数据源插件,您可以在您现有的任何仪表盘中立即使用该数据。

当您想要从外部或第三方系统查询数据时,使用数据源插件。

应用插件

应用程序或应用插件捆绑数据源和面板以提供一致的体验,例如Zabbix 应用程序。

应用程序还可以为控制面板等添加自定义页面。

当您想要开箱即用的监控体验时,使用应用程序插件。

管理应用程序插件的访问权限

使用RBAC自定义对应用程序插件的访问权限。

默认情况下,查看者、编辑者和管理员角色可以访问其组织角色允许他们访问的所有应用程序插件。访问权限由fixed:plugins.app:reader角色授予。

注意

要阻止用户看到应用程序插件,请参考这些权限场景

插件目录

Grafana 插件目录允许您在 Grafana 中浏览和管理插件。只有 Grafana 服务器管理员和组织管理员可以访问和使用插件目录。有关 Grafana 角色和权限的更多信息,请参考角色和权限

以下访问规则适用于不同的用户角色

  • 如果您是组织管理员,您可以配置应用程序插件,但不能安装、卸载或更新它们。
  • 如果您是服务器管理员,您不能配置应用程序插件,但可以安装、卸载或更新它们。
  • 如果您同时是组织管理员服务器管理员,您可以配置应用程序插件,还可以安装、卸载或更新它们。

注意

Grafana 插件目录旨在仅与单个 Grafana 服务器实例一起使用。对 Grafana 集群的支持计划在未来的 Grafana 版本中提供。

视频展示了 Grafana 早期版本中的插件目录。

注意

如果需要,可以使用配置文件中的plugin_admin_enabled标志禁用 Grafana 插件目录。

浏览插件

要浏览可用的插件

  1. 以管理员身份登录 Grafana 后,点击侧边菜单中的管理 > 插件和数据 > 插件以查看已安装和可用的插件。
  2. 使用搜索根据名称、关键字、组织和其他元数据进行过滤。
  3. 点击数据源面板应用程序按钮,按插件类型进行过滤。

安装插件

要安装插件

  1. 在 Grafana 中,点击侧边导航菜单中的管理 > 插件和数据 > 插件以查看所有插件。
  2. 浏览并找到一个插件。
  3. 点击插件的徽标。
  4. 点击安装

更新完成后,您将看到一条确认消息,表明安装成功。

更新插件

要更新插件

  1. 在 Grafana 中,点击侧边导航菜单中的管理 > 插件和数据 > 插件以查看所有插件。
  2. 点击已安装过滤器以仅显示已安装的插件。
  3. 点击插件的徽标。
  4. 点击更新

更新完成后,您将看到一条确认消息,表明更新成功。

卸载插件

要卸载插件

  1. 在 Grafana 中,点击侧边导航菜单中的管理 > 插件和数据 > 插件以查看所有插件。
  2. 点击插件的徽标。
  3. 点击已安装过滤器以仅显示已安装的插件。
  4. 点击卸载

更新完成后,您将看到一条确认消息,表明卸载成功。

安装 Grafana 插件

Grafana 支持数据源、面板和应用插件。

  1. 在 Web 浏览器中,导航到Grafana 插件目录并找到您想要安装的插件。
  2. 点击插件,然后点击安装选项卡。

在 Grafana Cloud 上安装插件

安装选项卡字段中,点击您要安装插件的 Grafana 实例的名称。

Grafana Cloud 会自动处理插件安装。

如果您在添加插件时登录了 Grafana Cloud,请注销,然后重新登录以使用新插件。

使用 Grafana Helm 图表安装插件

使用 Grafana Helm 图表,使用您 values 文件中的plugins字段将您想要安装的插件添加为列表。有关配置的更多信息,请参考Helm 图表配置参考

以下 YAML 代码片段会安装 Grafana OnCall 应用插件的 v1.9.0 版本和 Redis 数据源插件。您必须将此代码片段添加到您的 Helm values 文件中。

yaml
plugins:
  - https://grafana.org.cn/api/plugins/grafana-oncall-app/versions/v1.9.0/download;grafana-oncall-app
  - redis-datasource

在本地 Grafana 上安装插件

请按照 **安装** 选项卡上的说明操作。您可以使用 Grafana CLI 命令安装插件,也可以下载并解压缩 zip 文件到 Grafana 插件目录中。我们建议在大多数情况下使用 Grafana CLI。如果您的 Grafana 服务器无法访问互联网,则可以使用 zip 选项。

有关 Grafana CLI 插件命令的更多信息,请参阅 插件命令

安装打包的插件

在用户下载包含插件资源的压缩包后,可以通过将压缩包解压缩到插件目录来安装它。例如

bash
unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin

插件目录的路径在配置文件中定义。有关更多信息,请参阅 配置

插件签名

插件签名验证(也称为 *签名*)是一种安全措施,用于确保插件没有被篡改。在加载时,Grafana 会检查插件在检查和验证其数字签名时是已签名还是未签名的。

在启动时,Grafana 会验证插件目录中每个插件的签名。如果插件未签名,则 Grafana 不会加载或启动它。要查看每个插件验证结果,请导航到 **配置** -> **插件**。

Grafana 还会将错误消息写入服务器日志

bash
WARN[05-26|12:00:00] Some plugin scanning errors were found   errors="plugin '<plugin id>' is unsigned, plugin '<plugin id>' has an invalid signature"

如果您是插件开发者,并想知道如何签名您的插件,请参阅 签名插件

签名状态描述
核心内置于 Grafana 的核心插件。
无效签名插件的签名无效。
修改过的签名插件在签名后发生了更改。这可能表明有恶意意图。
未签名插件未签名。
已签名插件签名已成功验证。

插件签名级别

所有插件都在 *签名级别* 下签名。签名级别决定了插件如何分发。

插件级别描述
私有

私有插件仅供您自己的 Grafana 使用。它们可能不会分发给 Grafana 社区,也不会发布在 Grafana 目录中。

社区

社区插件具有开源且非盈利性的依赖技术。

社区插件发布在官方 Grafana 目录中,并可供 Grafana 社区使用。

商业

商业插件具有闭源或商业支持的依赖技术。

商业插件发布在官方 Grafana 目录中,并可供 Grafana 社区使用。

允许未签名插件

注意

Grafana Cloud 不支持未签名插件。

我们强烈建议您不要在 Grafana 实例中运行未签名插件。但是,如果您了解风险,并且仍然要加载未签名插件,请参阅 配置

如果您已允许加载未签名插件,则 Grafana 会将警告消息写入服务器日志

bash
WARN[06-01|16:45:59] Running an unsigned plugin   pluginID=<plugin id>

注意

如果您正在开发插件,则可以启用开发模式以允许所有未签名插件。

了解更多