index.asciidoc in logstash-input-file-4.1.17

- old
+ new

@@ -162,10 +162,11 @@
 see <<plugins-{type}s-{plugin}-string_duration,string_duration>> for the details.
 
 [cols="<,<,<",options="header",]
 |=======================================================================
 |Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-check_archive_validity>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No
 | <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-discover_interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-exclude>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-exit_after_read>> |<<boolean,boolean>>|No
@@ -189,10 +190,24 @@
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
 input plugins.
 
 &nbsp;
 
+[id="plugins-{type}s-{plugin}-check_archive_validity"]
+===== `check_archive_validity`
+
+  * Value type is <<boolean,boolean>>
+  * The default is `false`.
+
+When set to `true`, this setting verifies that a compressed file is valid before
+processing it. There are two passes through the file--one pass to
+verify that the file is valid, and another pass to process the file.
+
+Validating a compressed file requires more processing time, but can prevent a
+corrupt archive from causing looping.
+
+
 [id="plugins-{type}s-{plugin}-close_older"]
 ===== `close_older`
 
   * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>
   * Default value is `"1 hour"`
@@ -353,19 +368,20 @@
   * Value can be either `tail` or `read`.
   * The default value is `tail`.
 
 What mode do you want the file input to operate in. Tail a few files or
 read many content-complete files. Read mode now supports gzip file processing.
-If "read" is specified then the following other settings are ignored:
 
-. `start_position` (files are always read from the beginning)
-. `close_older` (files are automatically 'closed' when EOF is reached)
+If `read` is specified, these settings can be used:
 
-If "read" is specified then the following settings are heeded:
+* `ignore_older` (older files are not processed)
+* `file_completed_action` (what action should be taken when the file is processed)
+* `file_completed_log_path` (which file should the completed file path be logged to)
 
-. `ignore_older` (older files are not processed)
-. `file_completed_action` (what action should be taken when the file is processed)
-. `file_completed_log_path` (which file should the completed file path be logged to)
+If `read` is specified, these settings are ignored:
+
+* `start_position` (files are always read from the beginning)
+* `close_older` (files are automatically 'closed' when EOF is reached)
 
 [id="plugins-{type}s-{plugin}-path"]
 ===== `path`
 
   * This is a required setting.