logstash.yml
editlogstash.yml
editYou can set options in the Logstash settings file, logstash.yml
, to control Logstash execution. For example,
you can specify pipeline settings, the location of configuration files, logging options, and other settings.
Most of the settings in the logstash.yml
file are also available as command-line flags
when you run Logstash. Any flags that you set at the command line override the corresponding settings in the
logstash.yml
file.
The logstash.yml
file is written in YAML. Its location varies by platform (see
Logstash Directory Layout). You can specify settings in hierarchical form or use flat keys. For example, to use
hierarchical form to set the pipeline batch size and batch delay, you specify:
pipeline: batch: size: 125 delay: 50
To express the same values as flat keys, you specify:
pipeline.batch.size: 125 pipeline.batch.delay: 50
The logstash.yml
file also supports bash-style interpolation of environment variables in
setting values.
pipeline: batch: size: ${BATCH_SIZE} delay: ${BATCH_DELAY:50} node: name: "node_${LS_NODE_NAME}" path: queue: "/tmp/${QUEUE_DIR:queue}"
Note that the ${VAR_NAME:default_value}
notation is supported, setting a default batch delay
of 50
and a default path.queue
of /tmp/queue
in the above example.
Modules may also be specified in the logstash.yml
file. The modules definition will have
this format:
modules: - name: MODULE_NAME1 var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY1: VALUE var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY2: VALUE var.PLUGIN_TYPE2.PLUGIN_NAME2.KEY1: VALUE var.PLUGIN_TYPE3.PLUGIN_NAME3.KEY1: VALUE - name: MODULE_NAME2 var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY1: VALUE var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY2: VALUE
If the command-line flag --modules
is used, any modules defined in the logstash.yml
file will be ignored.
The logstash.yml
file includes the following settings. If you are using X-Pack, also see X-Pack Settings in Logstash.
Setting | Description | Default value |
---|---|---|
|
A descriptive name for the node. |
Machine’s hostname |
|
The directory that Logstash and its plugins use for any persistent needs. |
|
|
The ID of the pipeline. |
|
|
Use the Java execution engine. |
true |
|
The number of workers that will, in parallel, execute the filter and output stages of the pipeline. If you find that events are backing up, or that the CPU is not saturated, consider increasing this number to better utilize machine processing power. |
Number of the host’s CPU cores |
|
The maximum number of events an individual worker thread will collect from inputs
before attempting to execute its filters and outputs.
Larger batch sizes are generally more efficient, but come at the cost of increased memory
overhead. You may need to increase JVM heap space in the |
|
|
When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers. |
|
|
When set to |
|
|
The path to the Logstash config for the main pipeline. If you specify a directory or wildcard, config files are read from the directory in alphabetical order. |
Platform-specific. See Logstash Directory Layout. |
|
A string that contains the pipeline configuration to use for the main pipeline. Use the same syntax as the config file. |
None |
|
When set to |
|
|
When set to |
|
|
How often in seconds Logstash checks the config files for changes. |
|
|
When set to |
|
|
When set to |
|
|
When configured, |
None |
|
The internal queuing model to use for event buffering. Specify |
|
|
The directory path where the data files will be stored when persistent queues are enabled ( |
|
|
The size of the page data files used when persistent queues are enabled ( |
64mb |
|
The maximum number of unread events in the queue when persistent queues are enabled ( |
0 (unlimited) |
|
The total capacity of the queue in number of bytes. Make sure the capacity of your disk drive is greater than the value you specify here. If both |
1024mb (1g) |
|
The maximum number of ACKed events before forcing a checkpoint when persistent queues are enabled ( |
1024 |
|
The maximum number of written events before forcing a checkpoint when persistent queues are enabled ( |
1024 |
|
When enabled, Logstash will retry once per attempted checkpoint write for any checkpoint writes that fail. Any subsequent errors are not retried. This is a workaround for failed checkpoint writes that have been seen only on filesystems with non-standard behavior such as SANs and is not recommended except in those specific circumstances. |
|
|
When enabled, Logstash waits until the persistent queue is drained before shutting down. |
|
|
Flag to instruct Logstash to enable the DLQ feature supported by plugins. |
|
|
The maximum size of each dead letter queue. Entries will be dropped if they would increase the size of the dead letter queue beyond this setting. |
|
|
The directory path where the data files will be stored for the dead-letter queue. |
|
|
The bind address for the metrics REST endpoint. |
|
|
The bind port for the metrics REST endpoint. |
|
|
The log level. Valid options are:
|
|
|
The log format. Set to |
|
|
The directory where Logstash will write its log to. |
|
|
Where to find custom plugins. You can specify this setting multiple times to include
multiple paths. Plugins are expected to be in a specific directory hierarchy:
|
Platform-specific. See Logstash Directory Layout. |