插件管理
您可以通过插件增强您的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插件目录。
浏览插件
要浏览可用的插件
- 以管理员身份登录Grafana时,在侧菜单中单击管理 > 插件和数据 > 插件,以查看已安装和可用的插件。
- 使用搜索根据名称、关键字、组织和其他元数据进行筛选。
- 单击数据源、面板或应用程序按钮以根据插件类型进行筛选。
安装插件
安装插件最常见的方法是通过Grafana UI,但还有其他替代方法。
- 在Grafana中,在侧导航菜单中单击管理 > 插件和数据 > 插件,以查看所有插件。
- 浏览并找到插件。
- 单击插件的标志。
- 单击安装。
根据您的配置,还有其他安装插件的方法。
使用Grafana CLI安装插件
Grafana CLI允许您使用命令行安装、升级和管理您的Grafana插件。有关Grafana CLI插件命令的更多信息,请参阅插件命令。
从ZIP文件安装插件
此方法通常用于插件目录中不可用的插件或在没有互联网接入的环境中。
下载包含插件资源的存档,并将存档解压到插件目录中进行安装。例如
unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin
插件目录的路径在配置文件中定义。有关更多信息,请参阅配置。
在断网环境中安装插件
插件安装通常需要互联网连接。您可以在实例上检查安装期间使用的端点,并将它们添加到实例的允许列表中。
如果这不可能,您可以通过使用Grafana CLI或ZIP文件安装插件。
您可以通过API中引用的下载链接从Grafana.com API获取任何插件。以下是基于grafana-lokiexplore-app
插件的示例。
- 打开
https://grafana.org.cn/api/plugins/grafana-lokiexplore-app
并查找links
部分 - 找到一个类似
https://grafana.org.cn/api/plugins/grafana-lokiexplore-app/versions/1.0.2/download
的download
URL - 使用此URL下载插件ZIP文件,然后按照上述方法进行安装。
使用Grafana Helm图安装插件
使用Grafana Helm图,通过在values文件中使用plugins
字段将您要安装的插件作为列表添加。有关配置的更多信息,请参阅Helm图配置参考。
以下YAML片段安装Grafana OnCall App插件的v1.9.0版本和Redis数据源插件。您必须在Helm values文件中包含此片段。
plugins:
- https://grafana.org.cn/api/plugins/grafana-oncall-app/versions/v1.9.0/download;grafana-oncall-app
- redis-datasource
更新完成后,确认消息将指示安装成功。
更新插件
要更新插件
- 在Grafana中,在侧导航菜单中单击管理 > 插件和数据 > 插件,以查看所有插件。
- 单击已安装过滤器以仅显示已安装的插件。
- 单击插件的标志。
- 单击更新。
更新完成后,确认消息将指示安装成功。
卸载插件
要卸载插件
- 在Grafana中,在侧导航菜单中单击管理 > 插件和数据 > 插件,以查看所有插件。
- 单击插件的标志。
- 单击已安装过滤器以仅显示已安装的插件。
- 单击卸载。
更新完成后,确认消息将指示安装成功。
插件签名
插件签名验证,也称为签名,是一种安全措施,以确保插件未被篡改。Grafana在检查和验证其数字签名时,会检查插件是否已签名或未签名。
在启动时,Grafana会验证插件目录中每个插件的签名。如果插件未签名,则Grafana既不加载也不启动它。要查看每个插件的验证结果,请导航到配置 -> 插件。
Grafana还会将错误消息写入服务器日志
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将警告信息写入服务器日志
WARN[06-01|16:45:59] Running an unsigned plugin pluginID=<plugin id>
注意
如果您正在开发插件,则可以启用开发模式以允许所有未签名的插件。