• Plugin version: v4.3.0
• Released on: 2020-04-27
• Changelog

For other versions, see theVersioned plugin docs.

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

This output writes events to files on disk. You can use fields from the event as parts of the filename and/or path.

By default, this output writes one event per line injson format. You can customise the line format using theline codec like

output { file {   path => ...   codec => line { format => "custom format: %{message}"} }}

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all output plugins.

• Value type isboolean
• Default value istrue

If the configured file is deleted, but an event is handled by the plugin, the plugin will recreate the file. Default ⇒ true

• Value type isnumber
• Default value is-1

Dir access mode to use. Note that due to the bug in jruby system umask is ignored on linux:https://github.com/jruby/jruby/issues/3426 Setting it to -1 uses default OS value. Example:"dir_mode" => 0750

• Value type isnumber
• Default value is-1

File access mode to use. Note that due to the bug in jruby system umask is ignored on linux:https://github.com/jruby/jruby/issues/3426 Setting it to -1 uses default OS value. Example:"file_mode" => 0640

• Value type isstring
• Default value is"_filepath_failures"

If the generated path is invalid, the events will be saved into this file and inside the defined path.

• Value type isnumber
• Default value is2

Flush interval (in seconds) for flushing writes to log files. 0 will flush on every message.

• Value type isboolean
• Default value isfalse

Gzip the output stream before writing to disk.

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

The path to the file to write. Event fields can be used here, like/var/log/logstash/%{{host}}/%{{application}} One may also utilize the path option for date-based log rotation via the joda time format. This will use the event timestamp. E.g.:path => "./test-%{+YYYY-MM-dd}.txt" to create./test-2013-05-29.txt

If you use an absolute path you cannot start with a dynamic string. E.g:/%{{myfield}}/,/test-%{{myfield}}/ are not valid paths

• Value type isnumber
• Default value is10

Defines the interval, in seconds, between the stale files cleanup runs. The stale files cleanup cycle closes inactive files (i.e files not written to since the last cycle).

• Value type isstring
• Default value isappend

Ifappend, the file will be opened for appending and each new event will be written at the end of the file. Ifoverwrite, the file will be truncated before writing and only the most recent event will appear in the file.

These configuration options are supported by all output plugins:

• Value type iscodec
• Default value is"json_lines"

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.

• Value type isboolean
• Default value istrue

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.

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

Add a uniqueID 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 file outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {  file {    id => "my_plugin_id"  }}