Skip to content

Commit

Permalink
Remove close_timeout from docs and config (#2334)
Browse files Browse the repository at this point in the history
Even thought implementation for close_timeout is not finished, it already showed up in the docs and config file. As close_timeout still needs more work, these were now removed to prevent any confusion. All changes for close_timeout go into #1926
  • Loading branch information
ruflin authored and tsg committed Aug 22, 2016
1 parent 55f02f6 commit 0717bbf
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,6 @@ WARNING: Only use this options if you understand the potential side affects with

Close eof closes a file as soon as the end of a file is reached. This is useful in case your files are only written once and not updated from time to time. This case can happen in case you are writing every single log event to a new file.

===== close_timeout

WARNING: Only use this options if you understand the potential side affects with potential data loss.

Close timeout gives every harvester a predefined lifetime. Independent of the location of the reader, it will stop the reader after `close_timeout`. This option can be useful, if only a predefine time should be spent on older log files. Using this option in combination with `ignore_older` == `close_timeout` means the file is not picked up again in case it wasn't modified in between. This normally leads to data loss and not the complete file is sent.

[[clean-options]]
===== clean_*

Expand Down
3 changes: 1 addition & 2 deletions filebeat/docs/troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ There are 4 more configuration options which can be used to close file handlers,
* close_renamed
* close_removed
* close_eof
* close_timeout

`close_renamed` and `close_removed` can be useful on Windows and issues related to file rotation, see <<windows-file-rotation>>. `close_eof` can be useful in environments with a large number of files with only very few entries. `close_timeout` in environments where it is more important to close file handlers then to send all log lines. More details can be found in config options, see <<configuration-filebeat-options>>.
`close_renamed` and `close_removed` can be useful on Windows and issues related to file rotation, see <<windows-file-rotation>>. `close_eof` can be useful in environments with a large number of files with only very few entries. More details can be found in config options, see <<configuration-filebeat-options>>.

Before using any of these variables, make sure to study the documentation on each.

Expand Down
6 changes: 0 additions & 6 deletions filebeat/etc/beat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,6 @@ filebeat.prospectors:
# Note: Potential data loss. Make sure to read and understand the docs for this option.
#close_eof: false

# Close timeout closes the harvester after the predefined time.
# This is independent if the harvester did finish reading the file or not.
# By default this option is disabled.
# Note: Potential data loss. Make sure to read and understand the docs for this option.
#close_timeout: 0

### State options

# Files for the modification data is older then clean_inactive the state from the registry is removed
Expand Down
6 changes: 0 additions & 6 deletions filebeat/filebeat.full.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,6 @@ filebeat.prospectors:
# Note: Potential data loss. Make sure to read and understand the docs for this option.
#close_eof: false

# Close timeout closes the harvester after the predefined time.
# This is independent if the harvester did finish reading the file or not.
# By default this option is disabled.
# Note: Potential data loss. Make sure to read and understand the docs for this option.
#close_timeout: 0

### State options

# Files for the modification data is older then clean_inactive the state from the registry is removed
Expand Down
4 changes: 2 additions & 2 deletions metricbeat/etc/kibana/index-pattern/metricbeat.json

Large diffs are not rendered by default.

0 comments on commit 0717bbf

Please sign in to comment.