14 插件

概述

插件为扩展Zabbix监控能力提供了一种选择方案. 插件采用Go编程语言编写, 仅由Zabbix agent 2支持.

插件可作为loadable modules(C语言编写)的替代方案, 以及其他扩展Zabbix功能的方法, 例如user parameters(agent指标), external checks(无agent监控)和system.run[] Zabbix agent item.

以下特性为Zabbix agent 2及其插件所特有:

• 支持被动检查和主动检查的定时与灵活间隔
• 考虑调度和任务并发性的任务队列管理
• 插件级超时设置
• 启动时检查Zabbix agent 2与插件的兼容性

自Zabbix 6.0.0起, 插件无需直接集成到agent 2中, 可作为可加载插件添加, 从而简化了用于收集新监控指标的附加插件的创建过程.

本页面列出了Zabbix原生及可加载插件, 并从用户角度描述了插件配置原则. 关于编写自定义插件的说明, 请参阅Plugin development guidelines. 要了解Zabbix agent 2与可加载插件之间的通信流程及指标收集过程的更多信息, 请参见可加载插件.

配置插件

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

所有插件均通过Plugins.*参数进行配置，该参数可以是Zabbix agent 2 configuration file的组成部分，也可属于插件自身的configuration file。若插件使用独立的配置file，则应在Zabbix agent 2配置file的Include参数中指定该file路径。

典型插件参数结构如下：

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

此外存在两类特殊参数组：

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

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

所有参数命名需符合以下要求：

• 建议插件名称采用首字母大写；
• 参数名称应大写；
• 禁止使用特殊字符；
• 嵌套层级不受限制；
• 参数数量无限制。

默认值

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

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

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

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

命名会话

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

Plugins.<插件名称>.Sessions.<会话名称>.<参数>=<值>

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

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

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

在Zabbix 6.0.17之前的版本中，当在键参数中提供connString（会话名称）时，监控项键参数中的用户名和密码必须为空。这些值将从会话参数中获取。如果未为命名会话指定认证参数，则将使用硬编码的默认值。

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

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

参数优先级

自version 6.0.18版本起，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

在监控项键中提供部分参数（自Zabbix 6.0.17起支持）

配置参数：

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资源消耗 客户端库会处理此机制

插件

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

内置

以下插件为Zabbix agent 2提供开箱即用的支持。点击插件名称可跳转至插件仓库获取更多信息。

可加载

点击插件名称可跳转至包含更多信息的插件仓库。

另见：Building loadable plugins。

脚注

¹ - 自Zabbix 6.0.13起，可加载插件开始采用与Zabbix自身相同的版本控制系统。 因此，MongoDB插件version的版本号从1.2.0变更为6.0.13，PostgreSQL插件version 的版本号从1.2.1变更为6.0.13。