Skip to content

Commit a0384c0

Browse files
authored
[DOC] Doc improvements (#266)
* Doc improvements to mode setting * Update changelog with PR number * Rebase against master
1 parent e4b5ced commit a0384c0

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

Diff for: CHANGELOG.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
## 4.1.17
2-
- Added configuration setting `check_archive_validity` settings to enable gzipped files verification,
3-
issue [#261](https://github.com/logstash-plugins/logstash-input-file/issues/261)
2+
- Added configuration setting `check_archive_validity` settings to enable
3+
gzipped files verification, issue
4+
[#261](https://github.com/logstash-plugins/logstash-input-file/issues/261)
5+
- [DOC] Added clarification for settings available with `read` mode [#235](https://github.com/logstash-plugins/logstash-input-file/pull/235)
6+
- [DOC] Rearranged text and fixed formatting for `mode` setting [266](https://github.com/logstash-plugins/logstash-input-file/pull/266)
47

58
## 4.1.16
69
- Added configuration setting exit_after_read to read to EOF and terminate

Diff for: docs/index.asciidoc

+8-7
Original file line numberDiff line numberDiff line change
@@ -370,16 +370,17 @@ A default of 4095 is set in internally.
370370

371371
What mode do you want the file input to operate in. Tail a few files or
372372
read many content-complete files. Read mode now supports gzip file processing.
373-
If "read" is specified then the following other settings are ignored:
374373

375-
. `start_position` (files are always read from the beginning)
376-
. `close_older` (files are automatically 'closed' when EOF is reached)
374+
If `read` is specified, these settings can be used:
377375

378-
If "read" is specified then the following settings can be used:
376+
* `ignore_older` (older files are not processed)
377+
* `file_completed_action` (what action should be taken when the file is processed)
378+
* `file_completed_log_path` (which file should the completed file path be logged to)
379379

380-
. `ignore_older` (older files are not processed)
381-
. `file_completed_action` (what action should be taken when the file is processed)
382-
. `file_completed_log_path` (which file should the completed file path be logged to)
380+
If `read` is specified, these settings are ignored:
381+
382+
* `start_position` (files are always read from the beginning)
383+
* `close_older` (files are automatically 'closed' when EOF is reached)
383384

384385
[id="plugins-{type}s-{plugin}-path"]
385386
===== `path`

0 commit comments

Comments
 (0)