log4cplus配置文件说明

log4cplus配置文件说明

时间	作者	备注
2023-02-16	jeffreychen	创建文档

log4cplus版本:2.0.8

1. 概要

配置文件中总共包含4部分内容：Logger、Appender、layout、filter

配置主要关注Appender和layout，若要新增conf,在ctl\ctlagent\confd\tmpl相关模块下新增相关配置即可

可参考ctl\ctlagent\confd\tmpl\zone\conf.d\zone_conf.toml及ctl\ctlagent\confd\tmpl\zone\templates\zone_log.conf.tmpl

2. Logger的定义和调用

略

3. 日志的级别

NOT_SET_LOG_LEVEL ( -1) 接受缺省的LogLevel，如果有父logger则继承它的LogLevel

ALL_LOG_LEVEL (0) 开放所有log信息输出

TRACE_LOG_LEVEL (0) 开放trace信息输出(即ALL_LOG_LEVEL)

DEBUG_LOG_LEVEL(10000) 开放debug信息输出

INFO_LOG_LEVEL (20000) 开放info信息输出

WARN_LOG_LEVEL (30000) 开放warning信息输出

ERROR_LOG_LEVEL(40000) 开放error信息输出

FATAL_LOG_LEVEL (50000) 开放fatal信息输出

OFF_LOG_LEVEL (60000) 关闭所有log信息输出

4. Appender

4.1 Appender 家族

Appender 基础Appender类

ConsoleAppender 输出到控制台

FileAppenderBase 输出到文件的基础类，不可以被实例化

FileAppender 输出到文件

RollingFileAppender 输出到文件-可以按照文件大小或者数量滚动

DailyRollingFileAppender 输出到文件-可以按照日期时间滚动

TimeBasedRollingFileAppender 可以按照用户定义的时间滚动日志

SocketAppender 网络日志

4.2 Appender 类

layout 日志打印格式

filters 日志过滤器

Threshold 日志打印的最低级别

4.3 ConsoleAppender 类

logToStdErr 说明：输出方式 类型：bool 默认值：false 可选值：true=std::cerr false=std::cout

ImmediateFlush 说明：立即输出 类型：bool 默认值：false 可选值：true false

4.4 FileAppenderBase

File 说明：文件路径\文件名 类型：String 默认值：无 可选值：文件路径\文件名

ImmediateFlush 说明：立即刷新 类型：bool 默认值：true 可选值：true false

Append 说明：追加到文件末尾继续写入 类型：bool 默认值：false 可选值：true false

ReopenDelay 说明：当上一次日志写入失败后延长多久后再次打开日志文件继续写入 类型：int 默认值：1（秒） 可选值：int 有效值

BufferSize 说明：缓存大小 类型：unsigned long 默认值：0（秒） 可选值：unsigned long 有效值

UseLockFile 说明：使用锁文件，多进程对同一文件同时写入的优化机制 类型：bool 默认值：false 可选值：true false

LockFile 说明：锁文件的文件名尾缀，只有在 UseLockFile 为 true 时有效 类型：String 默认值：.lock 可选值：非空即可

Locale 说明：字符集 类型：String 默认值：DEFAULT 可选值：en_US.UTF-8 GLOBAL DEFAULT USER Chinese_China.936 Chinese_China.65001

CreateDirs 说明：如果目录及文件不存在就创建 类型：bool 默认值：false 可选值：true false

4.5 FileAppender

没有额外的附加属性。

4.6 RollingFileAppender(ps:当前项目用的就是此种FileAppender)

MaxFileSize 说明：最大文件大小 类型：long 默认值：10 MB 可选值：可自定义大小，在配置文件中可以带上单位 M

MaxBackupIndex 说明：最大文件数量 类型：int 默认值：1 可选值：大于零即可

4.7 DailyRollingFileAppender

Schedule 说明：滚动的时间计划 类型：DailyRollingFileSchedule 默认值：DAILY 可选值：MONTHLY WEEKLY DAILY TWICE_DAILY HOURLY MINUTELY

MaxBackupIndex 说明：最大文件数量 类型：int 默认值：10 可选值：大于零即可

RollOnClose 说明：在关闭时是否翻转日志文件 类型：bool 默认值：true 可选值：true false

DatePattern 说明：滚动的日期格式，如果该属性存在则 Schedule 无效，但 Schedule 仍不能为空。 类型：String 默认值：无

可选值：下文“转换标志符”中(3)点中的内容。例如：%Y-%m-%d-%H-%M

4.8 TimeBasedRollingFileAppender（ps:后续若日志文件名称要加时间，可用此FileAppender）

FilenamePattern 说明：自定义文件名 类型：String 默认值：无 可选值：下文“

