非常简单的log4j2 XML配置文件,使用控制台和文件记录器。

291

我希望有一个使用log4j2的非常简单的XML配置文件,其中包含控制台和文件 appender。

(Apache网站提供的信息太多了,让我感到很困惑。)


102
哈哈,很高兴你说了这句话:“(Apache的网站提供了太多信息,让我感到不知所措。)” - thonnor
35
你的那句话(Apache网站提供的信息太多了,让我感到压力山大)正是我查看你的问题的主要原因! - Ju Oliveira
4个回答

335
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>
        <File name="MyFile" fileName="all.log" immediateFlush="false" append="false">
            <PatternLayout pattern="%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </File>
    </Appenders>
    <Loggers>
        <Root level="debug">
            <AppenderRef ref="Console" />
            <AppenderRef ref="MyFile"/>
        </Root>
    </Loggers>
</Configuration>

注意:

  • 将以下内容放入您的配置文件中。
  • 将配置文件命名为log4j2.xml
  • 将log4j2.xml放置在类路径下的文件夹中(即您的源文件夹"src")
  • 使用Logger logger = LogManager.getLogger();初始化您的记录器
  • 我设置了immediateFlush="false",因为这对SSD寿命更好。如果您需要立即在日志文件中查看日志,请删除该参数或将其设置为true。

1
为了完整性,特别建议在使用Async Loggers或AsyncAppender时使用immediateFlush =“false”。 - Remko Popma
1
背景:immediateFlush="false" 允许 Log4J2 的异步组件将多个日志事件批量写入单个磁盘写入操作中。作为额外的好处,您最近的日志事件总是被写入磁盘,而不会留在内存缓冲区中挂起。(这是我发现 log4j-1.2 令人恼火的地方之一。) - Remko Popma
2
我无法让Log4j 2.0网站上的示例工作,但这个可以。谢谢。 - djangofan
14
请添加这个事实,即对于使用Eclipse的用户来说,可能需要进行清理。为了人类的利益。 - Reut Sharabani
2
@ThorstenNiehues 我無法編輯之前的評論,但是當你進行構建時eclipse會複製配置,但出於某種原因,即使已更改,它並不總是複製log4j.xml。對我來說,這至少解決了問題。 - Reut Sharabani
显示剩余8条评论

26

这是我的简单的log4j2.xml配置,可以将日志输出到控制台并写入每天滚动的文件:

// java
private static final Logger LOGGER = LogManager.getLogger(MyClass.class);


// log4j2.xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Properties>
        <Property name="logPath">target/cucumber-logs</Property>
        <Property name="rollingFileName">cucumber</Property>
    </Properties>
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="[%highlight{%-5level}] %d{DEFAULT} %c{1}.%M() - %msg%n%throwable{short.lineNumber}" />
        </Console>
        <RollingFile name="rollingFile" fileName="${logPath}/${rollingFileName}.log" filePattern="${logPath}/${rollingFileName}_%d{yyyy-MM-dd}.log">
            <PatternLayout pattern="[%highlight{%-5level}] %d{DEFAULT} %c{1}.%M() - %msg%n%throwable{short.lineNumber}" />
            <Policies>
                <!-- Causes a rollover if the log file is older than the current JVM's start time -->
                <OnStartupTriggeringPolicy />
                <!-- Causes a rollover once the date/time pattern no longer applies to the active file -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="DEBUG" additivity="false">
            <AppenderRef ref="console" />
            <AppenderRef ref="rollingFile" />
        </Root>
    </Loggers>
</Configuration>

TimeBasedTriggeringPolicy

interval (整数) - 基于日期模式中最具体的时间单位,指定日志滚动发生的频率。例如,如果以小时为最具体项且设置了4个滚动,则每4小时会发生一次滚动。默认值为1。

modulate (布尔值) - 指示是否应调整间隔以使下一个滚动发生在间隔边界上。例如,如果最具体的项是小时,当前时间是凌晨3点,间隔为4,则第一个滚动将在早上4点出现,然后下一个滚动将在上午8点、中午12点、下午4点等时发生。

来源:https://logging.apache.org/log4j/2.x/manual/appenders.html

