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

lumberjackedit

  • Version: 3.1.2
  • Released on: 2016-09-15
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-lumberjack.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

enable_metric

boolean

No

true

flush_size

number

No

1024

hosts

array

Yes

id

string

No

idle_flush_time

number

No

1

port

number

Yes

ssl_certificate

a valid filesystem path

Yes

workers

<<,>>

No

1

Detailsedit

 

codecedit

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

flush_sizeedit

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

hostsedit

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

list of addresses lumberjack can send to

idedit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

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

If you don’t explicitely set this variable Logstash will generate a unique name.

idle_flush_timeedit

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

portedit

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

the port to connect to

ssl_certificateedit

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

ssl certificate to use

workersedit

  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« loggly metriccatcher »