From 7a934bd6f48035b7d846b718ceef3ea458ca9769 Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Thu, 20 Apr 2017 07:29:21 -0400 Subject: [PATCH] Add note to docs on whitespace in Log4j settings A confusing thing that can happen when configuring Log4j is that extraneous whitespace throws off its configuration parsing yet the error messages that arise give no indication that this is the problem. This commit adds a note to the docs. Relates #24198 --- docs/reference/setup/configuration.asciidoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference/setup/configuration.asciidoc b/docs/reference/setup/configuration.asciidoc index 375caf5b75a..dc5c242af4e 100644 --- a/docs/reference/setup/configuration.asciidoc +++ b/docs/reference/setup/configuration.asciidoc @@ -133,6 +133,10 @@ appender.rolling.policies.time.modulate = true <6> <6> Align rolls on the day boundary (as opposed to rolling every twenty-four hours) +NOTE: Log4j's configuration parsing gets confused by any extraneous whitespace; +if you copy and paste the above settings, or enter any Log4j configuration in +general, be sure to trim any leading and trailing whitespace. + If you append `.gz` or `.zip` to `appender.rolling.filePattern`, then the logs will be compressed as they are rolled.