MaxHistory 说明：最大历史文件数量 类型：int 默认值：10 可选值：大于零即可

CleanHistoryOnStart 说明：每次运行清空历史 类型：bool 默认值：false 可选值：true false

RollOnClose 说明：每次停止程序滚动日志 类型：bool 默认值：true 可选值：true false

4.9 SocketAppender

host 说明：主机IP 类型：String 默认值：无 可选值：localhost IP地址

port 说明：端口号 类型：unsigned int 默认值：9998 可选值：端口号合法值即可

ServerName 说明：服务端名称 类型：String 默认值：无 可选值：字符串即可

5. layout

log4cplus提供了三种类型的Layouts，分别是SimpleLayout、PatternLayout、和TTCCLayout。

考虑转换格式方便使用，PatternLayout

6.filter

略，暂时没有特别的filter需求,现在用的是LogLevelMatchFilter，根据LogLevel来过滤输出日志

7. 转换标识符

（1）"%%"，转义为%, 即，std::string pattern = "%%" 时输出"%"。

（2）"%c"，输出logger名称，比如std::string pattern ="%c" 时输出: "test_logger.subtest"， 也可以控制logger名称的显示层次，比如"%c{1}"时输出"test_logger"，其中数字表示层次。

（3）"%D"，显示本地时间，当std::string pattern ="%D" 时输出:"2004-10-16 18:55:45"，%d显示标准时间，所以当std::string pattern ="%d" 时输出"2004-10-16 10:55:45" （因为北京时间位于东8区，差8个小时）。

可以通过%d{...}定义更详细的显示格式，比如%d{%H:%M:%s}表示要显示小时:分钟：秒。大括号中可显示的预定义标识符如下：

%a -- 表示礼拜几，英文缩写形式，比如"Fri"

%A -- 表示礼拜几，比如"Friday"

%b -- 表示几月份，英文缩写形式，比如"Oct"

%B -- 表示几月份，"October"

%c -- 标准的日期＋时间格式，如 "Sat Oct 16 18:56:19 2004"

%d -- 表示今天是这个月的几号(1-31)"16"

%H -- 表示当前时刻是几时(0-23)，如 "18"

%I -- 表示当前时刻是几时(1-12)，如 "6"

%j -- 表示今天是哪一天(1-366)，如 "290"

%m -- 表示本月是哪一月(1-12)，如 "10"

%M -- 表示当前时刻是哪一分钟(0-59)，如 "59"

%p -- 表示现在是上午还是下午， AM or PM

%q -- 表示当前时刻中毫秒部分(0-999)，如 "237"

%Q -- 表示当前时刻中带小数的毫秒部分(0-999.999)，如 "430.732"

%S -- 表示当前时刻的多少秒(0-59)，如 "32"

%U -- 表示本周是今年的第几个礼拜，以周日为第一天开始计算(0-53)，如 "41"

%w -- 表示礼拜几，(0-6, 礼拜天为0)，如 "6"

%W -- 表示本周是今年的第几个礼拜，以周一为第一天开始计算(0-53)，如 "41"

%x -- 标准的日期格式，如 "10/16/04"

%X -- 标准的时间格式，如 "19:02:34"

%y -- 两位数的年份(0-99)，如 "04"

%Y -- 四位数的年份，如 "2004"

%Z -- 时区名，比如 "GMT"

（4）"%F"，输出当前记录器所在的文件名称，比如std::string pattern ="%F" 时输出: "main.cpp"。

（5）"%L"，输出当前记录器所在的文件行号，比如std::string pattern ="%L" 时输出: "51"

（6）"%l"，输出当前记录器所在的文件名称和行号，比如std::string pattern ="%l" 时输出"main.cpp:51"。

（7）"%m"，输出原始信息，比如std::string pattern ="%m" 时输出: "teststr"，即上述代码中LOG4CPLUS_DEBUG的第二个参数，这种实现机制可以确保原始信息被嵌入到带格式的信息中。

（8）"%n"，换行符，没什么好解释的。

（9）"%p"，输出LogLevel，比如std::string pattern ="%p" 时输出: "DEBUG"。

（10）"%t"，输出记录器所在的线程ID，比如std::string pattern ="%t" 时输出: "1075298944"。

（11）"%x"，嵌套诊断上下文NDC (nested diagnostic context) 输出，从堆栈中弹出上下文信息，NDC可以用对不同源的log信息（同时地）交叉输出进行区分，关于NDC方面的详细介绍会在下文中提到。

（12）格式对齐，比如std::string pattern ="%-10m"时表示左对齐，宽度是10，此时会输出"teststr "，当然其它的控制字符也可以相同的方式来使用，比如"%-12d"，"%-5p"等等。