From d267dd14ce1dde159f818647b9f82ad6a1f44e2c Mon Sep 17 00:00:00 2001 From: Georgi Chulkov Date: Tue, 6 Nov 2018 17:52:21 +0100 Subject: [PATCH] input: tail: Add information about Docker mode (#106) Signed-off-by: Georgi Chulkov --- input/tail.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/input/tail.md b/input/tail.md index f63609d53a6..f90f901d0f7 100644 --- a/input/tail.md +++ b/input/tail.md @@ -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) @@ -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: