Java项目日志记录方案

转自：https://blog.csdn.net/zollty/article/details/53958439
一、概述
1、采用slf4j作为日志API，采用logback作为日志输出工具，用slf4j桥接方式替换掉log4j和commons-logging。2、采用trace（追踪）、debug（调试）、info（信息）、warn（警告）、error（错误）、fatal（致命）共6种日志级别。3、采用dev（开发环境）、test（测试环境）、production（生产环境）等不同的日志配置，根据环境变量自动识别。4、特殊的记录，需要大批量写入日志文件，应该采用异步线程写文件。
二、日志级别定义    采用trace（追踪）、debug（调试）、info（信息）、warn（警告）、error（错误）、fatal（致命）共6种日志级别。
日志级别使用原则：1、fatal（致命错误）使用原则fatal为系统级别的异常，发生fatal错误，代表服务器整个或者核心功能已经无法工作了！！1）在服务器启动时就应该检查，如果存在致命错误，直接抛异常，让服务器不要启动起来（启动了也无法正常工作，不如不启动）。2）如果在服务器启动之后，发生了致命的错误，则记录fatal级别的错误日志，最好是同时触发相关的修复和告警工作（比如，给开发和维护人员发送告警邮件）。
2、error（错误）使用原则error为功能或者逻辑级别的严重异常，发生error级别的异常，代表功能或者重要逻辑遇到问题、无法正常工作。
3、warn（警告）使用原则warn用在某些逻辑非常规，发生了一些小故障但是没有大的影响，或者重要数据被修改，或者某些操作需要引起重视。
4、info（信息）使用原则info用于记录一些有用的、关键的信息，一般这些信息出现得不频繁，只是在初始化的地方或者重要操作的地方才记录。
5、debug（调试）使用原则debug用于记录一些调试信息，为了方便查看程序的执行过程和相关数据、了解程序的动态。
6、trace（跟踪）使用原则trace用于记录一些更详细的调试信息，这些信息无需每次调试时都打印出来，只在需要更详细的调试信息时才开启。
7、项目稳定运行时的日志量1）正常情况下，trace日志至少是debug日志的100倍，trace级别的日志量 ： debug级别的日志量  >  100 ： 1，也就是说trace日志非常多，debug日志相对较少。
2）debug级别的日志量 ： info级别的日志量 > 1000 ： 1，也就是说正常情况下，info日志很少，只在部分重要位置会输出 info日志。
3）error日志和warn日志，正常情况下，几乎为0，当出现异常时，error日志和warn日志量 也在可控范围，不会超过debug级别的最大日志量。
三、日志输出（Appender）分类
分为5个一般类：     FILE_EXCEPTION （异常日志，包括ERROR和WARN）    FILE_APP （应用日志，包括当前应用package下面的日志和DEBUG级别以上的其他日志）    FILE_INFO （普通信息日志）    FILE_DEBUG （调试日志）    FILE_TRACE（追踪日志）    SYSOUT（控制台输出，可以包括以上所有日志）扩展类： 包括异步输出的日志，或者特殊业务日志。
举例说明：假如 当前应用的 Main Package 为 cn.zollty.lightningROOT_LEVEL为 trace，应用日志 LEVEL 为 debug有以下日志打印：那么，异常日志（FILE_EXCEPTION）输出的为：loggerA.warn("--------");loggerA.error("--------");loggerB.warn("--------");loggerB.error("--------");控制台（SYSOUT）输出日志的为;loggerA.debug("--------");loggerA.info("--------");loggerA.warn("--------");loggerA.error("--------");loggerB.trace("--------");loggerB.debug("--------");loggerB.info("--------");loggerB.warn("--------");loggerB.error("--------");应用日志（FILE_APP）输出的为：
loggerA.debug("--------");loggerA.info("--------");loggerA.warn("--------");loggerA.error("--------");loggerB.info("--------");loggerB.warn("--------");loggerB.error("--------");
2、历史日志文件异常日志（error和warn）最多保存 9000 M（生产，测试）app日志最多保存 9000 M （生产，测试）trace日志最多保存 1000 M （仅供测试用，一般不用）debug、info日志最多保存 5000 M（一般不用，用app日志就够了）
四、各环境默认日志定义
开发环境
1）默认日志级别定义为：    app包为TRACE级别。日志的ROOT Level为DEBUG级别。2）启用 System.out 控制台输出日志；启用error.log为错误和警告日志、app.log为应用日志（包括app包下的日志和其他INFO级别以上的日志）。
测试环境1）默认日志级别定义为：    app包为DEBUG级别。日志的ROOT Level为DEBUG级别。2）禁用 System.out 控制台输出日志；启用error.log为错误和警告日志、app.log为应用日志（包括app包下的日志和其他INFO级别以上的日志）。
生产环境1）默认日志级别定义为：    app包为DEBUG级别。日志的ROOT Level为INFO级别。2）禁用 System.out 控制台输出日志；启用error.log为错误和警告日志、app.log为应用日志（包括app包下的日志和其他INFO级别以上的日志）。
五、根据环境自动选择日志配置（借助Logback）
关键点1：使用logback的环境变量定义和读取功能例如下面的各种环境变量定义：其中 ${deploy.env:-dev} 代表的意思是，如果环境变量中没有 deploy.env，则使用默认值dev。
一个小技巧：可以自定义类似下面这个类，在logback初始化之前，先设置变量的值：这个类继承自ch.qos.logback.core.status.OnConsoleStatusListener。
关键点2：使用logback的 if-then 条件语法参考配置：logback.xml：includedConfig.xml
special_log_level.xml
也可以把变量定义到properties文件中，本地就放在 src/resources/conf/logback_val.properties服务器上放在${catalina.base}/conf/logback_val.properties配置如下：logback_val.properties:参考资料：http://logback.qos.ch/manual/configuration.html#conditional