ROS中log4j的学习记录

ROS中log4j的学习记录

因为最近师兄叫学习这个，在网上看到很多log4j的讲解，但是好像很多都不是和ROS相关的，调用文件都是用的C++这种调用的，而ros中主要是用.launch文件调用的好像。学习记录如下：

在ros中的调用：

一般都是在launch文件夹中的launch文件中被调用的：

前面几行，被选中的地方就是选定config文件的目录，名字。

 <env name="ROSCONSOLE_CONFIG_FILE"
     value="$(eval optenv('ROSCONSOLE_CONFIG_FILE', find('web_interface') + '/config/log.conf'))"/>
  <node pkg="web_interface" type="web_control.py" name="web_control_service" output="screen">

主要作用是设置ROS的环境变量。

先上一段conf文件中的代码：

log4j.logger.ros=WARN
log4j.logger.ros.learning_topic=INFO,pkg_pro
log4j.appender.pkg_pro=org.apache.log4j.RollingFileAppender
log4j.appender.pkg_pro.File=${HOME}/history/task/lala.log
log4j.appender.pkg_pro.MaxFileSize=10240KB
log4j.appender.pkg_pro.MaxBackupIndex=10
log4j.appender.pkg_pro.layout=org.apache.log4j.PatternLayout
log4j.appender.pkg_pro.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss SSS}] %t %p %M:%L - %m%n
#log4j.appender.pkg_pro.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss SSS}] %t %c{1} %p %M %L - %m%n

其中每句话都有不同的含义：
首先

log4j.logger.ros=WARN

都需要配置根logger，这句话好像就是配置根logger的。其中WARN是日志级别，表示输出WARN及以上等级的信息：

日志级别：ALL，DEBUG， INFO， WARN， ERROR，FATAL，OFF
Log4J推荐使用：DEBUG， INFO， WARN， ERROR
OFF 为最高等级 关闭了日志信息
FATAL 为可能导致应用中止的严重事件错误
ERROR 为严重错误 主要是程序的错误
WARN 为一般警告，比如session丢失
INFO 为一般要显示的信息，比如登录登出
DEBUG 为程序的调试信息
TRACE 为比DEBUG更细粒度的事件信息
ALL 为最低等级，将打开所有级别的日志

然后

log4j.logger.ros.learning_topic=INFO,task

ROS官方介绍文档说的是：

log4j.logger.ros.my_package_name=DEBUG

对应关系是 logger.ros后面一定要跟着功能包的名字，这里的my_package_name=learning_topic！如果跟的不是功能包的名字，则会导致没有输出信息，甚至会报错。

然后是

log4j.appender.pkg_pro=org.apache.log4j.RollingFileAppender

其中appender是日志输出器（不可以自定义），配置日志的输出级别、输出位置等，后面的pkg_pro是appenderName，也就是一个别名，可以自定义。这里是在这篇文章学习的。
‘=’号后面的一串东西是用来配置日志信息输出目的地的：

1.org.apache.log4j.ConsoleAppender（控制台）
2.org.apache.log4j.FileAppender（文件）
3.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
4.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
5.org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

然后后面的

log4j.appender.pkg_pro.File=${HOME}/history/task/lala.log

是配置输出文件的位置+名称
后面的MaxFileSize、MaxBackupIndex是有关RollingFileAppender的配置参数：

MaxFileSize 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex 指定可以产生的滚动文件的最大数。

后面的

log4j.appender.pkg_pro.layout=org.apache.log4j.PatternLayout

中的PatternLayout，是布局模式的配置。

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

最后，补充上面的代码中可能没有出现的log4j的一些解释：

控制台选项
Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台 FileAppender 选项
Threshold=DEBUF:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

RollingFileAppender 选项
Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB.
在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd
HH:mm:ssS} %c %m%n 日志信息格式中几个符号所代表的含义：
-X号: X信息输出时左对齐； %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL, %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd
HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 %r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名 %t: 输出产生该日志事件的线程名 %l:
输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main
(TestLog4.Java:10) %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java
servlets这样的多客户多线程的应用中。 %%: 输出一个"%“字符 %F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息 %n:
输出一个回车换行符，Windows平台为”\r\n"，Unix平台为"\n"输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。