3 Zabbix agent (UNIX)

概述

本节列出了 Zabbix agent 配置文件 (zabbix_agentd.conf) 支持的参数。

这些参数仅列出名称,不附加其他信息。 单击参数可查看完整详情。

Parameter Description
Alias 为监控项键设置别名。
AllowKey 允许执行与某个模式匹配的监控项键。
AllowRoot 允许 agent 以 'root' 身份运行。
BufferSend 缓冲区中的数据保留时间不超过 N 秒。
BufferSize 内存缓冲区中的最大值数量。
DebugLevel 调试级别。
DenyKey 拒绝执行与某个模式匹配的监控项键。
EnableRemoteCommands 是否允许来自 Zabbix 服务器的远程命令。
HeartbeatFrequency 心跳消息的发送频率,单位为秒。
HostInterface 用于定义主机接口的可选参数。
HostInterfaceItem 用于获取主机接口的监控项的可选参数。
HostMetadata 用于定义主机元数据的可选参数。
HostMetadataItem 用于获取主机元数据的 Zabbix agent 监控项的可选参数。
Hostname 用于定义主机名的可选参数。
HostnameItem 用于获取主机名的 Zabbix agent 监控项的可选参数。
Include 您可以在配置文件中包含单个文件或目录中的所有文件。
ListenBacklog TCP 队列中待处理连接的最大数量。
ListenIP agent 应监听的、以逗号分隔的 IP 地址列表。
ListenPort agent 将在此端口上监听来自服务器的连接。
LoadModule agent 启动时要加载的模块。
LoadModulePath agent 模块所在位置的完整路径。
LogFile 日志文件名。
LogFileSize 日志文件的最大大小。
LogRemoteCommands 将已执行的 shell 命令记录为警告。
LogType 日志输出类型。
MaxLinesPerSecond 在处理 'log' 和 'logrt' 主动检查时,agent 每秒向 Zabbix 服务器或 proxy 发送的新行最大数量。
PidFile PID 文件名。
RefreshActiveChecks 刷新主动检查列表的频率。
Server 以逗号分隔的 IP 地址列表,可选使用 CIDR 表示法,或 Zabbix 服务器和 Zabbix proxy 的 DNS 名称。
ServerActive 用于获取主动检查的 Zabbix 服务器/proxy 地址或集群配置。
SourceIP 源 IP 地址。
StartAgents 处理被动检查的 zabbix_agentd 预先 fork 的实例数量。
Timeout 指定与 Zabbix proxy 或服务器建立连接并交换数据时的等待时间(秒)。
TLSAccept 入站连接所需的加密级别。
TLSCAFile 包含用于对等证书验证的顶级 CA 证书的文件完整路径名,用于 Zabbix 组件之间的加密通信。
TLSCertFile 包含 agent 证书或证书链的文件完整路径名,用于 Zabbix 组件之间的加密通信。
TLSCipherAll GnuTLS 优先级字符串或 OpenSSL (TLS 1.2) 密码字符串。覆盖基于证书和 PSK 的加密的默认密码套件选择标准。
TLSCipherAll13 适用于 TLS 1.3 中 OpenSSL 1.1.1 或更新版本的密码字符串。覆盖基于证书和 PSK 的加密的默认密码套件选择标准。
TLSCipherCert GnuTLS 优先级字符串或 OpenSSL (TLS 1.2) 密码字符串。覆盖基于证书的加密的默认密码套件选择标准。
TLSCipherCert13 适用于 TLS 1.3 中 OpenSSL 1.1.1 或更新版本的密码字符串。覆盖基于证书的加密的默认密码套件选择标准。
TLSCipherPSK GnuTLS 优先级字符串或 OpenSSL (TLS 1.2) 密码字符串。覆盖基于 PSK 的加密的默认密码套件选择标准。
TLSCipherPSK13 适用于 TLS 1.3 中 OpenSSL 1.1.1 或更新版本的密码字符串。覆盖基于 PSK 的加密的默认密码套件选择标准。
TLSConnect agent 连接到 Zabbix 服务器或 proxy 所需的加密级别。
TLSCRLFile 包含已吊销证书的文件完整路径名。此参数用于 Zabbix 组件之间的加密通信。
TLSKeyFile 包含 agent 私钥的文件完整路径名,用于 Zabbix 组件之间的加密通信。
TLSPSKFile 包含 agent 预共享密钥的文件完整路径名,用于与 Zabbix 服务器或 proxy 的加密通信。
TLSPSKIdentity 预共享密钥标识字符串,用于与 Zabbix 服务器或 proxy 的加密通信。
TLSServerCertIssuer 允许的服务器(proxy)证书颁发者。
TLSServerCertSubject 允许的服务器(proxy)证书主题。
UnsafeUserParameters 允许在传递给用户自定义参数的参数中使用所有字符。
User 将权限降级为系统中某个特定的、已存在的用户。
UserParameter 要监控的用户自定义参数。
UserParameterDir UserParameter 命令的默认搜索路径。

