Skip to content

Commit 06ad65c

Browse files
committed
Fixed string_duration anchor to use asciidoc ref
Fixes logstash-plugins#203
1 parent 5aa6e8c commit 06ad65c

File tree

3 files changed

+19
-14
lines changed

3 files changed

+19
-14
lines changed

Diff for: CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 4.1.5
2+
- Fixed text anchor by changing it from hardcoded to asciidoc reference to
3+
work in versioned plugin reference
4+
15
## 4.1.4
26
- Fixed a regression where files discovered after first discovery were not
37
always read from the beginning. Applies to tail mode only.
@@ -8,6 +12,7 @@
812
was possible to read into memory allocated but not filled with data resulting
913
in ASCII NUL (0) bytes in the message field. Now, files are read up to the
1014
size as given by the remote filesystem client. Applies to tail and read modes.
15+
1116
## 4.1.3
1217
- Fixed `read` mode of regular files sincedb write is requested in each read loop
1318
iteration rather than waiting for the end-of-file to be reached. Note: for gz files,

Diff for: docs/index.asciidoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,12 @@ This plugin supports the following configuration options plus the <<plugins-{typ
159159
[NOTE]
160160
Duration settings can be specified in text form e.g. "250 ms", this string will be converted into
161161
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.
163163

164164
[cols="<,<,<",options="header",]
165165
|=======================================================================
166166
|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
168168
| <<plugins-{type}s-{plugin}-delimiter>> |<<string,string>>|No
169169
| <<plugins-{type}s-{plugin}-discover_interval>> |<<number,number>>|No
170170
| <<plugins-{type}s-{plugin}-exclude>> |<<array,array>>|No
@@ -174,15 +174,15 @@ see <<string_duration,string duration>> for the details.
174174
| <<plugins-{type}s-{plugin}-file_completed_log_path>> |<<string,string>>|No
175175
| <<plugins-{type}s-{plugin}-file_sort_by>> |<<string,string>>, one of `["last_modified", "path"]`|No
176176
| <<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
178178
| <<plugins-{type}s-{plugin}-max_open_files>> |<<number,number>>|No
179179
| <<plugins-{type}s-{plugin}-mode>> |<<string,string>>, one of `["tail", "read"]`|No
180180
| <<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
182182
| <<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
184184
| <<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
186186
|=======================================================================
187187

188188
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -193,7 +193,7 @@ input plugins.
193193
[id="plugins-{type}s-{plugin}-close_older"]
194194
===== `close_older`
195195

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>>
197197
* Default value is `"1 hour"`
198198

199199
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
311311
[id="plugins-{type}s-{plugin}-ignore_older"]
312312
===== `ignore_older`
313313

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>>
315315
* There is no default value for this setting.
316316

317317
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
371371
[id="plugins-{type}s-{plugin}-sincedb_clean_after"]
372372
===== `sincedb_clean_after`
373373

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>>
375375
* The default value for this setting is "2 weeks".
376376
* If a number is specified then it is interpreted as *days* and can be decimal e.g. 0.5 is 12 hours.
377377

@@ -395,7 +395,7 @@ NOTE: it must be a file path and not a directory path
395395
[id="plugins-{type}s-{plugin}-sincedb_write_interval"]
396396
===== `sincedb_write_interval`
397397

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>>
399399
* Default value is `"15 seconds"`
400400

401401
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.
421421
[id="plugins-{type}s-{plugin}-stat_interval"]
422422
===== `stat_interval`
423423

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>>
425425
* Default value is `"1 second"`
426426

427427
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
438438
[id="plugins-{type}s-{plugin}-common-options"]
439439
include::{include_path}/{type}.asciidoc[]
440440

441-
:default_codec!:
442441

443-
[id="string_duration"]
442+
[id="plugins-{type}s-{plugin}-string_duration"]
444443
// Move this to the includes when we make string durations available generally.
445444
==== String Durations
446445

@@ -474,3 +473,4 @@ Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs"
474473
[NOTE]
475474
`micro` `micros` and `microseconds` are not supported
476475

476+
:default_codec!:

Diff for: logstash-input-file.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gem::Specification.new do |s|
22

33
s.name = 'logstash-input-file'
4-
s.version = '4.1.4'
4+
s.version = '4.1.5'
55
s.licenses = ['Apache-2.0']
66
s.summary = "Streams events from files"
77
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

0 commit comments

Comments
 (0)