Skip to content

[DOC] Doc improvements #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 3, 2020
Merged

[DOC] Doc improvements #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84436da
Doc improvements to mode setting
karenzone Apr 1, 2020
8d9e6aa
Update changelog with PR number
karenzone Apr 1, 2020
383f041
Rebase against master
karenzone Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
## 4.1.17
- Added configuration setting `check_archive_validity` settings to enable gzipped files verification,
issue [#261](https://github.com/logstash-plugins/logstash-input-file/issues/261)
- Added configuration setting `check_archive_validity` settings to enable
gzipped files verification, issue
[#261](https://github.com/logstash-plugins/logstash-input-file/issues/261)
- [DOC] Added clarification for settings available with `read` mode [#235](https://github.com/logstash-plugins/logstash-input-file/pull/235)
- [DOC] Rearranged text and fixed formatting for `mode` setting [266](https://github.com/logstash-plugins/logstash-input-file/pull/266)

## 4.1.16
- Added configuration setting exit_after_read to read to EOF and terminate
Expand Down
15 changes: 8 additions & 7 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,16 +370,17 @@ A default of 4095 is set in internally.

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 can be used:
* `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`
Expand Down