除非明确说明某个参数为必填,否则所有参数均为非必填。

请注意:

  • 默认值反映的是守护进程默认值,而不是随软件包提供的配置文件中的值;
  • Zabbix 仅支持 UTF-8 编码且不带 BOM 的配置文件;
  • # 开头的注释仅支持位于行首。

参数详情

别名

为监控项键设置一个别名。 它可用于用更短、更简单的键替代较长且复杂的监控项键。
可以存在多个 Alias 参数。 不允许存在具有相同 Alias 键的多个参数。
不同的 Alias 键可以引用同一个监控项键。
别名可用于 HostMetadataItem,但不能用于 HostnameItem 参数。

示例 1:检索用户 zabbix 的 ID。

Alias=zabbix.userid:vfs.file.regexp[/etc/passwd,"^zabbix:.:([0-9]+)",,,,\1]

现在可以使用 zabbix.userid 简写键来检索数据。

示例 2:使用默认和自定义参数获取 CPU 利用率。

Alias=cpu.util:system.cpu.util
Alias=cpu.util[*]:system.cpu.util[*]

这样就可以使用 cpu.util 键通过默认参数获取 CPU 利用率百分比,也可以使用 cpu.util[all, idle, avg15] 获取有关 CPU 利用率的特定数据。

示例 3:运行多个 低级别发现 规则来处理相同的发现项。

Alias=vfs.fs.discovery[*]:vfs.fs.discovery

现在可以使用 vfs.fs.discovery 并为每条规则设置不同参数来配置多个发现规则,例如 vfs.fs.discovery[foo]vfs.fs.discovery[bar] 等。

AllowKey

允许执行与某个模式匹配的监控项键。 该键模式是一个通配符表达式,支持 * 字符来匹配任意数量的任意字符。
可与 DenyKey 结合定义多个键匹配规则。 参数会按照其出现顺序逐一处理。 另请参见:限制 agent 检查

AllowRoot

允许agent以'root'身份run运行。 若禁用此选项且agent由'root'启动时,agent将尝试切换至'zabbix'用户运行。 若以普通用户身份启动则此设置无效。

默认值: 0
可选值: 0 - 不允许; 1 - 允许

BufferSend

在缓冲区中保留数据不超过N秒。

默认值:5
范围:1-3600

BufferSize

memory缓冲区中存储的最大值数量。 当缓冲区满时,agent会将所有收集的数据发送至Zabbix server或proxy。

默认值: 100
范围: 2-65535

DebugLevel

指定调试级别:

  • 0 - 关于 Zabbix 进程启动和停止的基本信息;
  • 1 - 关键信息;
  • 2 - 错误信息;
  • 3 - 警告;
  • 4 - 用于调试(会产生大量信息);
  • 5 - 扩展调试(会产生更多信息)。

