docs/index.asciidoc in logstash-input-file-4.1.4 vs docs/index.asciidoc in logstash-input-file-4.1.5

- old
+ new

@@ -157,45 +157,45 @@ This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later. [NOTE] Duration settings can be specified in text form e.g. "250 ms", this string will be converted into decimal seconds. There are quite a few supported natural and abbreviated durations, -see <<string_duration,string duration>> for the details. +see <<plugins-{type}s-{plugin}-string_duration,string_duration>> for the details. [cols="<,<,<",options="header",] |======================================================================= |Setting |Input type|Required -| <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<string_duration,string duration>>|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}-file_chunk_count>> |<<number,number>>|No | <<plugins-{type}s-{plugin}-file_chunk_size>> |<<number,number>>|No | <<plugins-{type}s-{plugin}-file_completed_action>> |<<string,string>>, one of `["delete", "log", "log_and_delete"]`|No | <<plugins-{type}s-{plugin}-file_completed_log_path>> |<<string,string>>|No | <<plugins-{type}s-{plugin}-file_sort_by>> |<<string,string>>, one of `["last_modified", "path"]`|No | <<plugins-{type}s-{plugin}-file_sort_direction>> |<<string,string>>, one of `["asc", "desc"]`|No -| <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<string_duration,string duration>>|No +| <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No | <<plugins-{type}s-{plugin}-max_open_files>> |<<number,number>>|No | <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["tail", "read"]`|No | <<plugins-{type}s-{plugin}-path>> |<<array,array>>|Yes -| <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<string_duration,string duration>>|No +| <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No | <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No -| <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<string_duration,string duration>>|No +| <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No | <<plugins-{type}s-{plugin}-start_position>> |<<string,string>>, one of `["beginning", "end"]`|No -| <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<string_duration,string duration>>|No +| <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>>|No |======================================================================= Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all input plugins. &nbsp; [id="plugins-{type}s-{plugin}-close_older"] ===== `close_older` - * Value type is <<number,number>> or <<string_duration,string duration>> + * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>> * Default value is `"1 hour"` The file input closes any files that were last read the specified duration (seconds if a number is specified) ago. This has different implications depending on if a file is being tailed or @@ -309,11 +309,11 @@ `path` + `asc` will help to control the order of file processing. [id="plugins-{type}s-{plugin}-ignore_older"] ===== `ignore_older` - * Value type is <<number,number>> or <<string_duration,string duration>> + * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>> * There is no default value for this setting. When the file input discovers a file that was last modified before the specified duration (seconds if a number is specified), the file is ignored. After it's discovery, if an ignored file is modified it is no @@ -369,11 +369,11 @@ on the {logstash-ref}/configuration-file-structure.html#array[Logstash configuration page]. [id="plugins-{type}s-{plugin}-sincedb_clean_after"] ===== `sincedb_clean_after` - * Value type is <<number,number>> or <<string_duration,string duration>> + * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>> * The default value for this setting is "2 weeks". * If a number is specified then it is interpreted as *days* and can be decimal e.g. 0.5 is 12 hours. The sincedb record now has a last active timestamp associated with it. If no changes are detected in a tracked file in the last N days its sincedb @@ -393,11 +393,11 @@ NOTE: it must be a file path and not a directory path [id="plugins-{type}s-{plugin}-sincedb_write_interval"] ===== `sincedb_write_interval` - * Value type is <<number,number>> or <<string_duration,string duration>> + * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>> * Default value is `"15 seconds"` How often (in seconds) to write a since database with the current position of monitored log files. @@ -419,11 +419,11 @@ position recorded in the sincedb file will be used. [id="plugins-{type}s-{plugin}-stat_interval"] ===== `stat_interval` - * Value type is <<number,number>> or <<string_duration,string duration>> + * Value type is <<number,number>> or <<plugins-{type}s-{plugin}-string_duration,string_duration>> * Default value is `"1 second"` How often (in seconds) we stat files to see if they have been modified. Increasing this interval will decrease the number of system calls we make, but increase the time to detect new log lines. @@ -436,13 +436,12 @@ `stat_interval` and the file read time. [id="plugins-{type}s-{plugin}-common-options"] include::{include_path}/{type}.asciidoc[] -:default_codec!: -[id="string_duration"] +[id="plugins-{type}s-{plugin}-string_duration"] // Move this to the includes when we make string durations available generally. ==== String Durations Format is `number` `string` and the space between these is optional. So "45s" and "45 s" are both valid. @@ -472,5 +471,6 @@ ===== Microseconds Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs" [NOTE] `micro` `micros` and `microseconds` are not supported +:default_codec!: