lumberjackedit

  • Version: 3.1.1
  • Released on: July 14, 2016
  • Changelog

Getting Helpedit

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.

Descriptionedit

Receive events using the lumberjack protocol.

This is mainly to receive events shipped with lumberjack[http://github.com/jordansissel/lumberjack], now represented primarily via the Logstash-forwarder.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

  • 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_thresholdedit

  • 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.

enable_metricedit

  • 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.

hostedit

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

The IP address to listen on.

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

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

portedit

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

The port to listen on.

ssl_certificateedit

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

SSL certificate to use.

ssl_keyedit

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

SSL key to use.

ssl_key_passphraseedit

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

SSL key passphrase to use.

tagsedit

  • 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.

typeedit

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

This is the base class for Logstash inputs. 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.