docs/index.asciidoc in logstash-output-file-4.2.1 vs docs/index.asciidoc in logstash-output-file-4.2.2
- old
+ new
@@ -46,76 +46,77 @@
| <<plugins-{type}s-{plugin}-file_mode>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-filename_failure>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-flush_interval>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-gzip>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-write_behavior>> |<<string,string>>|No
|=======================================================================
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.
[id="plugins-{type}s-{plugin}-create_if_deleted"]
-===== `create_if_deleted`
+===== `create_if_deleted`
* Value type is <<boolean,boolean>>
* Default value is `true`
-If the configured file is deleted, but an event is handled by the plugin,
+If the configured file is deleted, but an event is handled by the plugin,
the plugin will recreate the file. Default => true
[id="plugins-{type}s-{plugin}-dir_mode"]
-===== `dir_mode`
+===== `dir_mode`
* Value type is <<number,number>>
* 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`
[id="plugins-{type}s-{plugin}-file_mode"]
-===== `file_mode`
+===== `file_mode`
* Value type is <<number,number>>
* 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`
[id="plugins-{type}s-{plugin}-filename_failure"]
-===== `filename_failure`
+===== `filename_failure`
* Value type is <<string,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.
[id="plugins-{type}s-{plugin}-flush_interval"]
-===== `flush_interval`
+===== `flush_interval`
* Value type is <<number,number>>
* Default value is `2`
Flush interval (in seconds) for flushing writes to log files.
0 will flush on every message.
[id="plugins-{type}s-{plugin}-gzip"]
-===== `gzip`
+===== `gzip`
* Value type is <<boolean,boolean>>
* Default value is `false`
Gzip the output stream before writing to disk.
[id="plugins-{type}s-{plugin}-path"]
-===== `path`
+===== `path`
* This is a required setting.
* Value type is <<string,string>>
* There is no default value for this setting.
@@ -128,9 +129,16 @@
`./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
+[id="plugins-{type}s-{plugin}-write_behavior"]
+===== `write_behavior`
+ * Value type is <<string,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.
+
[id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
\ No newline at end of file
+include::{include_path}/{type}.asciidoc[]