index.asciidoc

File output plugin

../../../../logstash/docs/include/plugin_header.asciidoc

Description

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 in json format. You can customise the line format using the line codec like

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

File Output Configuration Options

This plugin supports the following configuration options plus the [plugins-outputs-file-common-options] described later.

Setting	Input type	Required
create_if_deleted	boolean	No
dir_mode	number	No
file_mode	number	No
filename_failure	string	No
flush_interval	number	No
gzip	boolean	No
path	string	Yes
write_behavior	string	No
write_behavior	string	No
write_behavior	string	No

Also see [plugins-outputs-file-common-options] for a list of options supported by all output plugins.

 

create_if_deleted

• Value type is boolean

• Default value is true

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

dir_mode

• Value type is number

• Default value is -1

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

file_mode

• Value type is number

• Default value is -1

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

filename_failure

• Value type is string

• Default value is "_filepath_failures"

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

flush_interval

• Value type is number

• Default value is 2

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

gzip

• Value type is boolean

• Default value is false

Gzip the output stream before writing to disk.

path

• This is a required setting.

• Value type is string

• 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

write_behavior

• Value type is string

• Default value is append

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

../../../../logstash/docs/include/output.asciidoc