美菜POP日志文档

一、 日志使用说明

Log4J的三个组件：

1. Logger：日志记录器，负责收集处理日志记录     （如何处理日志）

2. Appender：日志输出目的地，负责日志的输出  （输出到什么 地方）

3. Layout：日志格式化，负责对输出的日志格式化（以什么形式展现）

一个logger可以对应多个appender，一个appender只能对应一个layout。

1、Logger：

logger可以有选择的启动和禁用日志的输出，我们经常会在各种框架中看到如：

Java代码                          

 log就代表了一个Logger实例，他的name就是类“XX”的full quailied name（类的全限定名），按照上图所述，这个log就可以指定多个appender和layout。Logger的名字大小写敏感，其命名有继承机制：例如：name为org.apache.commons的logger会继承name为org.apache的logger。

Log4J中有一个特殊的logger叫做“root”，他是所有logger的根，也就意味着其他所有的logger都会直接或者间接地继承自root。root logger可以用Logger.getRootLogger()方法获取。

2、Level（日志的级别）：

level为logger服务，用来定义日志的级别，他的值可以是：

1. OFF（关闭）
2. FATAL（致命的）
3. ERROR（错误）
4. WARN（警告）
5. INFO（信息）
6. DEBUG （调试）
7. ALL（所有）

输出日志的策略由此Level决定，例如：如果logger的Level设置为INFO，那么系统只输出INFO以及以上（WARN、ERROR、FATAL）信息。如果当前logger没有设定Level，那么它在输出日志时采用的策略是：它会使用它继承的Logger的Level作为它自己的Level来处理。如果它的上级也没有设置Level，那么就找上上级，几次类推，直到root为止，（root的Level是不能设为空的，所以最终一定会找到一个Level）。默认root的Level是INFO，其他logger的Level默认都是null，需要手动指定。

3、Appender（日志输出目的地）：

Appender可以控制日志的输出的目的地，一个输出源就叫一个Appender，appender的类别有：

1. Console（控制台）
2. File（文件）
3. JDBC、
4. JMS

logger可以通过方法logger.addAppender(appender);配置多个appender，对logger来说，每个有效的日志请求结果都将输出到logger本身以及父logger的appender上

常用的集中appender有：

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

org.apache.log4j.RollingFileAppender（（文件大小到达指定尺寸的时候产生一个新的文件）

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

4、Layout（日志记录格式）：

使用指定的Layout来展示（格式化）日志，常见的Layout有：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

org.apache.log4j.PatternLayout（可以灵活地指定布局模式）

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

5、配置：

理解了以上几个组件后，我们就可以了解一下log4j的配置log4j.properties了。

%-5p代表什么意思呢？

因为日志级别分别有error,warn,info,debug,fatal5种，有些是5个字母的，有些是4个字母的，如果直接写%p就会对不齐，%-5p的意思是日志级别输出左对齐，右边以空格填充，%5p的意思是日志级别输出右对齐，左边以空格填充，附三张图对比

1、直接%p

2、%-5p

3、%5p

二、公司日志格式

• Created by 赵浩博, last modified by 李样兵 liyangbing on 十月 08, 2016

1.dubbo-log4j配置

#default 
log4j.rootLogger=${mvn.log.root} 
 
#packages 
log4j.logger.org.springframework=WARN 
log4j.logger.org.apache=WARN 
log4j.logger.com.sprucetec=${mvn.log.sprucetec} 
 
#console log 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 
log4j.appender.stdout.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p - [%t]%l -- %m%n 
 
#adapter log 
log4j.appender.common=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.common.layout=org.apache.log4j.PatternLayout 
log4j.appender.common.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p - [%t]%l -- %m%n 
log4j.appender.common.file=${mvn.log.path}/common.log 
log4j.appender.common.file.threshold=INFO 
log4j.appender.common.append=true 
log4j.appender.common.encoding=UTF-8 
log4j.appender.common.datePattern=‘.‘yyyy-MM-dd‘.log‘

<mvn.log.root>INFO,stdout,common</mvn.log.root> 
<mvn.log.path>/data/log/dmall-bms-admin-web</mvn.log.path> 
<mvn.log.sprucetec>INFO</mvn.log.sprucetec>

2.tomcat-log4j配置

#default 
log4j.rootLogger=${mvn.log.root} 
 
#packages 
log4j.logger.org.springframework=WARN 
log4j.logger.org.apache=WARN 
log4j.logger.com.sprucetec=${mvn.log.sprucetec} 
 
#console log 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 
log4j.appender.stdout.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p - [%t]%l -- %m%n 
 
#adapter log 
log4j.appender.common=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.common.layout=org.apache.log4j.PatternLayout 
log4j.appender.common.layout.conversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p - [%t]%l -- %m%n 
log4j.appender.common.file=${mvn.log.path}/common.log 
log4j.appender.common.file.threshold=INFO 
log4j.appender.common.append=true 
log4j.appender.common.encoding=UTF-8 
log4j.appender.common.datePattern=‘.‘yyyy-MM-dd‘.log‘

<mvn.log.root>INFO,stdout,common</mvn.log.root> 
<mvn.log.path>/data/log/dmall-bms-admin-web</mvn.log.path> 
<mvn.log.sprucetec>INFO</mvn.log.sprucetec>

3.php-log配置(明雷补充下吧)

日志文件统一写到一个文件中，不要按日期建立文件，部署环境会自动切分文件(需要配置linux切分规则)。

三、日志使用注意事项

1.避免用异常处理逻辑

2.调用外部接口记录日志需要记录出参、入参和返回结果

log4j