IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Mongodb output plugin Nagios_nsca output plugin »

› ›

Nagios output plugin

edit

Nagios output plugin

edit

Plugin version: v3.0.6
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-nagios. 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 Nagios output is used for sending passive check results to Nagios via the Nagios command file. This output currently supports Nagios 3.

For this output to work, your event must have the following Logstash event fields:

nagios_host
nagios_service

These Logstash event fields are supported, but optional:

nagios_annotation
nagios_level (overrides nagios_level configuration option)

There are two configuration options:

commandfile - The location of the Nagios external command file. Defaults to /var/lib/nagios3/rw/nagios.cmd
nagios_level - Specifies the level of the check to be sent. Defaults to CRITICAL and can be overriden by setting the "nagios_level" field to one of "OK", "WARNING", "CRITICAL", or "UNKNOWN"
```
    output{
      if [message] =~ /(error|ERROR|CRITICAL)/ {
        nagios {
          # your config here
        }
      }
    }
```

Nagios Output Configuration Options

edit

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

Setting	Input type	Required
`commandfile`	<<,>>	No
`nagios_level`	string, one of `["0", "1", "2", "3"]`	No

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

`commandfile`

edit

Value type is string
Default value is "/var/lib/nagios3/rw/nagios.cmd"

The full path to your Nagios command file.

`nagios_level`

edit

Value can be any of: 0, 1, 2, 3
Default value is "2"

The Nagios check level. Should be one of 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN. Defaults to 2 - CRITICAL.

Common Options

edit

The following 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 nagios outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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

« Mongodb output plugin Nagios_nsca output plugin »