2 插件

概述

插件扩展了 Zabbix agent 2 的监控能力。 它们使用 Go 编程语言编写，作为 可加载模块（使用 C 编写）和 其他方法 的替代方案，用于扩展 Zabbix 功能。

以下功能是 agent 2 及其插件特有的：

• 适用于被动和主动检查的计划和灵活间隔
• 考虑调度和任务并发性的任务队列管理
• 插件级超时
• 启动时对 Zabbix agent 2 及其插件进行兼容性检查

Zabbix agent 2 支持的所有指标都由插件采集。 本页从用户角度介绍插件配置原则，并列出 Zabbix 提供的内置插件和可加载插件。

配置插件

本节介绍通用的插件配置原则和最佳实践。

所有插件都使用 Plugins.\* 参数进行配置，该参数可以是 Zabbix agent 2 配置文件的一部分，也可以是插件自身的配置文件。 如果插件使用单独的配置文件，则应在 Zabbix agent 2 配置文件的 Include 参数中指定该文件的路径。

典型的插件参数具有以下结构：

Plugins.<PluginName>.<Parameter>=<Value>

此外，还有两组特定的参数：

• Plugins.<PluginName>.Default.<Parameter>=<Value> 用于定义默认参数值。

• Plugins.<PluginName>.<SessionName>.<Parameter>=<Value> 用于通过命名会话为不同的监控目标定义不同的参数集。

所有参数名称都应符合以下要求：

• 建议将插件名称首字母大写。
• 参数应首字母大写。
• 不允许使用特殊字符。
• 嵌套层级没有最大限制。
• 参数数量没有限制。

例如，要仅为 Uptime 插件在 agent 重启后立即执行不具有 Scheduling 更新间隔的主动检查，请在配置文件中设置 Plugins.Uptime.System.ForceActiveChecksOnStart=1。 同样地，要为 CPU 插件设置 并发检查的自定义限制，请在配置文件中设置 Plugins.CPU.System.Capacity=N。

默认值

您可以在配置file中设置连接相关参数（URI、用户名、密码等）的默认值，格式如下：

Plugins.<PluginName>.Default.<Parameter>=<Value>

例如 Plugins.Mysql.Default.Username=zabbix、Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017 等。

如果在监控项键或命名会话参数中未提供此类参数的值，插件将使用默认值。 如果默认参数也未定义，则将使用硬编码的默认值。

命名会话

命名会话代表插件参数的附加层级，可用于为每个被监控实例指定独立的认证参数集。 每个命名会话参数应具有以下结构：

Plugins.<PluginName>.Sessions.<SessionName>.<Parameter>=<Value>

会话名称可作为connString 监控项键参数使用，无需单独指定URI、用户名和/或密码。

在监控项键中，第一个参数可以是connString或URI。 如果第一个键参数不匹配任何会话名称，它将被视为URI处理。 请注意监控项键不支持传递嵌入式URI凭证，应改用命名会话参数。

可用named session parameters列表取决于具体插件。

可通过在监控项键参数中指定新值来覆盖会话参数（参见示例）。

如果命名会话中未定义某个参数，Zabbix agent 2将使用默认插件参数中定义的值。

参数优先级

Zabbix agent 2插件按以下顺序查找与连接相关的参数值：

1. 第一个监控项键参数会与会话名称进行比较。 如果未找到匹配项，则将其视为实际值；这种情况下将跳过步骤3。 如果找到匹配项，则参数值（通常是URI）必须在命名会话中定义。
2. 其他参数将从已定义的监控项键中获取。
3. 如果监控项键参数（例如密码）为空，插件将查找对应的命名会话参数。
4. 如果会话参数也未指定，将使用对应默认参数中定义的值。
5. 如果以上方法均失败，插件将使用硬编码的默认值。

示例 1

对两个实例 "MySQL1" 和 "MySQL2" 进行监控。

配置参数：

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
Plugins.Mysql.Sessions.MySQL1.Password=unique_password
Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.1:3306
Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
Plugins.Mysql.Sessions.MySQL2.Password=different_password

由于此配置，每个会话名称都可以在 监控项 key 中用作 connString，例如 mysql.ping[MySQL1] 或 mysql.ping[MySQL2]。

示例 2

在监控项键中提供部分参数。

配置参数：

Plugins.PostgreSQL.Sessions.Session1.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Sessions.Session1.User=old_username
Plugins.PostgreSQL.Sessions.Session1.Password=session_password

监控项键: pgsql.ping[session1,new_username,,postgres]

由于此配置，agent 将使用以下参数连接 PostgreSQL：

• 来自会话参数的 URI：192.0.2.234:5432
• 来自监控项键的用户名：new_username
• 来自会话参数的密码（因为在监控项键中省略了该参数）：session_password
• 来自监控项键的数据库名：postgres

示例 3

使用默认配置参数收集监控项。

配置参数：

Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
Plugins.PostgreSQL.Default.User=zabbix
Plugins.PostgreSQL.Default.Password=password

监控项键: pgsql.ping[,,,postgres]

根据此配置，agent 将使用以下参数连接到 PostgreSQL：

• 默认 URI: 192.0.2.234:5432
• 默认用户名: zabbix
• 默认密码: password
• 来自监控项键的数据库名称: postgres

连接

某些插件支持同时从多个实例收集指标。 本地和远程实例都可以被监控。 支持 TCP 和 Unix 套接字连接。

建议将插件配置为保持与实例的连接处于打开状态。 这样做的好处是，由于连接数量更少，可以减少网络拥塞、延迟以及 CPU 和内存使用。 客户端库会负责处理这一点。

内置插件

Zabbix agent 2 内置插件开箱即用。 单击插件名称可跳转到插件仓库，查看附加信息。

可加载插件

Zabbix agent 2 的可加载插件默认不提供，需要单独安装：

• 在 Linux 上，您可以使用 软件包（例如，在 Ubuntu 上通过 apt install zabbix-agent2-plugin-ember-plus 安装 Ember+）或构建插件
• 在 Windows 上，您可以从 MSI 安装或构建插件

点击插件名称可进入插件仓库，其中包含带有更多信息的插件 README 文件。