默认值:3
范围:0-5

DenyKey

拒绝执行与模式匹配的监控项键。 键模式是一个通配符表达式,支持 * 字符来匹配任意数量的任意字符。
可与 AllowKey 结合定义多个键匹配规则。 参数会按照其出现顺序逐个处理。 另请参见:限制 agent 检查

EnableRemoteCommands

允许来自 Zabbix 服务器的远程命令。
此参数已弃用,请改用 AllowKey=system.run[*]DenyKey=system.run[*]
它是 AllowKey/DenyKey 参数的内部别名,具体取决于取值:

  • 0 - DenyKey=system.run[*]
  • 1 - AllowKey=system.run[*]

默认值:0
取值:0 - 不允许,1 - 允许

HeartbeatFrequency

心跳消息的频率(以秒为单位)。 用于监控主动检查的可用性。
0 - 表示禁用心跳消息。

默认值:60
范围:0-3600

HostInterface

一个可选参数,用于定义在主机 自动注册 过程中使用的主机接口(IP 地址或 DNS 名称)。 该值将用于填充新创建主机中的接口,并允许显式配置 IP 或 DNS 地址。 有关更多详细信息,请参见 将 DNS 用作默认接口

如果未定义,该值将从 HostInterfaceItem 获取。

如果该值超过 255 个字符的限制,agent 将报错且不会启动。

范围:0-255 个字符

HostInterfaceItem

一个可选参数,用于定义在主机 自动注册 过程中,用来确定主机接口(IP 地址或 DNS 名称)的监控项。 仅当未定义 HostInterface 时,才会使用此值。 有关更多详细信息,请参见 将 DNS 用作默认接口

在自动注册请求期间,如果指定监控项返回的值超过 255 个字符的限制,agent 将记录一条警告消息。

无论 AllowKey/DenyKey 设置如何,都会支持 system.run[] 监控项。

HostMetadata

一个可选参数,用于定义在主机自动注册过程中用于识别或区分主机的元数据(主动 agent)。 HostMetadata 允许在主机名之外进一步区分不同主机。

如果未定义,该值将从 HostMetadataItem 获取。

如果指定的值超过 2034 字节,或者是非 UTF-8 字符串,agent 将报错且不会启动。 当某个参数期望的是 IP 地址或 DNS 名称时,虽然值可能是有效的 UTF-8,但如果不是有效的 IP 或 DNS 名称,也会被拒绝并报告为无效。

不支持多行元数据 — 输出将在第一个换行处被截断。

范围:0-2034 字节

HostMetadataItem

一个可选参数,用于定义一个 Zabbix agent 监控项,该监控项用于获取 主机元数据。 仅当未定义 HostMetadata 时,才会使用此选项。

HostMetadataItem 的值会在每次 自动注册 尝试时获取,并且仅在主机自动注册流程中使用(active agent)。 HostMetadataItem 允许在主机名之外进一步区分不同的主机。

支持用户参数和别名。 无论 AllowKey/DenyKey 设置如何,均支持 system.run[] 监控项。

在自动注册请求期间,如果指定监控项返回的值超过 65535 个 UTF-8 码点的限制,agent 将记录一条警告消息。 监控项返回的值必须是 UTF-8 字符串,否则将被忽略。 当某个参数期望的是 IP 地址或 DNS 名称时,虽然值可能是有效的 UTF-8,但如果不是有效的 IP 或 DNS 名称,也会被拒绝并报告为无效。

不支持多行元数据 — 输出将在第一个换行处被截断。

主机名

以逗号分隔的唯一、区分大小写的主机名列表。 主动检查必填,且必须与服务器上配置的主机名一致。 如果未定义,则从 HostnameItem 获取该值。
允许的字符:字母数字、'.'、' '、'_' 和 '-'。 每个主机名的最大长度为 128 个字符,整行最大长度为 2048 个字符。

