Skip to content

Commit 1e3cd0a

Browse files
committed
Added some clarifications for multiline adapter usage to README.md
1 parent 0a35144 commit 1e3cd0a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,9 @@ In order to enable multiline logging, you must first prefix your adapter with th
147147
Using the the above prefix enables multiline logging on all containers by default. To enable it only to specific containers set MULTILINE_ENABLE_DEFAULT=false for logspout, and use the LOGSPOUT_MULTILINE environment variable on the monitored container:
148148

149149
$ docker run -d -e 'LOGSPOUT_MULTILINE=true' image
150-
150+
151+
##### MULTILINE_MATCH
152+
151153
Using the environment variable `MULTILINE_MATCH`=<first|last|nonfirst|nonlast> (default `nonfirst`) you define, which lines should be matched to the `MULTILINE_PATTERN`.
152154
* first: match first line only and append following messages until you match another line
153155
* last: concatenate all messages until the pattern matches the next line
@@ -179,9 +181,9 @@ If you use multiline logging with raw, it's recommended to json encode the Data
179181
* `SYSLOG_STRUCTURED_DATA` - datum for structured data field
180182
* `SYSLOG_TAG` - datum for tag field (default `{{.ContainerName}}+route.Options["append_tag"]`)
181183
* `SYSLOG_TIMESTAMP` - datum for timestamp field (default `{{.Timestamp}}`)
182-
* `MULTILINE_ENABLE_DEFAULT` - enable multiline logging for all containers (default `true`)
183-
* `MULTILINE_MATCH` - determines which lines the pattern should match, one of first|last|nonfirst|nonlast (default `nonfirst`)
184-
* `MULTILINE_PATTERN` - pattern for multiline logging, see: MULTILINE_MATCH (default: `^\s`)
184+
* `MULTILINE_ENABLE_DEFAULT` - enable multiline logging for all containers when using the multiline adapter (default `true`)
185+
* `MULTILINE_MATCH` - determines which lines the pattern should match, one of first|last|nonfirst|nonlast, for details see: [MULTILINE_MATCH](#MULTILINE_MATCH) (default `nonfirst`)
186+
* `MULTILINE_PATTERN` - pattern for multiline logging, see: [MULTILINE_MATCH](#MULTILINE_MATCH) (default: `^\s`)
185187
* `MULTILINE_FLUSH_AFTER` - maximum time between the first and last lines of a multiline log entry in milliseconds (default: 500)
186188
* `MULTILINE_SEPARATOR` - separator between lines for output (default: `\n`)
187189

0 commit comments

Comments
 (0)