Skip to content

[Docs] Setting docs for different modes are confusing #294

Open
@robbavey

Description

@robbavey

The text around settings in the mode section of the documentation is somewhat ambiguous and can be misconstrued:

If `read` is specified, these 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)

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)

For example, ignore_older is applicable to both tail and read, file_completed... are both applicable to read only. It may make sense to rework this section to improve clarity.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions