zlog使用手册，小靠谱啊

http://hardysimpson.github.io/zlog/UsersGuide-CN.html

Chapter 1 zlog是什么？

zlog是一个高可靠性、高性能、线程安全、灵活、概念清晰的纯C日志函数库。

事实上，在C的世界里面没有特别好的日志函数库（就像JAVA里面的的log4j，或者C++的log4cxx）。C程序员都喜欢用自己的轮子。printf就是个挺好的轮子，但没办法通过配置改变日志的格式或者输出文件。syslog是个系统级别的轮子，不过速度慢，而且功能比较单调。

所以我写了zlog。

zlog在效率、功能、安全性上大大超过了log4c，并且是用c写成的，具有比较好的通用性。

zlog有这些特性：

syslog分类模型，比log4j模型更加直接了当
日志格式定制，类似于log4j的pattern layout
多种输出，包括动态文件、静态文件、stdout、stderr、syslog、用户自定义输出函数
运行时手动、自动刷新配置文件（同时保证安全）
高性能，在我的笔记本上达到25万条日志每秒, 大概是syslog(3)配合rsyslogd的1000倍速度
用户自定义等级
多线程和多进程环境下保证安全转档
精确到微秒
简单调用包装dzlog（一个程序默认只用一个分类）
MDC，线程键-值对的表，可以扩展用户自定义的字段
自诊断，可以在运行时输出zlog自己的日志和配置状态
不依赖其他库，只要是个POSIX系统就成(当然还要一个C99兼容的vsnprintf)

相关链接：

主页：http://hardysimpson.github.com/zlog/

下载：https://github.com/HardySimpson/zlog/releases

邮箱：HardySimpson1984@gmail.com
1.1 兼容性说明

zlog是基于POSIX的。目前我手上有的环境只有AIX和linux。在其他的系统下（FreeBSD, NetBSD, OpenBSD, OpenSolaris, Mac OS X...）估计也能行，有问题欢迎探讨。
zlog使用了一个C99兼容的vsnprintf。也就是说如果缓存大小不足，vsnprintf将会返回目标字符串应有的长度（不包括’’)。如果在你的系统上vsnprintf不是这么运作的，zlog就不知道怎么扩大缓存。如果在目标缓存不够的时候vsnprintf返回-1，zlog就会认为这次写入失败。幸运的是目前大多数c标准库符合C99标准。glibc 2.1,libc on AIX, libc on freebsd...都是好的，不过glibc2.0不是。在这种情况下，用户需要自己来装一个C99兼容的vsnprintf，来crack这个函数库。我推荐ctrio, 或者C99-snprintf。只要改buf.c就行，祝好运！
有网友提供了如下版本，方便其他平台上安装编译，非常感谢！

auto tools版本: https://github.com/bmanojlovic/zlog

cmake版本: https://github.com/lisongmin/zlog

windows版本: https://github.com/lopsd07/WinZlog

1.2 zlog 1.2 发布说明

zlog 1.2 新增了这些功能
对管道的支持，从此zlog可以外接cronolog这样的日志过滤程序来输出
全面的日志转档支持，详见5.6
其他兼容性的代码改动
zlog 1.2 在库方面是和zlog 1.0/1.1二进制兼容的，区别在于：
所有的宏改为小写，ZLOG_INFO->zlog_info，方便开发者手工输入。这是一个巨大的改变，如果zlog1.1/1.0的用户要用zlog 1.2的话，需要写一个脚本，把源代码中的大写批量替换为小写，然后重新编译你的程序。我提供了一个脚本：

sed -i -e ’s/w*ZLOGw*/L&E/g’ aa.c

取消了auto tools的使用，也就是说，不论你在任何平台，都需要gcc和gnu make才能编译安装zlog。主流的操作系统(Aix, OpenSolaris..)都能安装gcc和gnu make。当然也可以自行修改makefile来完成编译，对于平台稍有经验的Geek都可以自行完成！

Chapter 2 zlog不是什么？

zlog的目标是成为一个简而精的日志函数库，不会直接支持网络输出或者写入数据库，不会直接支持日志内容的过滤和解析。

原因很明显，日志库是被应用程序调用的，所有花在日志库上的时间都是应用程序运行时间的一部分，而上面说的这些操作都很费时间，会拖慢应用程序的速度。这些事儿应该在别的进程或者别的机器上做。

如果你需要这些特性，我建议使用rsyslog、zLogFabric、Logstash，这些日志搜集、过滤、存储软件，当然这是单独的进程，不是应用程序的一部分。

目前zlog已经支持7.4，可以自己实现一个输出函数，自由的把日志输出到其他进程或者其他机器。而把日志的分类匹配、日志格式成型的工作交给zlog。

目前我的想法是实现一个zlog-redis客户端，用自定义输出功能，把日志存储到本机或者远程的redis服务器内，然后用其他进程(也使用zlog库)来把日志写到文件里面，不知大家以为这个想法如何？欢迎和我联系探讨。
Chapter 3 Hello World
3.1 编译和安装zlog

下载zlog-latest-stable.tar.gz

$ tar -zxvf zlog-latest-stable.tar.gz

$ cd zlog-latest-stable/

$ make

$ sudo make install

or

$ sudo make PREFIX=/usr/local/ install

PREFIX指明了安装的路径，安转完之后为了让你的程序能找到zlog动态库

