Lumberjack output plugin
editLumberjack output plugin
edit- Plugin version: v3.1.8
- Released on: 2021-02-11
- 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-output-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
editThis output sends events using the lumberjack protocol.
Lumberjack Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
Yes |
||
No |
||
Yes |
||
a valid filesystem path |
Yes |
Also see Common Options for a list of options supported by all output plugins.
flush_size
edit- Value type is number
-
Default value is
1024
To make efficient calls to the lumberjack output we are buffering events locally.
if the number of events exceed the number the declared flush_size
we will
send them to the logstash server.
hosts
edit- This is a required setting.
- Value type is array
- There is no default value for this setting.
list of addresses lumberjack can send to
idle_flush_time
edit- Value type is number
-
Default value is
1
The amount of time since last flush before a flush is forced.
This setting helps ensure slow event rates don’t get stuck in Logstash.
For example, if your flush_size
is 100, and you have received 10 events,
and it has been more than idle_flush_time
seconds since the last flush,
Logstash will flush those 10 events automatically.
This helps keep both fast and slow log streams moving along in near-real-time.
Common Options
editThe following configuration options are supported by all output plugins:
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output 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 outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { lumberjack { id => "my_plugin_id" } }