[INFO ] 2018-07-21 12:03:47,412 ScenarioHook.beforeScenario() - Browser=CHROME32_NOHEAD
[INFO ] 2018-07-21 12:03:48,623 ScenarioHook.beforeScenario() - Screen Resolution (WxH)=1366x768
[DEBUG] 2018-07-21 12:03:52,125 HomePageNavigationSteps.I_Am_At_The_Home_Page() - Base URL=http://simplydo.com/projector/
[DEBUG] 2018-07-21 12:03:52,700 NetIncomeProjectorSteps.I_Enter_My_Start_Balance() - Start Balance=348000

每天将创建一个新的日志文件,前一天的日志文件将自动重命名为:

cucumber_yyyy-MM-dd.log

在Maven项目中,您应该将log4j2.xml放置在src/main/resources 或者 src/test/resources 中。


我想知道如果我们在第一天成功运行程序并且所有的日志消息都写入了创建的文件,但突然终止程序并在同一天重新启动它。当我们重新启动时,它会创建一个新文件并将其写入其中,还是会将其写入同一天创建的现有文件中?@silver - zordu-nickim-agzivi-sikm

12

log4j2拥有非常灵活的配置系统(在我看来更像是一个干扰而不是帮助),你甚至可以使用JSON。参见https://logging.apache.org/log4j/2.x/manual/configuration.html获取参考资料。

个人而言,我最近刚开始使用log4j2,但我倾向于使用“严格XML”配置(即使用属性而不是元素名称),这可以进行模式验证。

以下是我的简单示例,使用自动配置和严格模式,并使用“Property”设置文件名:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration monitorinterval="30" status="info" strict="true">
    <Properties>
        <Property name="filename">log/CelsiusConverter.log</Property>
    </Properties>
    <Appenders>
        <Appender type="Console" name="Console">
            <Layout type="PatternLayout" pattern="%d %p [%t] %m%n" />
        </Appender>
        <Appender type="Console" name="FLOW">
            <Layout type="PatternLayout" pattern="%C{1}.%M %m %ex%n" />
        </Appender>
        <Appender type="File" name="File" fileName="${filename}">
            <Layout type="PatternLayout" pattern="%d %p %C{1.} [%t] %m%n" />
        </Appender>
    </Appenders>
    <Loggers>
        <Root level="debug">
            <AppenderRef ref="File" />
            <AppenderRef ref="Console" />
            <!-- Use FLOW to trace down exact method sending the msg -->
            <!-- <AppenderRef ref="FLOW" /> -->
        </Root>
    </Loggers>
</Configuration>

灵活的配置在你试图将配置从构建中分离并将配置放入其他存储库时非常方便。不幸的是,这些复杂性使其有些烦人,但我想强调灵活配置选项的好处。 - adprocas
这里的“文件”策略是什么?最大文件大小是多少?它如何写入文件?(文件是否始终包含最后10MB的日志?) - Tina J

4

虽然已经有很好的回答了,但如果你想为控制台日志添加颜色,可以使用以下模式:

<PatternLayout pattern="%style{%date{DEFAULT}}{yellow}
            [%t] %highlight{%-5level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green} %logger{36} - %message\n"/>

完整的log4j2文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Properties>
        <Property name="APP_LOG_ROOT">/opt/test/log</Property>
    </Properties>
    <Appenders>
        <Console name="ConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout pattern="%style{%date{DEFAULT}}{yellow}
                [%t] %highlight{%-5level}{FATAL=bg_red, ERROR=red, WARN=yellow, INFO=green} %logger{36} - %message\n"/>
        </Console>
        <RollingFile name="XML_ROLLING_FILE_APPENDER"
                     fileName="${APP_LOG_ROOT}/appName.log"
                     filePattern="${APP_LOG_ROOT}/appName-%d{yyyy-MM-dd}-%i.log.gz">
            <PatternLayout pattern="%d{DEFAULT} [%t] %-5level %logger{36} - %msg%n"/>
            <Policies>
                <SizeBasedTriggeringPolicy size="19500KB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="ConsoleAppender"/>
        </Root>
        <Logger name="com.compName.projectName" level="debug">
            <AppenderRef ref="XML_ROLLING_FILE_APPENDER"/>
        </Logger>
    </Loggers>
</Configuration>

日志将如下所示: 在此输入图片描述


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接