@@ -159,12 +159,12 @@ This plugin supports the following configuration options plus the <<plugins-{typ
159
159
[NOTE]
160
160
Duration settings can be specified in text form e.g. "250 ms", this string will be converted into
161
161
decimal seconds. There are quite a few supported natural and abbreviated durations,
162
- see <<string_duration,string duration >> for the details.
162
+ see <<plugins-{type}s-{plugin}- string_duration,string_duration >> for the details.
163
163
164
164
[cols="<,<,<",options="header",]
165
165
|=======================================================================
166
166
|Setting |Input type|Required
167
- | <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<string_duration,string duration >>|No
167
+ | <<plugins-{type}s-{plugin}-close_older>> |<<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>|No
168
168
| <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
169
169
| <<plugins-{type}s-{plugin}-discover_interval>> |<<number,number>>|No
170
170
| <<plugins-{type}s-{plugin}-exclude>> |<<array,array>>|No
@@ -174,15 +174,15 @@ see <<string_duration,string duration>> for the details.
174
174
| <<plugins-{type}s-{plugin}-file_completed_log_path>> |<<string,string>>|No
175
175
| <<plugins-{type}s-{plugin}-file_sort_by>> |<<string,string>>, one of `["last_modified", "path"]`|No
176
176
| <<plugins-{type}s-{plugin}-file_sort_direction>> |<<string,string>>, one of `["asc", "desc"]`|No
177
- | <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<string_duration,string duration >>|No
177
+ | <<plugins-{type}s-{plugin}-ignore_older>> |<<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>|No
178
178
| <<plugins-{type}s-{plugin}-max_open_files>> |<<number,number>>|No
179
179
| <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["tail", "read"]`|No
180
180
| <<plugins-{type}s-{plugin}-path>> |<<array,array>>|Yes
181
- | <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<string_duration,string duration >>|No
181
+ | <<plugins-{type}s-{plugin}-sincedb_clean_after>> |<<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>|No
182
182
| <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
183
- | <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<string_duration,string duration >>|No
183
+ | <<plugins-{type}s-{plugin}-sincedb_write_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>|No
184
184
| <<plugins-{type}s-{plugin}-start_position>> |<<string,string>>, one of `["beginning", "end"]`|No
185
- | <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<string_duration,string duration >>|No
185
+ | <<plugins-{type}s-{plugin}-stat_interval>> |<<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>|No
186
186
|=======================================================================
187
187
188
188
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -193,7 +193,7 @@ input plugins.
193
193
[id="plugins-{type}s-{plugin}-close_older"]
194
194
===== `close_older`
195
195
196
- * Value type is <<number,number>> or <<string_duration,string duration >>
196
+ * Value type is <<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>
197
197
* Default value is `"1 hour"`
198
198
199
199
The file input closes any files that were last read the specified
@@ -311,7 +311,7 @@ If you use special naming conventions for the file full paths then perhaps
311
311
[id="plugins-{type}s-{plugin}-ignore_older"]
312
312
===== `ignore_older`
313
313
314
- * Value type is <<number,number>> or <<string_duration,string duration >>
314
+ * Value type is <<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>
315
315
* There is no default value for this setting.
316
316
317
317
When the file input discovers a file that was last modified
@@ -371,7 +371,7 @@ on the {logstash-ref}/configuration-file-structure.html#array[Logstash configura
371
371
[id="plugins-{type}s-{plugin}-sincedb_clean_after"]
372
372
===== `sincedb_clean_after`
373
373
374
- * Value type is <<number,number>> or <<string_duration,string duration >>
374
+ * Value type is <<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>
375
375
* The default value for this setting is "2 weeks".
376
376
* If a number is specified then it is interpreted as *days* and can be decimal e.g. 0.5 is 12 hours.
377
377
@@ -395,7 +395,7 @@ NOTE: it must be a file path and not a directory path
395
395
[id="plugins-{type}s-{plugin}-sincedb_write_interval"]
396
396
===== `sincedb_write_interval`
397
397
398
- * Value type is <<number,number>> or <<string_duration,string duration >>
398
+ * Value type is <<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>
399
399
* Default value is `"15 seconds"`
400
400
401
401
How often (in seconds) to write a since database with the current position of
@@ -421,7 +421,7 @@ position recorded in the sincedb file will be used.
421
421
[id="plugins-{type}s-{plugin}-stat_interval"]
422
422
===== `stat_interval`
423
423
424
- * Value type is <<number,number>> or <<string_duration,string duration >>
424
+ * Value type is <<number,number>> or <<plugins-{type}s-{plugin}- string_duration,string_duration >>
425
425
* Default value is `"1 second"`
426
426
427
427
How often (in seconds) we stat files to see if they have been modified.
@@ -438,9 +438,8 @@ the pipeline is congested. So the overall loop time is a combination of the
438
438
[id="plugins-{type}s-{plugin}-common-options"]
439
439
include::{include_path}/{type}.asciidoc[]
440
440
441
- :default_codec!:
442
441
443
- [id="string_duration"]
442
+ [id="plugins-{type}s-{plugin}- string_duration"]
444
443
// Move this to the includes when we make string durations available generally.
445
444
==== String Durations
446
445
@@ -474,3 +473,4 @@ Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs"
474
473
[NOTE]
475
474
`micro` `micros` and `microseconds` are not supported
476
475
476
+ :default_codec!:
0 commit comments