$ sudo vi /etc/ld.so.conf

/usr/local/lib

$ sudo ldconfig

在你的程序运行之前，保证libzlog.so在系统的动态链接库加载器可以找到的目录下。上面的命令适用于linux，别的系统自己想办法。

除了一般的make以外，还可以

$ make 32bit # 32bit version on 64bit machine, libc6-dev-i386 is needed

$ make noopt # without gcc optimization

$ make doc # lyx and hevea is needed

$ make test # test code, which is also good example for zlog

makefile是用GNU make的格式写的，所以在你的平台上需要预装gnu make和gcc。或者，手工修改一个自己平台的makefile也行。

3.2 应用程序调用和链接zlog

应用程序使用zlog很简单，只要在C文件里面加一行。

#include "zlog.h"

链接zlog需要pthread库，命令是：

$ cc -c -o app.o app.c -I/usr/local/include

# -I[where zlog.h is put]

$ cc -o app app.o -L/usr/local/lib -lzlog -lpthread

# -L[where libzlog.so is put]

3.3 Hello World 代码

这些代码在$(top_builddir)/test/test_hello.c, test_hello.conf

写一个C文件：

$ vi test_hello.c

#include <stdio.h>
#include "zlog.h"

int main(int argc, char** argv)
{
    int rc;
    zlog_category_t *c;

    rc = zlog_init("test_hello.conf");
    if (rc) {
        printf("init failed
");
        return -1;
    }

    c = zlog_get_category("my_cat");
    if (!c) {
        printf("get cat fail
");
        zlog_fini();
        return -2;
    }

    zlog_info(c, "hello, zlog");
    zlog_fini();
    return 0;

}                    

写一个配置文件，放在和test_hello.c同样的目录下:

$ vi test_hello.conf

[formats]
simple = "%m%n"

[rules]
my_cat.DEBUG >stdout; simple

编译、然后运行!

$ cc -c -o test_hello.o test_hello.c -I/usr/local/include
$ cc -o test_hello test_hello.o -L/usr/local/lib -lzlog
$ ./test_hello
hello, zlog

3.4 更简单的Hello World

这个例子在$(top_builddir)/test/test_default.c, test_default.conf. 源代码是：

#include <stdio.h>
#include "zlog.h"

int main(int argc, char** argv)
{
    int rc;
    rc = dzlog_init("test_default.conf", "my_cat");

    if (rc) {
        printf("init failed
");
        return -1;
    }

    dzlog_info("hello, zlog");
    zlog_fini();

    return 0;
}    

配置文件是test_default.conf，和test_hello.conf一模一样，最后执行程序的输出也一样。区别在于这里用了dzlog API，内含一个默认的zlog_category_t。详见6.5。
Chapter 4 Syslog 模型
4.1 分类(Category)、规则(Rule)和格式(Format)

zlog有3个重要的概念：分类(Category)、规则(Rule)和格式(Format)。

分类(Category)用于区分不同的输入。代码中的分类变量的名字是一个字符串，在一个程序里面可以通过获取不同的分类名的category用来后面输出不同分类的日志，用于不同的目的。

格式(Format)是用来描述输出日志的格式，比如是否有带有时间戳，是否包含文件位置信息等，上面的例子里面的格式simple就是简单的用户输入的信息+换行符。

规则(Rule)则是把分类、级别、输出文件、格式组合起来，决定一条代码中的日志是否输出，输出到哪里，以什么格式输出。

所以，当程序执行下面的语句的时候

zlog_category_t *c;
c = zlog_get_category("my_cat");
zlog_info(c, "hello, zlog");

zlog会找到c的名字是"my_cat"，对应的配置文件中的规则是

[rules]

my_cat.DEBUG >stdout; simple

然后库会检查，目前这条日志的级别是否符合规则中的级别来决定是否输出。因为INFO>=DEBUG，所以这条日志会被输出。并且根据这条规则，会被输出到stdout（标准输出） ，输出的格式是simple，在配置文件中定义是

[formats]

simple = "%m%n"

最后在屏幕上打印

hello, zlog

这就是整个过程。用户要做就是写自己的信息。日志往哪里输出，以什么格式输出，都是库和配置文件来完成的。
4.2 syslog模型和log4j模型的区别

好，那么目前这个模型和syslog有什么关系呢？至今为止，这个模型还是比较像log4j。log4j的模型里面有logger, appender和layout。区别在于，在log4j里面，代码中的logger和配置中的logger是一一对应的，并且一个logger有唯一的级别。一对一关系是log4j, log4cxx, log4cpp, log4cplus, log4net的唯一选择。

但这种模型是不灵活的，他们发明了过滤器（filters）来弥补，但这只能把事情弄得更加混乱。所以让我们把目光转回syslog的模型，这是一个设计的很简易正确的模型。

继续上一节的例子，如果在zlog的配置文件中有这么2行规则：

[rules]

my_cat.DEBUG >stdout; simple

my_cat.INFO >stdout;

然后，一行代码会产生两行输出：

hello, zlog

2012-05-29 10:41:36 INFO [11288:test_hello.c:41] hello, zlog

现在一个代码中的分类对应配置文件中的两条规则。log4j的用户可能会说："这很好，但是只要在log4j里面放两个appender也能做的一样。"所以继续看下一个例子：

[rules]

my_cat.WARN "/var/log/aa.log"

my_cat.DEBUG "/var/log/bb.log"

代码是：

zlog_info(c, "info, zlog");

zlog_debug(c, "debug, zlog");

最后，在aa.log中只有一条日志

2012-05-29 10:41:36 INFO [11288:test_hello.c:41] info, zlog

但在bb.log里面有两条

2012-05-29 10:41:36 INFO [11288:test_hello.c:41] info, zlog

2012-05-29 10:41:36 DEBUG [11288:test_hello.c:42] debug, zlog

从这个例子能看出来区别。log4j无法轻易的做到这一点。在zlog里面，一个分类可以对应多个规则，每个规则有自己的级别、输出和格式。这就让用户能按照需求过滤、多渠道输出自己的所有日志。
4.3 扩展syslog模型

所以到现在你能看出来zlog的模型更像syslog的模型。不幸的是，在syslog里面，设施（facility）是个int型，而且必须从系统定义的那几种里面选择。zlog走的远一点，用一个字符串来标识分类。

syslog有一个通配符"*"，匹配所有的设施（facility）。zlog里面也一样，"*"匹配所有分类。这提供了一个很方便的办法来重定向你的系统中各个组件的错误。只要这么写：

[rules]

*.error "/var/log/error.log"

zlog强大而独有的特性是上下级分类匹配。如果你的分类是这样的：

c = zlog_get_category("my_cat");

然后配置文件是这样的

[rules]

my_cat.* "/var/log/my_cat.log"

my_.NOTICE "/var/log/my.log"

这两条规则都匹配c分类"my_cat"。通配符"_" 表示上级分类。 "my_"是"my_cat"和"my_dog"的上级分类。还有一个通配符是"!"，详见5.5.2
Chapter 5 配置文件

大部分的zlog的行为取决于配置文件：把日志打到哪里去，用什么格式，怎么转档。配置文件是zlog的黑话，我尽量把这个黑话设计的简单明了。这是个配置文件例子：

# comments

[global]
strict init = true
buffer min = 1024
buffer max = 2MB
rotate lock file = /tmp/zlog.lock
default format = "%d.%us %-6V (%c:%F:%L) - %m%n"
file perms = 600

[levels]
TRACE = 10
CRIT = 130, LOG_CRIT

[formats]
simple = "%m%n"
normal = "%d %m%n"

[rules]
default.* >stdout; simple
*.* "%12.2E(HOME)/log/%c.log", 1MB*12; simple
my_.INFO >stderr;
my_cat.!ERROR "/var/log/aa.log"
my_dog.=DEBUG >syslog, LOG_LOCAL0; simple
my_mice.* $user_define;

有关单位：当设置内存大小或者大数字时，可以设置1k 5GB 4M这样的单位：

# 1k => 1000 bytes
# 1kb => 1024 bytes
# 1m => 1000000 bytes
# 1mb => 1024*1024 bytes
# 1g => 1000000000 bytes
# 1gb => 1024*1024*1024 byte

单位是大小写不敏感的，所以1GB 1Gb 1gB是等效的。
5.1 全局参数

全局参数以[global]开头。[]代表一个节的开始，四个小节的顺序不能变，依次为global-levels-formats-rules。这一节可以忽略不写。语法为

(key) = (value)

strict init

如果"strict init"是true，zlog_init()将会严格检查所有的格式和规则，任何错误都会导致zlog_init() 失败并且返回-1。当"strict init"是false的时候，zlog_init()会忽略错误的格式和规则。 这个参数默认为true。
reload conf period

这个选项让zlog能在一段时间间隔后自动重载配置文件。重载的间隔以每进程写日志的次数来定义。当写日志次数到了一定值后，内部将会调用zlog_reload()进行重载。每次zlog_reload()或者zlog_init()之后重新计数累加。因为zlog_reload()是原子性的，重载失败继续用当前的配置信息，所以自动重载是安全的。默认值是0，自动重载是关闭的。
buffer min
buffer max

zlog在堆上为每个线程申请缓存。"buffer min"是单个缓存的最小值，zlog_init()的时候申请这个长度的内存。写日志的时候，如果单条日志长度大于缓存，缓存会自动扩充，直到到"buffer max"。 单条日志再长超过"buffer max"就会被截断。如果 "buffer max" 是 0，意味着不限制缓存，每次扩充为原先的2倍，直到这个进程用完所有内存为止。缓存大小可以加上 KB, MB 或 GB这些单位。默认来说"buffer min"是 1K ， "buffer max" 是2MB。
rotate lock file

这个选项指定了一个锁文件，用来保证多进程情况下日志安全转档。zlog会在zlog_init()时候以读写权限打开这个文件。确认你执行程序的用户有权限创建和读写这个文件。转档日志的伪代码是：

write(log_file, a_log)
if (log_file > 1M)
if (pthread_mutex_lock succ && fcntl_lock(lock_file) succ)
if (log_file > 1M) rotate(log_file);
fcntl_unlock(lock_file);
pthread_mutex_unlock;

mutex_lock用于多线程， fcntl_lock用于多进程。fcntl_lock是POSIX建议锁。详见man 3 fcntl。这个锁是全系统有效的。在某个进程意外死亡后，操作系统会释放此进程持有的锁。这就是我为什么用fcntl锁来保证安全转档。进程需要对锁文件有读写权限。

默认来说，rotate lock file = self。在这种情况下，zlog不会创建任何锁文件，用配置文件作为锁文件。fcntl是建议锁，所以用户可以自由的修改存储他们的配置文件。一般来说，单个日志文件不会被不同操作系统用户的进程转档，所以用配置文件作为锁文件是安全的。

如果你设置其他路径作为锁文件，例如/tmp/zlog.lock，zlog会在zlog_init()的时候创建这个文件。如果有多个操作系统用户的进程需要转档同一个日志文件，确认这个锁文件对于多个用户都可读写。默认值是/tmp/zlog.lock。
default format

这个参数是缺省的日志格式，默认值为：

"%d %V [%p:%F:%L] %m%n"

这种格式产生的输出类似这样：

2012-02-14 17:03:12 INFO [3758:test_hello.c:39] hello, zlog

file perms

这个指定了创建日志文件的缺省访问权限。必须注意的是最后的产生的日志文件的权限为"file perms"& ~umask。默认为600，只允许当前用户读写。
fsync period

在每条规则写了一定次数的日志到文件后，zlog会调用fsync(3)来让操作系统马上把数据写到硬盘。次数是每条规则单独统计的，并且在zlog_reload()后会被清0。必须指出的是，在日志文件名是动态生成或者被转档的情况下，zlog不能保证把所有文件都搞定，zlog只fsync()那个时候刚刚write()的文件描述符。这提供了写日志速度和数据安全性之间的平衡。例子：

$ time ./test_press_zlog 1 10 100000
real 0m1.806s
user 0m3.060s
sys 0m0.270s

$ wc -l press.log
1000000 press.log

$ time ./test_press_zlog 1 10 100000 #fsync period = 1K
real 0m41.995s
user 0m7.920s
sys 0m0.990s

$ time ./test_press_zlog 1 10 100000 #fsync period = 10K
real 0m6.856s
user 0m4.360s
sys 0m0.550s

如果你极度在乎安全而不是速度的话，用同步IO文件，见5.5.3。默认值是0，由操作系统来决定什么时候刷缓存到文件。

5.2 日志等级自定义

这一节以[levels]开始。用于定义用户自己的日志等级，建议和用户自定义的日志记录宏一起使用。这一节可以忽略不写。语法为：

(level string) = (level int), (syslog level, optional)

(level int)必须在[1,253]这个范围内，越大越重要。(syslog level)是可选的，如果不设默认为LOG_DEBUG。

详见7.3。
5.3 格式(Formats)

这一节以[formats]开始。用来定义日志的格式。语法为：

(name) = "(actual formats)"

很好理解，(name)被后面的规则使用。(name)必须由数字和字母组成，下划线"_"也算字母。(actual format)前后需要有双引号。 (actual formats)可以由转换字符组成，见下一节。
5.4 转换格式串

转换格式串的设计是从C的printf函数里面抄来的。一个转换格式串由文本字符和转换说明组成。

转换格式串用在规则的日志文件路径和输出格式(format)中。

你可以把任意的文本字符放到转换格式串里面。

每个转换说明都是以百分号(%)打头的，后面跟可选的宽度修饰符，最后以转换字符结尾。转换字符决定了输出什么数据，例如分类名、级别、时间日期、进程号等等。宽度修饰符控制了这个字段的最大最小宽度、左右对齐。下面是简单的例子。

如果转换格式串是：

"%d(%m-%d %T) %-5V [%p:%F:%L] %m%n".

源代码中的写日志语句是：

zlog_info(c, "hello, zlog");

将会输出：

02-14 17:17:42 INFO [4935:test_hello.c:39] hello, zlog

可以注意到，在文本字符和转换说明之间没有显式的分隔符。zlog解析的时候知道哪里是转换说明的开头和结尾。在这个例子里面%-5p这个转换说明决定了日志级别要被左对齐，占5个字符宽。
5.4.1 转换字符

可以被辨认的转换字符是

字符

效果

例子
%c

分类名

aa_bb
%d()

打日志的时间。这个后面要跟一对小括号()内含说明具体的日期格式。就像%d(%F)或者%d(%m-%d %T)。如果不跟小括号，默认是%d(%F %T)。括号内的格式和 strftime(2)的格式一致。详见5.4.3

%d(%F) 2011-12-01

%d(%m-%d %T) 12-01 17:17:42

%d(%T) 17:17:42.035

%d 2012-02-14 17:03:12

%d()
%E()

获取环境变量的值

%E(USER) simpson
%ms

毫秒，3位数字字符串

取自gettimeofday(2)

013
%us

微秒，6位数字字符串

取自gettimeofday(2)

002323
%F

源代码文件名，来源于__FILE__宏。在某些编译器下 __FILE__是绝对路径。用%f来去掉目录只保留文件名，或者编译器有选项可以调节

test_hello.c

或者在某些编译器下

/home/zlog/src/test/test_hello.c
%f

源代码文件名，输出$F最后一个’/’后面的部分。当然这会有一定的性能损失

test_hello.c
%H

主机名，来源于 gethostname(2)

zlog-dev
%L

源代码行数，来源于__LINE__宏

135
%m

用户日志，用户从zlog函数输入的日志。

hello, zlog
%M

MDC (mapped diagnostic context)，每个线程一张键值对表，输出键相对应的值。后面必需跟跟一对小括号()内含键。例如 %M(clientNumber) ，clientNumbe是键。 详见 7.1

%M(clientNumber) 12345
%n

换行符，目前还不支持windows换行符


%p

进程ID，来源于getpid()

2134
%U

调用函数名，来自于__func__(C99)或者__FUNCTION__(gcc)，如果编译器支持的话。

main
%V

日志级别，大写

INFO
%v

日志级别，小写

info
%t

16进制表示的线程ID，来源于pthread_self()

"0x%x",(unsigned int) pthread_t

0xba01e700
%T

相当于%t,不过是以长整型表示的

"%lu", (unsigned long) pthread_t

140633234859776
%%

一个百分号

%
%[其他字符]

解析为错误，zlog_init()将会失败

5.4.2 宽度修饰符

一般来说数据按原样输出。不过，有了宽度修饰符，就能够控制最小字段宽度、最大字段宽度和左右对齐。当然这要付出一定的性能代价。

可选的宽度修饰符放在百分号和转换字符之间。

第一个可选的宽度修饰符是左对齐标识，减号(-)。然后是可选的最小字段宽度，这是一个十进制数字常量，表示最少有几个字符会被输出。如果数据本来没有那么多字符，将会填充空格（左对齐或者右对齐）直到最小字段宽度为止。默认是填充在左边也就是右对齐。当然你也可以使用左对齐标志，指定为填充在右边来左对齐。填充字符为空格(space)。如果数据的宽度超过最小字段宽度，则按照数据的宽度输出，永远不会截断数据。

这种行为可以用最大字段宽度来改变。最大字段宽度是放在一个句点号(.)后面的十进制数字常量。如果数据的宽度超过了最大字段宽度，则尾部多余的字符（超过最大字段宽度的部分）将会被截去。 最大字段宽度是8，数据的宽度是10，则最后两个字符会被丢弃。这种行为和C的printf是一样的，把后面的部分截断。

下面是各种宽度修饰符和分类转换字符配合一起用的例子。
宽度修饰符

左对齐

最小字段宽度

最大字段宽度

附注
%20c

否

20

无

左补充空格，如果分类名小于20个字符长。
%-20c

是

20

无

右补充空格，如果分类名小于20个字符长。
%.30c

无

无

30

如果分类名大于30个字符长，取前30个字符，去掉后面的。
%20.30c

否

20

30

如果分类名小于20个字符长，左补充空格。如果在20-30之间，按照原样输出。如果大于30个字符长，取前30个字符，去掉后面的。
%-20.30c

是

20

30

如果分类名小于20个字符长，右补充空格。如果在20-30之间，按照原样输出。如果大于30个字符长，取前30个字符，去掉后面的。
5.4.3 时间字符

这里是转换字符d支持的时间字符。

所有字符都是由strftime(2)生成的，在我的linux操作系统上支持的是：

字符

效果

例子
%a

一星期中各天的缩写名，根据locale显示

Wed
%A

一星期中各天的全名，根据locale显示

Wednesday
%b

缩写的月份名，根据locale显示

Mar
%B

月份全名，根据locale显示

March
%c

当地时间和日期的全表示， 根据locale显示

Thu Feb 16 14:16:35 2012
%C

世纪 (年/100)，2位的数字(SU)

20
%d

一个月中的某一天 (01-31)

06
%D

相当于%m/%d/%y. (呃，美国人专用，美国人要知道在别的国家%d/%m/%y 才是主流。也就是说在国际环境下这个格式容易造成误解，要少用) (SU)

02/16/12
%e

就像%d，一个月中的某一天，但是头上的0被替换成空格(SU)

6
%F

相当于%Y-%m-%d (ISO 8601日期格式)(C99)

2012-02-16
%G

The ISO 8601 week-based year (see NOTES) with century as a decimal number. The 4-digit year corre‐ sponding to the ISO week number (see %V). This has the same format and value as %Y, except that if the ISO week number belongs to the previous or next year, that year is used instead. (TZ)

大意是采用%V定义的年，如果那年的前几天不算新年的第一周，就算上一年

2012
%g

相当于%G，就是不带世纪 (00-99). (TZ)

12
%h

相当于%b(SU)

Feb
%H

小时，24小时表示(00-23)

14
%I

小时，12小时表示(01-12)

02
%j

一年中的各天(001-366)

047
%k

小时，24小时表示( 0-23)； 一位的前面为空格 (可和%H比较) (TZ)

15
%l

小时，12小时表示( 0-12)； 一位的前面为空格 (可和%比较)(TZ)

3
%m

月份(01-12)

02
%M

分钟(00-59)

11
%n

换行符 (SU)


%p

"AM" 或 "PM"，根据当时的时间，根据locale显示相应的值，例如"上午"、"下午" 。 中午是"PM"，凌晨是"AM"

PM
%P

相当于%p不过是小写，根据locale显示相应的值 (GNU)

pm
%r

时间+后缀AM或PM。在POSIX locale下相当于%I:%M:%S %p. (SU)

03:11:54 PM
%R

小时(24小时制):分钟 (%H:%M) (SU) 如果要带秒的，见%T

15:11
%s

Epoch以来的秒数，也就是从1970-01-01 00:00:00 UTC. (TZ)

1329376487
%S

秒(00-60). (允许60是为了闰秒)

54
%t

制表符tab(SU)

%T

小时(24小时制):分钟:秒 (%H:%M:%S) (SU)

15:14:47
%u

一周的天序号(1-7)，周一是1，另见%w (SU)

4
%U

一年中的星期序号(00-53)，周日是一周的开始，一年中第一个周日所在的周是第01周。另见%V和%W

07
%V

ISO 8601星期序号(01-53)，01周是第一个至少有4天在新年的周。另见%U 和%W(SU)

07
%w

一周的天序号(0-6)，周日是0。另见%u

4
%W

一年中的星期序号(00-53)，周一是一周的开始，一年中第一个周一所在的周是第01周。另见%V和%W

07
%x

当前locale下的偏好日期

02/16/12
%X

当前locale下的偏好时间

15:14:47
%y

不带世纪数目的年份(00-99)

12
%Y

带世纪数目的年份

2012
%z

当前时区相对于GMT时间的偏移量。采用RFC 822-conformant来计算(话说我也不知道是啥) (using "%a, %d %b %Y %H:%M:%S %z"). (GNU)

+0800
%Z

时区名(如果有的话)

CST
%%

一个百分号

%

5.5 规则(Rules)

这一节以[rules]开头。这个描述了日志是怎么被过滤、格式化以及被输出的。这节可以忽略不写，不过这样就没有日志输出了，嘿嘿。语法是：

(category).(level) (output), (options, optional); (format name, optional)

当zlog_init()被调用的时候，所有规则都会被读到内存中。当zlog_get_category()被调用，规则就被被分配给分类（5.5.2）。在实际写日志的时候，例如zlog_info()被调用的时候，就会比较这个INFO和各条规则的等级，来决定这条日志会不会通过这条规则输出。当zlog_reload()被调用的时候，配置文件会被重新读入，包括所有的规则，并且重新计算分类对应的规则。
5.5.1 级别匹配

zlog有6个默认的级别："DEBUG", "INFO", "NOTICE", "WARN", "ERROR"和"FATAL"。就像其他的日志函数库那样， aa.DEBUG意味着任何大于等于DEBUG级别的日志会被输出。当然还有其他的表达式。配置文件中的级别是大小写不敏感的。
表达式 含义
* 所有等级
aa.debug 代码内等级>=debug
aa.=debug 代码内等级==debug
aa.!debug 代码内等级!=debug

用户可以自定义等级，详见7.3。
5.5.2 分类匹配

分类必须由数字和字母组成，下划线"_"也算字母。
总结

配置文件规则分类

匹配的代码分类

不匹配的代码分类
*匹配所有

*.*

aa, aa_bb, aa_cc, xx, yy ...

NONE
以_结尾的分类匹配本级及下级分类

aa_.*

aa, aa_bb, aa_cc, aa_bb_cc

xx, yy
不以_结尾的精确匹配分类名

aa.*

aa

aa_bb, aa_cc, aa_bb_cc
!匹配那些没有找到规则的分类

!.*

xx

aa(as it matches rules above)
5.5.3 输出动作

目前zlog支持若干种输出，语法是：

[输出], [附加选项, 可选]; [format(格式)名, 可选]
动作 输出字段
附加选项
标准输出 >stdout
无意义
标准错误输出 >stderr
无意义
输出到syslog >syslog
syslog设施(facilitiy)：

LOG_USER(default), LOG_LOCAL[0-7]

必填
管道输出 |cat
无意义
文件 "文件路径"
文件转档，详见5.6

10M * 3 ～ "press.#r.log"
同步IO文件 -"文件路径"
用户自定义输出 $name
"path" 动态或者静态的用于record输出

stdout, stderr, syslog

如表格描述，其中只有sylog的附加选项是有意义并必须写的。

值得注意的是，zlog在写日志的时候会用这样的语句

write(STDOUT_FILENO, zlog_buf_str(a_thread->msg_buf), zlog_buf_len(a_thread->msg_buf))

而如果你的程序是个守护进程，在启动的时候把STDOUT_FILENO，也就是1的文件描述符关掉的话，会发生什么结果呢？

日志会被写到新的1的文件描述符所代表的文件里面！我收到过邮件，说zlog把日志写到自己的配置文件里面去了！

所以，千万不要在守护进程的规则里面加上>stdout或>stderr。这会产生不可预料的结果……如果一定要输出到终端，用"/dev/tty"代替。
管道输出

*.* | /usr/bin/cronolog /www/logs/example_%Y%m%d.log ; normal

这是一个将zlog的输出到管道后接cronolog的例子。实现的原理很简单，在zlog_init的时候调用popen("/usr/bin/cronolog /www/logs/example_%Y%m%d.log", "w")，后面往这个文件描述符里面写指定格式的日志。使用cronolog来生成按天分割的日志效率比zlog自己的动态路径的效率要高，因为通过管道，无须每次打开关闭动态路径的文件描述符。

[rules]

*.* "press%d(%Y%m%d).log"

$ time ./test_press_zlog 1 10 100000

real 0m4.240s

user 0m2.500s

sys 0m5.460s

[rules]

*.* | /usr/bin/cronolog press%Y%m%d.log

$ time ./test_press_zlog 1 10 100000

real 0m1.911s

user 0m1.980s

sys 0m1.470s

不过，使用管道也是有限制的：
POSIX.1-2001保证读写不大于PIPE_BUF大小的内容是原子的。linux上PIPE_BUF为4096。
单条日志的长度超过PIPE_BUF的时候并且有多个有父子关系的进程写通过zlog写同一个管道，也就是在zlog_init之后fork多个子进程，此时只有一个cronolog的进程监听一个管道描述符，日志内容可能会交错。
多个进程分别zlog_init，启动多个cronolog进程，写拥有同一个文件路径的日志文件，即使单条日志长度不超过PIPE_BUF，也有可能导致日志交错，因为cronolog读到的文件流是连续的，它不知道单条日志的边界在哪里。

所以，总结一下，使用管道来输出到单个日志文件的情况是：
单进程写，单条日志长度不限制。单进程内内的多线程写日志的原子性已经由zlog保证了。
有父子关系的多进程，单条日志长度不能超过PIPE_BUF（4096）
无父子关系的多进程使用管道同时写一个日志，无论单条日志长度是多少，都有可能导致日志交错。

zlog本身的直接文件输出能保证即使是多进程，同时调用zlog写一个日志文件也不会产生交错，见下。
文件
文件路径

可以是相对路径或者绝对路径，被双引号"包含。转换格式串可以用在文件路径上。例如文件路径是 "%E(HOME)/log/out.log"，环境变量$HOME是/home/harry，那最后的输出文件是/home/harry/log/output.log。转换格式串详见 5.4。

zlog的文件功能极为强大，例如
输出到命名管道(FIFO)，必须在调用前由mkfifo(1)创建

*.* "/tmp/pipefile"

输出到NULL，也就是不输出

*.* "/dev/null"

在任何情况下输出到终端

*.* "/dev/tty"

每线程一个日志，在程序运行的目录下

*.* "%T.log"

输出到有进程号区分的日志，每天，在$HOME/log目录，每1GB转档一次，保持5个日志文件。

*.* "%E(HOME)/log/aa.%p.%d(%F).log",1GB * 5

aa_及下级分类，每个分类一个日志

aa_.* "/var/log/%c.log"

文件转档

控制文件的大小和个数。zlog根据这个字段来转档，当日志文件太大的时候。例如

"%E(HOME)/log/out.log", 1M * 3 ~ "%E(HOME)/log/out.log.#r"

这三个参数都不是必填项，zlog的转档功能详见5.6
同步IO文件

在文件路径前加上一个"-"就打开了同步IO选项。在打开文件(open)的时候，会以O_SYNC选项打开，这时候每次写日志操作都会等操作系统把数据写到硬盘后才返回。这个选项极为耗时：

$ time ./test_press_zlog 100 1000

real 0m0.732s

user 0m1.030s

sys 0m1.080s

$ time ./test_press_zlog 100 1000 # synchronous I/O open

real 0m20.646s

user 0m2.570s

sys 0m6.950s

格式名

是可选的，如果不写，用全局配置里面的默认格式：

[global]

default format = "%d(%F %T) %V [%p:%F:%L] %m%n"

用户自定义输出详见7.4

5.6 文件转档

为什么需要将日志文件转档？我已经在实际的运行环境中不止一次的看到过，因为日志文件过大，导致系统硬盘被撑爆，或者单个日志文件过大而即使用grep也要花费很多时间来寻找匹配的日志。对于日志转档，我总结了如下几种范式：

按固定时间段来切分日志。

例如，每天生成一个日志

aa.2012-08-02.log

aa.2012-08-03.log

aa.2012-08-04.log

这种日志适合的场景是，管理员大概知道每天生成的日志量，然后希望在n个月之后能精确的找出某天的所有日志。这种日志切分最好由日志库来完成，其次的方法是用cronosplit这种软件来分析日志内容的时间字符串来进行后期的切分，较差的办法是用crontab+logrotate或mv来定期移动（但这并不精确，会造成若干条当天的日志被放到上一天的文件里面去）。

在zlog里面，这种需求不需要用日志转档功能来完成，简单的在日志文件名里面设置时间日期字符串就能解决问题：

*.* "aa.%d(%F).log"

或者用cronolog来完成，速度会更快一点

*.* | cronolog aa.%F.log

按照日志大小切分

多用于开发环境，适合的场景是，程序在短时间内生成大量的日志，而用编辑器vi,ue等能快速打开的日志大小是有限的，或者大的日志打开来极慢。同样的，这种日志的切分可以在事后用split等工具来完成，但对于开发而言会增加步骤，所以最好也是由日志库来完成。值得一提的是存档有两种模式，nlog里面称之为Sequence和Rolling，在Sequence情况下

aa.log (new)

aa.log.2 (less new)

aa.log.1

aa.log.0 (old)

而在Rolling的情况下

aa.log (new)

aa.log.0 (less new)

aa.log.1

aa.log.2 (old)

很难说哪种更加符合人的直觉。

如果只有若干个最新的文件是有意义的，需要日志库来做主动的删除旧的工作。由外部程序是很难判定哪些日志是旧的。

最简单的zlog的转档配置为

*.* "aa.log", 10MB

这个配置是Rolling的情况，每次aa.log超过10MB的时候，会做这样的重命名

aa.log.2 -> aa.log.3

aa.log.1 -> aa.log.2

aa.log.0 -> aa.log.1

aa.log -> aa.log.0

上面的配置可以写的更加罗嗦一点

*.* "aa.log", 10MB * 0 ~ "aa.log.#r"

逗号后第一个参数表示文件达到多大后开始进行转档。

第二个参数表示保留多少个存档文件（0代表不删除任何存档文件）。

第三个参数表示转档的文件名，其中#r表示存档文件的序号，r是rolling的缩写。还可以放#s，是sequence的缩写。转档文件名必须包含#r或者#s。
按照日志大小切分，但同时加上时间标签

aa.log

aa.log-20070305.00.log

aa.log-20070501.00.log

aa.log-20070501.01.log

aa.log-20071008.00.log

这种情况适合于程序本身的日志一般不是很受关注，但是又在某一天想要找出来看的情况。当然，在这种情况下，万一在20070501这一天日志的量超过了指定值，例如100MB，就又要退回到第二种状态，在文件名中加后缀。

zlog对应的配置是

*.* "aa.log", 100MB ~ "aa-%d(%Y%m%d).#2s.log"

每到100MB的时候转档，转档文件名也支持转换字符，可以把转档当时的时间串作为转档文件名的一部分。#2s的意思是序号的长度最少为2位，从00开始编号，Sequence转档。这是zlog对转档最复杂的支持了！
压缩、移动、删除旧的日志

首先，压缩不应该由日志库来完成，因为压缩消耗时间和CPU。日志库的任务是配合压缩。

对于第一种和第三种，管理较为简单，只要符合某些文件名规则或修改日期的，可以用shell脚本+crontab轻易的压缩、移动和删除。

对于第二种，其实不是非常需要压缩，只需要删除就可以了。

如果一定需要转档的同时进行压缩，只有logrotate能干这活儿，毕竟他是独立的程序，能在转档同时搞压缩，不会有混淆的问题。
zlog对外部转档工具，例如logrotate的支持

zlog的转档功能已经极为强大，当然也有几种情况是zlog无法处理的，例如按时间条件进行转档，转档前后调用一些自制的shell脚本……这会把zlog的配置和表达弄得过于复杂而缺乏美感。

这时候你也许喜欢用一些外部转档工具，例如logrotate来完成工作。问题是，在linux操作系统下，转档工具重命名日志文件名后，应用进程还是往原来的文件描述符写日志，没办法重新打开日志文件写新的日志。标准的做法是给应用程序一个信号，让他重新打开日志文件，对于syslogd是

kill -SIGHUP ‘cat /var/run/syslogd.pid‘

对于zlog，因为是个函数库，不适合接受信号。zlog提供了函数接口zlog_reload()，这个函数会重载配置文件，重新打开所有的日志文件。应用程序在logrotate的信号，或者其他途径，例如客户端的命令后，可以调用这个函数，来重新打开所有的日志文件。

5.7 配置文件工具

$ zlog-chk-conf -h

Useage: zlog-chk-conf [conf files]...

-q, suppress non-error message

-h, show help message

zlog-chk-conf 尝试读取配置文件，检查语法，然后往屏幕上输出这些配置文件是否正确。我建议每次创建或者改动一个配置文件之后都用一下这个工具。输出可能是这样：

$ ./zlog-chk-conf zlog.conf

03-08 15:35:44 ERROR (10595:rule.c:391) sscanf [aaa] fail, category or level is null

03-08 15:35:44 ERROR (10595:conf.c:155) zlog_rule_new fail [aaa]

03-08 15:35:44 ERROR (10595:conf.c:258) parse configure file[zlog.conf] line[126] fail

03-08 15:35:44 ERROR (10595:conf.c:306) zlog_conf_read_config fail

03-08 15:35:44 ERROR (10595:conf.c:366) zlog_conf_build fail

03-08 15:35:44 ERROR (10595:zlog.c:66) conf_file[zlog.conf], init conf fail

03-08 15:35:44 ERROR (10595:zlog.c:131) zlog_init_inner[zlog.conf] fail

---[zlog.conf] syntax error, see error message above

这个告诉你配置文件zlog.conf的126行，是错的。第一行进一步告诉你[aaa]不是一条正确的规则。

zlog-chk-conf可以同时分析多个配置文件，举例：

$ zlog-chk-conf zlog.conf ylog.conf

--[zlog.conf] syntax right

--[ylog.conf] syntax right

Chapter 6 zlog接口(API)

zlog的所有函数都是线程安全的，使用的时候只需要

#include "zlog.h"

6.1 初始化和清理

总览

int zlog_init(const char *confpath);

int zlog_reload(const char *confpath);

void zlog_fini(void);

描述

zlog_init()从配置文件confpath中读取配置信息到内存。如果confpath为NULL，会寻找环境变量ZLOG_CONF_PATH的值作为配置文件名。如果环境变量ZLOG_CONF_PATH也没有，所有日志以内置格式写到标准输出上。每个进程只有第一次调用zlog_init()是有效的，后面的多余调用都会失败并不做任何事情。

zlog_reload()从confpath重载配置，并根据这个配置文件来重计算内部的分类规则匹配、重建每个线程的缓存、并设置原有的用户自定义输出函数。可以在配置文件发生改变后调用这个函数。这个函数使用次数不限。如果co"[