Zabbix 输出插件

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

有关其他版本,请参阅版本化插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-zabbix 轻松安装。有关更多详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

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

Zabbix Sender 协议在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。当您有两个或多个相同类型的插件时,这特别有用。例如,如果您有 2 个 zabbix 输出。在这种情况下添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

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

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