2 插件

概述

插件提供了一种扩展 Zabbix 监控能力的选项。插件使用 Go 编程语言编写，仅受 Zabbix agent 2 支持。
插件可作为 loadable modules（用 C 编写）和 other methods 的替代方案，用于扩展 Zabbix 功能。

以下功能专用于 agent 2 及其插件：

• 支持被动检查和主动检查的定时和灵活间隔；
• 根据调度和任务并发性进行任务队列管理；
• 插件级别的超时；
• Zabbix agent 2 及其插件在启动时的兼容性检查。

从 Zabbix 6.0 开始，插件无需直接集成到 agent 2 中，可以作为可加载插件添加，从而简化了创建用于收集新监控指标的附加插件的过程。

本页面列出了 Zabbix 原生插件和可加载插件，并从用户角度描述了插件的配置原则。

配置插件

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

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

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

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

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

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

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

所有参数名称应遵循以下要求：

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

例如，若希望仅对 Uptime 插件，在 agent 重启后立即执行没有 Scheduling update interval 的 被动与主动检查， 请在 configuration file 中设置 Plugins.Uptime.System.ForceActiveChecksOnStart=1。 同样，若希望为 CPU 插件设置自定义的 检查并发性 限制， 请在 configuration file 中设置 Plugins.CPU.System.Capacity=N。

默认值

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

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.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=different_password

此配置的结果是，每个会话名称都可以用作item 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

Item key: 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

Item key: pgsql.ping[,,,postgres]

此配置的结果是，agent 将使用以下参数连接到 PostgreSQL：

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

连接

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

建议将插件配置为保持与实例的连接处于打开状态。这样可以减少网络拥塞、延迟以及由于连接数较少导致的 CPU 和 memory 使用量。客户端库会自动处理这一点。

Plugins

所有 Zabbix agent 2 支持的指标均由插件收集。

内置

以下插件适用于Zabbix agent 2，开箱即用。点击插件名称可前往插件仓库获取更多信息。

可加载

Zabbix agent 2 的可加载插件并非开箱即用，需要单独安装：

• 对于 Linux，您可以使用 packages 或 build plugins。
• 对于 Windows，您可以 zabbix-agent-2可加载插件 或 编译-zabbix-agent-2-可加载插件。

点击插件名称可前往插件仓库查看更多信息。