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.

« Nagios output plugin Opentsdb output plugin »

› ›

Nagios_nsca output plugin

edit

Nagios_nsca output plugin

edit

Plugin version: v3.0.7
Released on: 2021-09-20
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_nsca. 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_nsca output is used for sending passive check results to Nagios through the NSCA protocol.

This is useful if your Nagios server is not the same as the source host from where you want to send logs or alerts. If you only have one server, this output is probably overkill # for you, take a look at the nagios output instead.

Here is a sample config using the nagios_nsca output:

    output {
      nagios_nsca {
        # specify the hostname or ip of your nagios server
        host => "nagios.example.com"

    # specify the port to connect to
    port => 5667
  }
}

Nagios_nsca Output Configuration Options

edit

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

Setting	Input type	Required
`host`	string	No
`message_format`	string	No
`nagios_host`	string	No
`nagios_service`	string	No
`nagios_status`	string	Yes
`port`	number	No
`send_nsca_bin`	string	No
`send_nsca_config`	a valid filesystem path	No

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

`host`

edit

Value type is string
Default value is "localhost"

The nagios host or IP to send logs to. It should have a NSCA daemon running.

`message_format`

edit

Value type is string
Default value is "%{@timestamp} %{host}: %{message}"

The format to use when writing events to nagios. This value supports any string and can include %{name} and other dynamic strings.

`nagios_host`

edit

Value type is string
Default value is "%{host}"

The nagios host you want to submit a passive check result to. This parameter accepts interpolation, e.g. you can use @source_host or other logstash internal variables.

`nagios_service`

edit

Value type is string
Default value is "LOGSTASH"

The nagios service you want to submit a passive check result to. This parameter accepts interpolation, e.g. you can use @source_host or other logstash internal variables.

`nagios_status`

edit

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

The status to send to nagios. Should be 0 = OK, 1 = WARNING, 2 = CRITICAL, 3 = UNKNOWN

`port`

edit

Value type is number
Default value is 5667

The port where the NSCA daemon on the nagios host listens.

`send_nsca_bin`

edit

Value type is string
Default value is "/usr/sbin/send_nsca"

The path to the send_nsca binary on the local host.

`send_nsca_config`

edit

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

The path to the send_nsca config file on the local host. Leave blank if you don’t want to provide a config file.

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

output {
  nagios_nsca {
    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.

« Nagios output plugin Opentsdb output plugin »