MQTT 插件

概述

配置参数可用于自定义 MQTT plugin 的行为。

建议将这些参数单独放在各自的配置文件中(例如 mqtt.conf),而不是放在 agent 2 配置文件中。然后使用 Include 指令将该文件包含到 Zabbix agent 2 配置中。

除非明确说明该参数为必填,否则所有参数均为可选

本页结构如下:

  • 参数概览(要查看某个参数的完整详情,请点击其名称)
  • 参数详情
Parameter Description
Plugins.MQTT.Default.Password 指定用于连接 MQTT 的默认密码。
Plugins.MQTT.Default.TLSCAFile 指定包含用于对等证书验证的顶级 CA 证书的文件完整路径。
Plugins.MQTT.Default.TLSCertFile 指定包含 agent 证书或证书链的文件完整路径。
Plugins.MQTT.Default.TLSKeyFile 指定包含 MQTT 私钥的文件完整路径。
Plugins.MQTT.Default.Topic 指定 MQTT 订阅的默认主题。
Plugins.MQTT.Default.Url 指定默认的 MQTT broker 连接字符串。
Plugins.MQTT.Default.User 指定用于连接 MQTT 的默认用户名。
Plugins.MQTT.Sessions.<SessionName>.Password 指定用于连接 MQTT 的命名会话密码。
Plugins.MQTT.Sessions.<SessionName>.TLSCAFile 指定包含用于对等证书验证的顶级 CA 证书的文件完整路径,适用于命名会话。
Plugins.MQTT.Sessions.<SessionName>.TLSCertFile 指定包含 agent 证书或证书链的文件完整路径,适用于命名会话。
Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile 指定包含 MQTT 私钥的文件完整路径,适用于命名会话。
Plugins.MQTT.Sessions.<SessionName>.Topic 指定命名会话用于 MQTT 订阅的主题。
Plugins.MQTT.Sessions.<SessionName>.Url 指定命名会话的 MQTT broker 连接字符串。
Plugins.MQTT.Sessions.<SessionName>.User 指定用于连接 MQTT 的命名会话用户名。

请注意:

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

参数详情

Plugins.MQTT.Default.Password

指定用于连接 MQTT 的默认密码。
当监控项键值或命名会话中未指定值时使用。

Plugins.MQTT.Default.TLSCAFile

指定包含用于 Zabbix agent 2 与 MQTT broker 之间加密通信的对等证书验证所需顶级 CA 证书的文件完整路径名。
在命名会话中未指定值时使用。

Plugins.MQTT.Default.TLSCertFile

指定包含 agent 证书或证书链的文件完整路径,用于 Zabbix agent 2 与 MQTT broker 之间的加密通信。
在命名会话中未指定值时使用。

Plugins.MQTT.Default.TLSKeyFile

指定包含 MQTT 私钥文件的完整路径名,用于 Zabbix agent 2 与 MQTT broker 之间的加密通信。
在命名会话中未指定值时使用。

Plugins.MQTT.Default.Topic

指定 MQTT 订阅的默认主题。
当监控项键值或命名会话中未指定值时使用。
主题可以包含通配符(“+”、“#”)。

示例:

path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Default.Url

指定默认的 MQTT broker 连接字符串。
当监控项键值或命名会话中未指定任何值时使用。
不应包含查询参数。
必须符合 URL 格式。
支持的 scheme:tcp(默认)、wstls
可以省略 scheme。
可以省略端口(默认=1883)

默认值:tcp://localhost:1883

示例:

tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Default.User

指定用于连接 MQTT 的默认用户名。
当监控项键或命名会话中未指定值时使用。

Plugins.MQTT.Sessions.<SessionName>.Password

指定用于连接到 MQTT 的命名会话密码。
<SessionName> - 定义一个会话名称,用于监控项键中。

Plugins.MQTT.Sessions.<SessionName>.TLSCAFile

指定包含用于对等证书验证的顶级 CA 证书的文件完整路径名,适用于指定会话,用于 Zabbix agent 2 与 MQTT broker 之间的加密通信。
<SessionName> - 定义一个会话名称,用于监控项键中。

Plugins.MQTT.Sessions.<SessionName>.TLSCertFile

指定包含 agent 证书或证书链的文件完整路径,用于指定会话,在 Zabbix agent 2 与 MQTT broker 之间的加密通信中使用。
<SessionName> - 定义一个会话名称,用于监控项键值中。

Plugins.MQTT.Sessions.<SessionName>.TLSKeyFile

指定包含 MQTT 私钥的文件的完整路径名,用于命名会话,供 Zabbix agent 2 与 MQTT broker 之间的加密通信使用。
<SessionName> - 定义一个会话名称,用于监控项键中。

Plugins.MQTT.Sessions.<SessionName>.Topic

指定用于 MQTT 订阅的命名会话主题。
<SessionName> - 定义会话名称,用于监控项键值中。
该主题可以包含通配符("+"、"#")。

示例:

path/to/file
path/to/#
path/+/topic
Plugins.MQTT.Sessions.<SessionName>.Url

指定命名会话的 MQTT broker 连接字符串。
<SessionName> - 定义一个会话名称,用于监控项键值中。
不应包含查询参数。
必须符合 URL 格式。
支持的协议:tcp(默认)、wstls
可以省略协议。
可以省略端口(默认=1883)

默认:tcp://localhost:1883

示例:

tcp://host:1883
localhost
ws://host:8080
Plugins.MQTT.Sessions.<SessionName>.User

指定用于连接到 MQTT 的命名会话用户名。
<SessionName> - 定义用于监控项键中的会话名称。

如果需要设置请求执行超时(即在关闭请求之前等待其完成的时间),请使用 监控项配置 表单。

另请参见