:plugin: lumberjack
:type: input

///////////////////////////////////////////
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}-{plugin}"]

=== Lumberjack input plugin

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

==== Description

Receive events using the Lumberjack protocol.

This input can be used to reliably and securely transport
events between Logstash instances. To do so, use the
<<plugins-outputs-lumberjack,lumberjack output plugin>>
in the sending Logstash instance(s).

It can also be used to receive events from the deprecated
https://github.com/elastic/logstash-forwarder[logstash-forwarder]
tool that has been replaced by
https://github.com/elastic/beats/tree/master/filebeat[Filebeat].


[id="plugins-{type}s-{plugin}-options"]
==== Lumberjack Input 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}-congestion_threshold>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
| <<plugins-{type}s-{plugin}-ssl_certificate>> |a valid filesystem path|Yes
| <<plugins-{type}s-{plugin}-ssl_key>> |a valid filesystem path|Yes
| <<plugins-{type}s-{plugin}-ssl_key_passphrase>> |<<password,password>>|No
|=======================================================================

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

&nbsp;

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

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

The number of seconds before we raise a timeout,
this option is useful to control how much time to wait if something is blocking the pipeline.

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

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

The IP address to listen on.

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

  * This is a required setting.
  * Value type is <<number,number>>
  * There is no default value for this setting.

The port to listen on.

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

  * This is a required setting.
  * Value type is <<path,path>>
  * There is no default value for this setting.

SSL certificate to use.

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

  * This is a required setting.
  * Value type is <<path,path>>
  * There is no default value for this setting.

SSL key to use.

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

  * Value type is <<password,password>>
  * There is no default value for this setting.

SSL key passphrase to use.



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