2 插件

概述

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

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

• 支持被动和主动检查的定时及灵活间隔
• 基于调度和任务并发性的任务队列管理
• 插件级超时控制
• 启动时对Zabbix agent 2及其插件的兼容性检查

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

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

配置插件

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

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

典型插件参数结构如下：

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

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

• Plugins.<插件名称>.Default.<参数>=<值> 用于定义默认参数值

• Plugins.<插件名称>.<会话名称>.<参数>=<值> 用于通过命名会话为不同监控目标定义独立参数集

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

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

例如，若需在agent重启后立即执行没有Schedulingupdate interval的被动与主动检查（仅针对Uptime插件），请在configuration file中设置Plugins.Uptime.System.ForceActiveChecksOnStart=1。 同理，要为CPU插件设置检查并发性的自定义限制，请在configuration file中配置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.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-可加载插件

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