IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« log4j meetup »
Elastic Docs ›Logstash Reference [5.0] ›Input plugins

lumberjack

edit

lumberjack

edit

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 lumberjack output plugin in the sending Logstash instance(s).

It can also be used to receive events from the deprecated logstash-forwarder tool that has been replaced by Filebeat.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

lumberjack {
    port => ...
    ssl_certificate => ...
    ssl_key => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

congestion_threshold

number

No

5

host

string

No

"0.0.0.0"

port

number

Yes

ssl_certificate

a valid filesystem path

Yes

ssl_key

a valid filesystem path

Yes

ssl_key_passphrase

password

No

tags

array

No

type

string

No

Details

edit

 

add_field

edit
  • Value type is hash
  • Default value is {}

Add a field to an event

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

congestion_threshold

edit
  • Value type is 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.

host

edit
  • Value type is string
  • Default value is "0.0.0.0"

The IP address to listen on.

max_clients (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is number
  • There is no default value for this setting.

This setting no longer has any effect and will be removed in a future release.

port

edit
  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

The port to listen on.

ssl_certificate

edit
  • This is a required setting.
  • Value type is path
  • There is no default value for this setting.

SSL certificate to use.

ssl_key

edit
  • This is a required setting.
  • Value type is path
  • There is no default value for this setting.

SSL key to use.

ssl_key_passphrase

edit
  • Value type is password
  • There is no default value for this setting.

SSL key passphrase to use.

tags

edit
  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

type

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« log4j meetup »