This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

› ›

Zabbix output plugin

edit

Zabbix output plugin

edit

Plugin version: v3.0.5
Released on: 2018-04-06
Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-zabbix. See Working with plugins for more details.

Getting help

edit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

edit

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.

Zabbix Output Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting	Input type	Required
`multi_value`	array	No
`timeout`	number	No
`zabbix_host`	string	Yes
`zabbix_key`	string	No
`zabbix_server_host`	string	No
`zabbix_server_port`	number	No
`zabbix_value`	string	No

Also see Common options for a list of options supported by all output plugins.

`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.

`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.

`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_key is required if not 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

Common options

edit

These configuration options are supported by all output plugins:

Setting	Input type	Required
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No

`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.

`enable_metric`

edit

Value type is boolean
Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

`id`

edit

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 zabbix outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

« Xmpp output plugin Filter plugins »