2 插件

概述

插件提供了扩展 Zabbix 监控功能的选项。插件使用 Go 编程语言编写，仅受 Zabbix agent 2 支持。插件提供了可加载模块（使用 C 编写）的替代方案，以及扩展 Zabbix 功能的其他方法。

以下功能特定于agent 2 及其插件：

• 支持被动和主动检查的预定和灵活的间隔；
• 关于计划和任务并发的任务队列管理；
• 插件级超时；
• 启动时检查 Zabbix agent 2 及其插件的兼容性。

自 Zabbix 6.0 起，插件不必直接集成到agent 2 中，而是可以作为可加载插件添加，从而更容易创建用于收集新监控指标的附加插件。

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

有关编写自己的插件的说明和教程，请参阅开发者中心。

有关 Zabbix agent 2 与可加载插件之间的通信过程以及指标收集过程的更多信息，请参阅连接图。

配置插件

This section provides common plugin configuration principles and best practices. 本节提供常见的插件配置原则和最佳实践。

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

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

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

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

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

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

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

• 建议将插件名称大写；
• 参数应该大写；
• 不允许有特殊字符;
• 嵌套不受最大级别的限制；
• 参数的数量不受限制。

例如，要仅为 Uptime 插件执行没有在代理重启后立即安排更新间隔的主动检查，请在配置文件中设置。同样，要为 CPU 插件设置并发检查的自定义限制，请在配置文件中设置。 设置 Plugins.Uptime.System.ForceActiveChecksOnStart=1 在 配置文件. Similarly, to set custom limit for concurrent checks for the CPU plugin, 设置 Plugins.CPU.System.Capacity=N 在 配置文件.

命名会话

命名会话代表插件参数的附加级别，可用于为每个受监控的实例指定单独的身份验证参数集。每个命名会话参数应具有以下结构：

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

会话名称可以用作 connString 项目键参数，而不必单独指定 URI、用户名和/或密码。

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

可用的命名会话 参数列表取决于插件。

可以通过在项目键参数中指定新值来覆盖会话参数( 参见示例)。

如果没有为命名会话定义参数，Zabbix 代理 2 将使用默认插件参数中定义的值。

参数优先级

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

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

示例 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

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

示例 2

提供项目键中的一些参数。

配置参数：

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

监控项 key：pgsql.ping[session1,new_username,,postgres]

此配置的结果是，代理将使用以下参数连接到 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

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

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

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

默认值

You can set default values for the connection-related parameters (URI, username, password, etc.) in the configuration file in the format: 您可以在配置文件中设置连接相关参数（URI、用户名、密码等）的默认值，格式如下：

*插件.<插件名称>.默认.<参数>=<值>

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

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

连接

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

建议配置插件以保持与实例的连接处于打开状态。这样做的好处是，由于连接数较少，网络拥塞、延迟以及 CPU 和内存使用率会降低。客户端库会处理此问题。

插件

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

内置

Zabbix Zabbix 2 的以下插件可立即使用。单击插件名称可转到包含更多信息的插件存储库。

可加载

单击插件名称即可转到包含更多信息的插件存储库。

另请参阅:

• 构建可加载插件
• 用于 Windows 预编译插件二进制文件的Zabbix Cloud Images 和Appliances