IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« xmpp zeromq »
Elastic Docs ›Logstash Reference [1.5] ›Logstash Reference ›Output plugins

zabbix

edit

zabbix

edit

This is a community-maintained plugin! It does not ship with Logstash by default, but it is easy to install by running bin/plugin install logstash-output-zabbix.

The Zabbix output is used to send item data (key/value pairs) to a Zabbix server. The event @timestamp will automatically be associated with the Zabbix item data.

The Zabbix Sender protocol is described at https://www.zabbix.org/wiki/Docs/protocols/zabbix_sender/2.0 Zabbix uses a kind of nested key/value store.

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

Each "host" is an identifier, and each item is associated with that host. Items are typed on the Zabbix side. You can send numbers as strings and Zabbix will Do The Right Thing.

In the Zabbix UI, ensure that your hostname matches the value referenced by zabbix_host. Create the item with the key as it appears in the field referenced by zabbix_key. In the item configuration window, ensure that the type dropdown is set to Zabbix Trapper. Also be sure to set the type of information that Zabbix should expect for this item.

This plugin does not currently send in batches. While it is possible to do so, this is not supported. Be careful not to flood your Zabbix server with too many events per second.

This plugin will log a warning if a necessary field is missing. It will not attempt to resend if Zabbix is down, but will log an error message.

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

zabbix {
    zabbix_host => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

multi_value

array

No

timeout

number

No

1

workers

number

No

1

zabbix_host

string

Yes

zabbix_key

string

No

zabbix_server_host

string

No

"localhost"

zabbix_server_port

number

No

10051

zabbix_value

string

No

"message"

Details

edit

 

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

exclude_tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

multi_value

edit
  • Value type is array
  • There is no default value for this setting.

Use the multi_value directive to send multiple key/value pairs. This can be thought of as an array, like:

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

…​where zabbix_key1 is an instance of zabbix_key, and zabbix_value1 is an instance of zabbix_value. If the field referenced by any zabbix_key or zabbix_value does not exist, that entry will be ignored.

This directive cannot be used in conjunction with the single-value directives zabbix_key and zabbix_value.

tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

timeout

edit
  • Value type is number
  • Default value is 1

The number of seconds to wait before giving up on a connection to the Zabbix server. This number should be very small, otherwise delays in delivery of other outputs could result.

type (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s type attribute for more. Optional.

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

zabbix_host

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The field name which holds the Zabbix host name. This can be a sub-field of the @metadata field.

zabbix_key

edit
  • Value type is string
  • There is no default value for this setting.

A single field name which holds the value you intend to use as the Zabbix item key. This can be a sub-field of the @metadata field. This directive will be ignored if using multi_value

zabbix_server_host

edit
  • Value type is string
  • Default value is "localhost"

The IP or resolvable hostname where the Zabbix server is running

zabbix_server_port

edit
  • Value type is number
  • Default value is 10051

The port on which the Zabbix server is running

zabbix_value

edit
  • Value type is string
  • Default value is "message"

The field name which holds the value you want to send. This directive will be ignored if using multi_value

« xmpp zeromq »