Lumberjack input plugin
editLumberjack input plugin
edit- Plugin version: v3.1.6
- Released on: 2019-04-15
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-input-lumberjack
. See Working with plugins for more details.
Getting Help
editFor 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
editReceive 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.
Consider using the Beats input plugin instead. The Beats input implements the Lumberjack protocol v1 and v2.
Lumberjack Input Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
Yes |
||
a valid filesystem path |
Yes |
|
a valid filesystem path |
Yes |
|
No |
Also see Common Options for a list of options supported by all input plugins.
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.
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.
Common Options
editThe following configuration options are supported by all input plugins:
Details
edit
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.
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 lumberjack inputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
input { lumberjack { 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.
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.