Zabbix 输出插件

编辑
  • 插件版本:v3.0.5
  • 发布时间:2018-04-06
  • 变更日志

其他版本,请参见 版本化插件文档

安装

编辑

对于默认情况下未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-zabbix 来轻松安装。更多详情,请参见 使用插件

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛中发帖提问。如发现错误或有功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

Zabbix 输出用于将项目数据(键值对)发送到 Zabbix 服务器。事件 @timestamp 将自动与 Zabbix 项目数据关联。

Zabbix 发送器协议的描述,请参见 https://www.zabbix.org/wiki/Docs/protocols/zabbix_sender/2.0 Zabbix 使用一种嵌套的键值存储。

    host
      ├── item1
      │     └── value1
      ├── item2
      │     └── value2
      ├── ...
      │     └── ...
      ├── item_n
      │     └── value_n

每个“主机”都是一个标识符,每个项目都与该主机关联。项目在 Zabbix 端进行类型化。您可以将数字作为字符串发送,Zabbix 将执行正确的操作。

在 Zabbix UI 中,确保您的主机名与 zabbix_host 引用的值匹配。创建项目,键值与 zabbix_key 引用的字段中显示的键值相同。在项目配置窗口中,确保类型下拉菜单设置为 Zabbix Trapper。还要确保设置 Zabbix 应为此项目预期的信息类型。

此插件目前不支持批量发送。虽然可以这样做,但这不受支持。注意不要每秒向您的 Zabbix 服务器发送过多的事件。

如果缺少必要的字段,此插件将记录警告。如果 Zabbix 宕机,它不会尝试重新发送,但会记录错误消息。

Zabbix 输出配置选项

编辑

此插件支持以下配置选项以及稍后描述的 通用选项

另请参见 通用选项,了解所有输出插件支持的选项列表。

 

multi_value

编辑
  • 值类型为 数组
  • 此设置没有默认值。

使用 multi_value 指令发送多个键值对。这可以认为是一个数组,例如

[ zabbix_key1, zabbix_value1, zabbix_key2, zabbix_value2, ... zabbix_keyN, zabbix_valueN ]

…其中 zabbix_key1zabbix_key 的一个实例,zabbix_value1zabbix_value 的一个实例。如果任何 zabbix_keyzabbix_value 引用的字段不存在,则将忽略该条目。

此指令不能与单值指令 zabbix_keyzabbix_value 结合使用。

timeout

编辑
  • 值类型为 数字
  • 默认值为 1

等待放弃与 Zabbix 服务器连接的秒数。此数字应非常小,否则可能会导致其他输出的延迟。

zabbix_host

编辑
  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

保存 Zabbix 主机名的字段名称。这可以是 @metadata 字段的子字段。

zabbix_key

编辑
  • 值类型为 字符串
  • 此设置没有默认值。

保存您打算用作 Zabbix 项目键的值的单个字段名称。这可以是 @metadata 字段的子字段。如果使用 multi_value,则将忽略此指令。

如果不使用 multi_value,则需要 zabbix_key

zabbix_server_host

编辑
  • 值类型为 字符串
  • 默认值为 "localhost"

运行 Zabbix 服务器的 IP 或可解析的主机名

zabbix_server_port

编辑
  • 值类型为 数字
  • 默认值为 10051

Zabbix 服务器运行的端口

zabbix_value

编辑
  • 值类型为 字符串
  • 默认值为 "message"

保存您要发送的值的字段名称。如果使用 multi_value,则将忽略此指令。

通用选项

编辑

所有输出插件都支持这些配置选项

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为 codec
  • 默认值为 "plain"

用于输出数据的编解码器。输出编解码器是在数据离开输出之前对其进行编码的一种便捷方法,无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以为特定插件禁用指标收集。

  • 值类型为 字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您具有两种或更多相同类型的插件时,这尤其有用。例如,如果您有两个 zabbix 输出。在这种情况下,添加命名 ID 将有助于在使用监控 API 监控 Logstash 时提供帮助。

output {
  zabbix {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。