[LOG4J2-950] Incorrect attribute name in PropertiesRewritePolicy example

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.2
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Joel Edwards
• Created: 05/Feb/15 21:56
• Updated: 11/Mar/15 16:09
• Resolved: 21/Feb/15 05:00

Description

http://logging.apache.org/log4j/2.0/manual/appenders.html#RewriteAppender

On the documentation site on the Appenders page, under the RewriteAppender heading, RewritePolicy section, PropertiesRewritePolicy subsection, there is the following example:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp" packages="">
  <Appenders>
    <Console name="STDOUT" target="SYSTEM_OUT">
      <PatternLayout pattern="%m%n"/>
    </Console>
    <Rewrite name="rewrite">
      <AppenderRef ref="STDOUT"/>
      <PropertiesRewritePolicy>
        <Property key="user">${sys:user.name}</Property>
        <Property key="env">${sys:environment}</Property>
      </PropertiesRewritePolicy>
    </Rewrite>
  </Appenders>
  <Loggers>
    <Root level="error">
      <AppenderRef ref="Rewrite"/>
    </Root>
  </Loggers>
</Configuration>

The Configuration -> Appenders -> Rewrite -> PropertiesRewritePolicy -> Property nodes in the example are using an attribute with the name key. When tested in log4j 2.1, this did not work. However, using the attribute name did work.

From the Documentation

      <PropertiesRewritePolicy>
        <Property key="user">${sys:user.name}</Property>
        <Property key="env">${sys:environment}</Property>
      </PropertiesRewritePolicy>

Working Version

      <PropertiesRewritePolicy>
        <Property name="user">${sys:user.name}</Property>
        <Property name="env">${sys:environment}</Property>
      </PropertiesRewritePolicy>