:plugin: nagios_nsca
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Nagios_nsca output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

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:
[source,ruby]
    output {
      nagios_nsca {
        # specify the hostname or ip of your nagios server
        host => "nagios.example.com"

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

[id="plugins-{type}s-{plugin}-options"]
==== Nagios_nsca Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-message_format>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-nagios_host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-nagios_service>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-nagios_status>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-send_nsca_bin>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-send_nsca_config>> |a valid filesystem path|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * Value type is <<string,string>>
  * Default value is `"localhost"`

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

[id="plugins-{type}s-{plugin}-message_format"]
===== `message_format` 

  * Value type is <<string,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.

[id="plugins-{type}s-{plugin}-nagios_host"]
===== `nagios_host` 

  * Value type is <<string,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.

[id="plugins-{type}s-{plugin}-nagios_service"]
===== `nagios_service` 

  * Value type is <<string,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.

[id="plugins-{type}s-{plugin}-nagios_status"]
===== `nagios_status` 

  * This is a required setting.
  * Value type is <<string,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

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * Value type is <<number,number>>
  * Default value is `5667`

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

[id="plugins-{type}s-{plugin}-send_nsca_bin"]
===== `send_nsca_bin` 

  * Value type is <<string,string>>
  * Default value is `"/usr/sbin/send_nsca"`

The path to the 'send_nsca' binary on the local host.

[id="plugins-{type}s-{plugin}-send_nsca_config"]
===== `send_nsca_config` 

  * Value type is <<path,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.



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]