5 Zabbix agent (Windows)

概述

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

这些参数仅列出名称，不包含额外信息。
点击参数可查看完整详情。

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

注意：

• 默认值反映的是守护进程默认值，而不是随软件包提供的配置文件中的值；
• Zabbix 仅支持 UTF-8 编码的配置文件，不支持带 BOM；
• 以 # 开头的注释仅支持出现在行首。

参数详情

别名

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

示例 1：从服务器检索分页文件使用率百分比。

Alias=pg_usage:perf_counter[\Paging File(_Total)\% Usage]

现在可以使用简写键 pg_usage 来检索数据。

示例 2：使用默认参数和自定义参数获取 CPU 负载。

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

这样既可以使用 cpu.load 键获取带默认参数的 CPU 负载，也可以使用 cpu.load[percpu,avg15] 获取有关 CPU 负载的特定数据。

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

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

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

AllowKey

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

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 设置

主机名监控项

一个可选参数，用于定义一个 Zabbix agent 监控项，以获取主机名。 仅当未定义 Hostname 时使用此选项。 不支持用户参数、性能计数器或别名，但无论 AllowKey/DenyKey 的值如何，[system.run[]](/manual/config/items/itemtypes/zabbix_agent#system.run) 监控项都受支持。
另请参阅更详细的说明。

默认值：system.hostname

Include

您可以在配置文件file中包含单个文件或目录中的所有文件（如果Zabbix agent通过Windows MSI安装包安装，默认位于C:\Program Files\Zabbix Agent；如果Zabbix agent以zip压缩包形式安装，则位于安装时指定的文件夹）。 所有被包含的文件必须具有 正确的语法，否则agent将无法启动。
若仅需包含指定目录中的相关文件，支持使用星号通配符进行模式匹配。
有关限制条件，请参阅special notes。

示例：

Include=C:\Program Files\Zabbix Agent\zabbix_agentd.d\*.conf

ListenBacklog

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

默认值：SOMAXCONN
范围：0 - INT_MAX

ListenIP

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

默认值: 0.0.0.0

监听端口

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

默认值：10050
范围：1024-32767

LogFile

agent 日志文件的名称。

默认值：c:\zabbix_agentd.log
必填：是，如果 LogType 设置为 file；否则为否

日志文件大小

日志 file 的最大大小（以 MB 为单位）。
0 - 禁用自动日志轮换。
注意：如果达到日志 file 大小限制并且由于任何原因导致 file 轮换失败，则现有的日志 file 将被截断并重新开始。

默认值: 1
范围: 0-1024

LogRemoteCommands

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

默认值：0
取值：0 - 禁用，1 - 启用

LogType

日志输出类型：

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

默认值：file

MaxLinesPerSecond

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

默认值：20
范围：1-1000

PerfCounter

定义一个新参数 <parameter_name>，它是指定时间段 <period>（以秒为单位）内系统性能计数器 <perf_counter_path> 的平均值。
语法：<parameter_name>,"<perf_counter_path>",<period>

例如，如果您希望获取最近一分钟内每秒处理器中断的平均次数，可以将新参数 "interrupts" 定义如下：

PerfCounter = interrupts,"\Processor(0)\Interrupts/sec",60

请注意性能计数器路径周围的双引号。 参数名称（interrupts）在创建监控项时用作监控项键值。 用于计算平均值的样本将每秒采集一次。
您可以运行 typeperf -qx 来获取 Windows 中所有可用性能计数器的列表。

PerfCounterEn

定义一个新参数<parameter_name>，该参数表示系统性能计数器<perf_counter_path>在指定时间段<period>（以秒为单位）内的平均值。 与PerfCounter相比，perfcounter路径必须使用英文。 仅支持在Windows Server 2008/Vista及更高版本上运行。
语法：<parameter_name>,"<perf_counter_path>",<period>

例如，如果您希望获取过去一分钟内处理器每秒中断次数的平均值，可以按以下方式定义一个名为"interrupts"的新参数：

PerfCounterEn = interrupts,"\Processor(0)\Interrupts/sec",60

请注意性能计数器路径两侧的双引号。 参数名称(interrupts)在创建监控项时应作为监控项键使用。 系统将每秒采集一次样本用于计算平均值。
您可以通过查看以下注册表项来获取英文字符串列表：HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib\009。

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.get、net.tcp.port 等）时建立连接。

StartAgents

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

默认值：10
范围：0-100 (*)

Timeout

指定建立连接以及与Zabbix proxy或服务器交换数据时等待的时长（以秒为单位）。
此参数用于定义以下各类操作的持续时间：

• 等待来自Zabbix server的响应；
• 向Zabbix server发送请求，包括主动检查配置请求和监控项数据；
• 通过logfile或Windows事件日志监控检索日志数据；
• 发送心跳消息；
• vfs.*检查的最大持续时间；
• 被Zabbix agent模块使用；
• 在server/proxy早于version 7.0发送无超时检查的情况下，也作为后备设置。

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

TLSAccept

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

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

必填：是，如果定义了 TLS 证书或 PSK 参数（即使是 unencrypted 连接）；否则为否

TLSCAFile

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

TLSCertFile

用于与 Zabbix 组件进行加密通信的 file 的完整路径名，该文件包含 agent 证书或证书链。

TLSConnect

agent 连接到 Zabbix 服务器或 proxy 所需的加密级别。
用于主动监控项。
只能指定一个值：

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

必填：是，如果定义了 TLS 证书或 PSK 参数（即使是 unencrypted 连接）；否则为否

TLSCRLFile

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

TLSKeyFile

用于存储 Zabbix 组件之间加密通信所使用的 agent 私钥的 file 的完整路径名。

TLSPSKFile

包含用于与Zabbix server进行加密通信的agent预共享密钥的file的完整路径名。

TLSPSKIdentity

预共享密钥标识 string，用于与 Zabbix server 进行加密通信。

TLSServerCertIssuer

允许的服务器（proxy）证书颁发者。

TLSServerCertSubject

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

UnsafeUserParameters

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

默认值：0
可选值：0 - 不允许，1 - 允许

UserParameter

用于监控的用户自定义参数。 可以有多个用户自定义参数。
格式：UserParameter=<key>,<shell command>
请注意，shell 命令不能只返回空字符串或仅返回 EOL。 如果指定了 UserParameterDir 参数，shell 命令可以使用相对路径。

示例：

UserParameter=system.test,dir /b | find /c /v ""
UserParameter=check_cpu,.\custom\_script.bat

UserParameterDir

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

示例：

UserParameterDir=C:\opt\myscripts