diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/XmlLayout.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/XmlLayout.java index 4364d9d..5b976b3 100644 --- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/XmlLayout.java +++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/XmlLayout.java @@ -21,12 +21,16 @@ import java.nio.charset.StandardCharsets; import java.util.HashMap; import java.util.Map; +import com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter; import org.apache.logging.log4j.core.Layout; import org.apache.logging.log4j.core.config.Node; import org.apache.logging.log4j.core.config.plugins.Plugin; import org.apache.logging.log4j.core.config.plugins.PluginAttribute; import org.apache.logging.log4j.core.config.plugins.PluginFactory; import org.apache.logging.log4j.core.jackson.XmlConstants; +import org.codehaus.stax2.XMLStreamWriter2; + +import javax.xml.stream.XMLStreamException; // Lines too long... //CHECKSTYLE:OFF @@ -195,7 +199,12 @@ public final class XmlLayout extends AbstractJacksonLayout { private static final String ROOT_TAG = "Events"; protected XmlLayout(final boolean locationInfo, final boolean properties, final boolean complete, final boolean compact, final Charset charset) { - super(null, new JacksonFactory.XML().newWriter(locationInfo, properties, compact), charset, compact, complete, false, null, null); + super(null, new JacksonFactory.XML() { + @Override + protected EventXmlPrettyPrinter newPrettyPrinter() { + return new EventXmlPrettyPrinter(); + } + }.newWriter(locationInfo, properties, compact), charset, compact, complete, false, null, null); } /** @@ -295,4 +304,26 @@ public final class XmlLayout extends AbstractJacksonLayout { public static XmlLayout createDefaultLayout() { return new XmlLayout(false, false, false, false, StandardCharsets.UTF_8); } + + + /** + * When <Event>s are written into a XML file; the "Event" object is not the root element, but an element named <Events> created using {@link #getHeader()} and {@link #getFooter()} methods.
+ * {@link com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter} is used to print the Event object into XML; hence it assumes <Event> tag as the root element, so it prints the <Event> tag without any indentation. + * To add an indentation to the <Event> tag; hence an additional indentation for any sub-elements, this class is written. As an additional task, to avoid the blank line printed after the ending </Event> tag, {@link #writePrologLinefeed(XMLStreamWriter2)} method is also overridden. + */ + static class EventXmlPrettyPrinter extends DefaultXmlPrettyPrinter { + + EventXmlPrettyPrinter() { + // set the nesting level to 1 rather than 0, so the "Event" tag will get indentation of next level below root. + _nesting = 1; + } + + public void writePrologLinefeed(XMLStreamWriter2 sw) throws XMLStreamException {} + + @Override + public DefaultXmlPrettyPrinter createInstance() { + return new EventXmlPrettyPrinter(); + } + + } } diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/XmlCompleteFileAppenderTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/XmlCompleteFileAppenderTest.java index 344b221..2b7fc92 100644 --- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/XmlCompleteFileAppenderTest.java +++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/XmlCompleteFileAppenderTest.java @@ -57,6 +57,7 @@ public class XmlCompleteFileAppenderTest { try (final BufferedReader reader = new BufferedReader(new FileReader(file))) { line1 = reader.readLine(); line2 = reader.readLine(); + reader.readLine(); // ignore the empty line after the root line3 = reader.readLine(); line4 = reader.readLine(); } finally { @@ -81,4 +82,85 @@ public class XmlCompleteFileAppenderTest { final String location = "testFlushAtEndOfBatch"; assertTrue("no location", !line1.contains(location)); } + + /** + * Test the indentation of the Events XML. + *

Expected Events XML is as below.

+ * 
+<?xml version="1.0" encoding="UTF-8"?>
+<Events xmlns="http://logging.apache.org/log4j/2.0/events">
+
+  <Event xmlns="http://logging.apache.org/log4j/2.0/events" timeMillis="1460974522088" thread="main" level="INFO" loggerName="com.foo.Bar" endOfBatch="false" loggerFqcn="org.apache.logging.log4j.spi.AbstractLogger" threadId="11" threadPriority="5">
+    <Message>First Msg tag must be in level 2 after correct indentation</Message>
+  </Event>
+
+  <Event xmlns="http://logging.apache.org/log4j/2.0/events" timeMillis="1460974522089" thread="main" level="INFO" loggerName="com.foo.Bar" endOfBatch="true" loggerFqcn="org.apache.logging.log4j.spi.AbstractLogger" threadId="11" threadPriority="5">
+    <Message>Second Msg tag must also be in level 2 after correct indentation</Message>
+  </Event>
+</Events>
+     *
+ * @throws Exception + */ + @Test + public void testChildElementsAreCorrectlyIndented() throws Exception { + final File file = new File("target", "XmlCompleteFileAppenderTest.log"); + file.delete(); + final Logger log = LogManager.getLogger("com.foo.Bar"); + final String firstLogMsg = "First Msg tag must be in level 2 after correct indentation"; + log.info(firstLogMsg); + final String secondLogMsg = "Second Msg tag must also be in level 2 after correct indentation"; + log.info(secondLogMsg); + CoreLoggerContexts.stopLoggerContext(false, file); // stop async thread + + String[] lines = new String[9]; + + try (final BufferedReader reader = new BufferedReader(new FileReader(file))) { + + int usefulLinesIndex = 0; + String readLine; + while((readLine = reader.readLine()) != null) { + + if (!"".equals(readLine.trim())) { + lines[usefulLinesIndex] = readLine; + usefulLinesIndex++; + } + } + } finally { + file.delete(); + } + + String currentLine = lines[0]; + assertFalse("line1 incorrect: [" + currentLine + "], must have no indentation", currentLine.startsWith(" ")); + //