New

The executive guide to generative AI

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

lumberjack

edit

lumberjack

edit

 

Synopsis

edit

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"

flush_size

number

No

1024

hosts

array

Yes

idle_flush_time

number

No

1

port

number

Yes

ssl_certificate

a valid filesystem path

Yes

workers

number

No

1

Details

edit

 

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.

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.

port

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

the port to connect to

ssl_certificate

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

ssl certificate to use

window_size (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.

window size

workers

edit
  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

« loggly metriccatcher »