默认值:由 HostnameItem 设置

HostnameItem

一个可选参数,用于定义一个 Zabbix agent 监控项,以获取主机名。 仅当未定义 Hostname 时,才会使用此选项。 不支持用户参数或别名,但无论 AllowKey/DenyKey 值如何,system.run[] 监控项都受支持。

默认值:system.hostname

Include

您可以在配置file中包含单个文件或目录中的所有文件。 为了仅包含指定目录中的相关文件,支持使用星号通配符进行模式匹配。
有关限制,请参阅special notes

示例:

Include=/absolute/path/to/config/files/*.conf
ListenBacklog

TCP队列中待处理连接的最大数量。
默认值为硬编码常量,具体取决于系统。
支持的最大值也取决于系统,过高的值可能会被静默截断为"实现指定的最大值"。

默认值:SOMAXCONN
范围:0 - INT_MAX

ListenIP

一个逗号分隔的IP地址列表,agent应监听这些地址。

默认值:0.0.0.0

ListenPort

agent将在此端口监听来自服务器的连接。

默认值:10050
范围:1024-32767

LoadModule

在 agent 启动时加载的模块。 模块用于扩展 agent 的功能。 模块必须位于 LoadModulePath 指定的目录中,或者路径必须位于模块名称之前。 如果前面的路径是绝对路径(以 / 开头),则会忽略 LoadModulePath
格式:

  • LoadModule=<module.so>
  • LoadModule=<path/module.so>
  • LoadModule=</abs_path/module.so>

允许包含多个 LoadModule 参数。

LoadModulePath

agent模块所在位置的完整路径。 默认值取决于编译选项。

LogFile

日志文件的名称。

必填:是,如果 LogType 设置为 file;否则不是

LogFileSize

日志file的最大大小(单位:MB)。
0 - 禁用自动日志轮转。
注意:如果日志file大小达到限制且file轮转失败(无论何种原因),现有日志file将被截断并重新开始记录。

默认值:1
范围:0-1024

LogRemoteCommands

启用将已执行的 shell 命令作为警告进行记录。
仅当命令是远程执行时才会记录。
如果 system.run[]HostMetadataItemHostInterfaceItemHostnameItem 参数在本地启动,则不会创建日志条目。

默认值: 0
取值: 0 - 禁用,1 - 启用

LogType

日志输出类型:

  • file - 将日志写入 LogFile 参数指定的文件;
  • system - 将日志写入 syslog;
  • console - 将日志写入标准输出。

默认值:file

MaxLinesPerSecond

agent 在处理 loglogrt 主动检查时,每秒向 Zabbix 服务器或 proxy 发送的新行最大数量。 所提供的值将被 loglogrt 监控项键中的 maxlines 参数覆盖。
注意: Zabbix 处理的新行数量将是 MaxLinesPerSecond 设置值的 10 倍,以便在日志监控项中查找所需字符串。

默认值: 20
范围: 1-1000

PidFile

PID名称file.

默认值: /tmp/zabbix_agentd.pid

RefreshActiveChecks

主动检查列表的刷新频率,以秒为单位。 请注意,若主动检查刷新失败,下一次刷新尝试将在60秒后进行。

默认值:5
范围:1-86400

服务器

以逗号分隔的 IP 地址列表,可选使用 CIDR 表示法,或 Zabbix 服务器和 Zabbix proxy 的 DNS 名称。 仅会接受来自此处列出的主机的传入连接。 如果启用了 IPv6 支持,则 127.0.0.1::127.0.0.1::ffff:127.0.0.1 会被视为相同,且 ::/0 将允许任何 IPv4 或 IPv6 地址。 0.0.0.0/0 可用于允许任何 IPv4 地址。 请注意,“IPv4-compatible IPv6 addresses”(0000::/96 前缀)受支持,但已被 RFC4291 弃用。 允许使用空格。

示例:

Server=127.0.0.1,192.168.1.0/24,::1,2001:db8::/32,zabbix.example.com

必填:是,如果未将 StartAgents 显式设置为 0

ServerActive

用于获取主动监控项的 Zabbix 服务器/proxy 地址或集群配置。 服务器/proxy 地址是 IP 地址或 DNS 名称,端口可选,使用冒号分隔。
集群配置是一个或多个服务器或 proxy 组成员地址,使用分号分隔。 可以指定多个 Zabbix 服务器/集群和 Zabbix proxy,使用逗号分隔。 除非使用 proxy 组,否则每个 Zabbix 服务器/集群不应指定多个 Zabbix proxy。 如果指定了 Zabbix proxy,则不应再为该 proxy 指定 Zabbix 服务器/集群。
可以提供多个以逗号分隔的地址,以便并行使用多个独立的 Zabbix 服务器。 允许使用空格。
如果未指定端口,则使用默认端口。
如果为该主机指定了端口,则 IPv6 地址必须用方括号括起来。 如果未指定端口,则 IPv6 地址的方括号为可选。
如果未指定此参数,则会禁用主动监控项。

Zabbix proxy 示例:

ServerActive=127.0.0.1:10051

Zabbix proxy 组示例:

ServerActive=proxy1.example.com;proxy2.example.com;proxy3.example.com;proxy4.example.com;proxy5.example.com

多个服务器示例:

ServerActive=127.0.0.1:20051,zabbix.domain,[::1]:30051,::1,[12fc::1]

高可用示例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051;zabbix.cluster.node3

包含两个集群和一台服务器的高可用示例:

ServerActive=zabbix.cluster.node1;zabbix.cluster.node2:20051,zabbix.cluster2.node1;zabbix.cluster2.node2,zabbix.domain
SourceIP

用于以下场景的源 IP 地址:

  • 到 Zabbix 服务器或 Zabbix proxy 的出站连接;
  • 在执行某些监控项(web.page.getnet.tcp.port 等)时建立连接。
StartAgents

处理被动检查的 zabbix_agentd 预先 fork 的实例数量。 如果设置为 0,则会禁用被动检查,agent 将不会监听任何 TCP 端口。

默认值:10
范围:0-100

Timeout

指定与Zabbix proxy或服务器建立连接及交换数据的等待时间(秒)。

该参数定义各类通信操作的最长持续时间,包括:

  • 等待Zabbix server响应;
  • 向Zabbix server发送请求(含监控项配置请求及主动检查中的监控项数据);
  • 通过日志文件检索日志数据;
  • 发送心跳消息;
  • vfs.*检查的最大持续时间;
  • 被Zabbix agent模块使用;
  • 作为version 7.0以下版本的server 或 proxy发送无超时检查时的后备机制。

该超时设置适用于在前端(全局、proxy或单个监控项层级)可配置超时的agent检查项。

默认值:3
取值范围:1-30

TLSAccept

传入连接所需的加密级别。
用于被动检查。
可以指定多个值,并用逗号分隔:

  • unencrypted - 接受未加密连接(默认);
  • psk - 接受使用 TLS 和预共享密钥(PSK)的连接;
  • cert - 接受使用 TLS 和证书的连接。

必填:是,如果定义了 TLS 证书或 PSK 参数(即使是 unencrypted 连接);否则为否

TLSCAFile

包含用于对等证书验证的Top级CA证书的file完整路径名,用于Zabbix组件之间的加密通信。

TLSCertFile

包含file的完整路径名,其中含有用于与Zabbix组件进行加密通信的agent证书或证书链。

TLSCipherAll

GnuTLS优先级string或OpenSSL(TLS 1.2)加密套件string。 覆盖基于证书和PSK加密的默认加密套件选择标准。

示例:

TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
TLSCipherAll13

OpenSSL 1.1.1或更高版本在TLS 1.3中使用的密码套件string。 覆盖基于证书和PSK加密的默认密码套件选择标准。

GnuTLS示例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL::+SIGN-ALL:+CTYPE-X.509

OpenSSL示例:

EECDH+aRSA+AES128:RSA+aRSA+AES128:kECDHEPSK+AES128:kPSK+AES128
TLSCipherCert

GnuTLS优先级string或OpenSSL(TLS 1.2)加密套件string。 覆盖基于证书加密的默认加密套件选择标准。

GnuTLS示例:

NONE:+VERS-TLS1.2:+ECDHE-RSA:+RSA:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL:+CTYPE-X.509

OpenSSL示例:

EECDH+aRSA+AES128:RSA+aRSA+AES128
TLSCipherCert13

OpenSSL 1.1.1或更高版本在TLS 1.3中使用的密码套件string。 覆盖基于证书加密的默认密码套件选择标准。

TLSCipherPSK

GnuTLS优先级string或OpenSSL(TLS 1.2)加密套件string。 覆盖基于PSK加密的默认加密套件选择标准。

GnuTLS示例:

NONE:+VERS-TLS1.2:+ECDHE-PSK:+PSK:+AES-128-GCM:+AES-128-CBC:+AEAD:+SHA256:+SHA1:+CURVE-ALL:+COMP-NULL:+SIGN-ALL

OpenSSL示例:

kECDHEPSK+AES128:kPSK+AES128
TLSCipherPSK13

OpenSSL 1.1.1或更高版本中TLS 1.3使用的密码套件string。 覆盖基于PSK加密的默认密码套件选择标准。

示例:

TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
TLSConnect

agent 与 Zabbix 服务器或 proxy 连接时所需的加密级别。
用于主动检查。
只能指定一个值:

  • unencrypted - 不使用加密连接(默认);
  • psk - 使用 TLS 和预共享密钥(PSK)连接;
  • cert - 使用 TLS 和证书连接。

必填:是,如果定义了 TLS 证书或 PSK 参数(即使是 unencrypted 连接);否则为否

TLSCRLFile

包含已撤销证书的file的完整路径名。 该参数用于Zabbix组件之间的加密通信。

TLSKeyFile

包含用于Zabbix组件间加密通信的agent私钥的file完整路径名。

TLSPSKFile

包含 agent 预共享密钥的文件的完整路径名,用于与 Zabbix 服务器或 proxy 进行加密通信。

TLSPSKIdentity

用于与 Zabbix 服务器或 proxy 进行加密通信的预共享密钥标识字符串。

TLSServerCertIssuer

允许的服务器(proxy)证书颁发机构。

TLSServerCertSubject

允许的服务器(proxy)证书主题。

UnsafeUserParameters

允许在用户自定义参数参数中传递所有字符。 以下字符不允许使用:\ ' " ` * ? [ ] { } \~ $ ! & ; ( ) < > | # @
此外,换行符也不允许使用。

默认值:0
取值:0 - 不允许,1 - 允许

用户

将权限降级为系统中某个已存在的特定用户。
仅在以 root 运行且 AllowRoot 被禁用时生效。

默认值:zabbix

UserParameter

用于监控的用户自定义参数。 可以定义多个用户自定义参数。
格式: UserParameter=<键值>,<shell命令>
注意shell命令不能返回空的string或仅包含EOL。 如果指定了UserParameterDir参数,shell命令可以使用相对路径。

示例:

UserParameter=system.test,who|wc -l
UserParameter=check_cpu,./custom_script.sh
UserParameterDir

UserParameter 命令的默认搜索路径。 如果使用此参数,agent 会在执行命令之前将其工作目录切换到此处指定的目录。 因此,UserParameter 命令可以使用相对的 ./ 前缀,而不必使用完整路径。
只允许设置一项。

示例:

UserParameterDir=/opt/myscripts

另请参阅

  1. Differences in the Zabbix agent configuration for active and passive checks starting from version 2.0.0