Skip to content

Commit

Permalink
input: tail: Add information about Docker mode (fluent#106)
Browse files Browse the repository at this point in the history
Signed-off-by: Georgi Chulkov <[email protected]>
  • Loading branch information
Gchbg authored and edsiper committed Nov 6, 2018
1 parent 70de00b commit d267dd1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions input/tail.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Content:

* [Configuration Parameters](tail.md#config)
* [Multiline Parameters](tail.md#multiline)
* [Docker Mode Parameters](tail.md#docker_mode)
* [Getting Started](tail.md#getting_started)
* [Tailing Files Keeping State](tail.md#keep_state)

Expand Down Expand Up @@ -47,6 +48,15 @@ Additionally the following options exists to configure the handling of multi-lin
| Parser\_Firstline | Name of the parser that matchs the beginning of a multiline message. Note that the regular expression defined in the parser must include a group name \(named capture\) | |
| Parser\_N | Optional-extra parser to interpret and structure multiline entries. This option can be used to define multiple parsers, e.g: Parser\_1 ab1, Parser\_2 ab2, Parser\_N abN. | |

### Docker Mode Configuration Parameters {#docker_mode}

Docker mode exists to recombine JSON log lines split by the Docker daemon due to its line length limit. To use this feature, configure the tail plugin with the corresponding parser and then enable Docker mode:

| Key | Description | Default |
| :--- | :--- | :--- |
| Docker\_Mode | If enabled, the plugin will recombine split Docker log lines before passing them to any parser as configured above. This mode cannot be used at the same time as Multiline. | Off |
| Docker\_Mode\_Flush | Wait period time in seconds to flush queued unfinished split lines. | 4 |

## Getting Started {#getting_started}

In order to tail text or log files, you can run the plugin from the command line or through the configuration file:
Expand Down

0 comments on commit d267dd1

Please sign in to comment.