使用SeasLog打造PHP项目中的高性能日志组件(一)

mindong

云智慧（北京）科技有限公司 高驰涛

什么是SeasLog
SeasLog是一个C语言编写的PHP扩展，提供一组规范标准的功能函数，在PHP项目中方便、规范、高效地写日志，以及快速地读取和查询日志。
为什么使用SeasLog
无论在什么应用中，log日志都是架构中不可缺少的一个重要组成部分，它通常是系统或软件、应用的运行记录。通过log的分析，可以方便用户了解系统或软件、应用的运行情况；如果你的应用log足够丰富，也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息；如果一个应用的log同时也分了多个级别，那么可以很轻易地分析得到该应用的健康状况，及时发现问题并快速定位、解决问题，补救损失。
我们知道，php内置了很多log函数，如error_log、syslog、file_put_content，这些函数功能强大且性能极好，但由于各种缺陷(error_log、file_put_content无错误级别、无固定格式像是信马由缰随处乱画；syslog不区分模块、而且与系统日志混合，读syslog记录会让人抓狂的。)，灵活度降低了很多，很不能满足应用需求。基本上所有的开发者，都会自行设计封装log库，当然也会有很多开发者选择已有的开源日志库。
也有很多开源log类库弥补了上述缺陷，如log4php、plog、Analog等(当然也有很多应用在项目中自己开发的log类)。其中以log4php最为著名，它的设计精良、格式完美、文档完善、功能强大。但是经过测试，log4php的性能非常差。
这是log4php与SeasLog的性能对比图：


设计思路
那么有没有一种log类库同时满足以下需求呢：
·分模块、分级别
·配置简单(最好是勿须配置)
·日志格式清晰易读
·应用简单、性能很棒
我们知道，PSR-3标准是一个国际化的日志标准，它要求了“模块、级别、清晰、易用”等日志工作应具备的特点。因此，只要我们遵循了PSR-3标准，则我们可以完成“分模块、分级别”以及“日志格式清晰易读”的要求。
“配置简单”这个需求也很好完成。如果严格按照既定规则，其实只需要设置默认目录就可以了。

OK，现在我们只剩下“性能”这一个要求。
既然是日志，免不了会写文件，或者通过pipe通过网络传送到某个存储中心（我们暂不考虑存储中心的设计）。可以想见，假设一个请求中需要写出1000处log，那么势必会有1000次IO，这对性能将是一个很大的拖延点。一般对于处理这种多次相同的请求场景，我们要解决的其实也很简单，使用cache或buffer，把多次请求作归并，从而降低对磁盘或网络的IO，这是一个基本的思想。
SeasLog也是这么做的。设定一个buffer_size（默认100条log），使用PHP请求内存，每写一次log，塞入内存，同时buffer_size加；当buffer_size等于设置值时，则进行一次IO，同时清除buffer； 当然，如果请求结束了、或执行了die、exit或其他异常退出时，不管buffer_size有没有攒够设置值，立刻进行一次IO，同时清除buffer。

到目前为止，SeasLog的正式版本为1.1.6，采用Apache 2.0开源协议，同时可以在php.net官方，和Github库上获得它的完整代码。
Php.net     http://pecl.php.net/package/seaslog
Github      https://github.com/Neeke/SeasLog
目前提供了什么
·在PHP项目中便捷、规范地记录log
·可配置的默认log目录与模块
·指定log目录与获取当前配置
·初步的分析预警框架
·高效的日志缓冲、便捷的缓冲debug
·遵循 PSR-3 日志接口规范
怎么安装
获得源码后，可自行编译。
$ /path/to/phpize
$ ./configure --with-php-config=/path/to/php-config
$ make && make install

当然，使用PECL管理工具会更方便：
$ pecl install seaslog

seaslog.ini的配置
; configuration for php SeasLog module
extension = seaslog.so
seaslog.default_basepath = /log/seaslog-test    ;默认log根目录
seaslog.default_logger = default                ;默认logger目录
seaslog.disting_type = 1                            ;是否以type分文件 1是 0否(默认)
seaslog.disting_by_hour = 1                      ;是否每小时划分一个文件 1是 0否(默认)
seaslog.use_buffer = 1                              ;是否启用buffer 1是 0否(默认)
seaslog.buffer_size = 100                         ;buffer中缓冲数量 默认0(不使用buffer_size)
seaslog.level = 0                                       ;记录日志级别 默认0(所有日志)

seaslog.disting_type = 1 开启以type分文件，即log文件区分info\warn\erro
seaslog.disting_by_hour = 1 开启每小时划分一个文件
seaslog.use_buffer = 1 开启buffer。默认关闭。当开启此项时，日志预存于内存，当请求结束时(或异常退出时)一次写入文件。
seaslog.buffer_size = 100 设置缓冲数量为100. 默认为0,即无缓冲数量限制.当buffer_size大于0时,缓冲量达到该值则写一次文件.
seaslog.level = 3 记录的日志级别.默认为0,即所有日志均记录。当level为1时,关注debug以上级别(包括debug)，以此类推。level大于8时，所有日志均不记录。

默认常量有哪些
遵循PSR-3标准，SeasLog 共将日志分成8个级别
·SEASLOG_DEBUG "debug"
·SEASLOG_INFO "info"
·SEASLOG_NOTICE "notice"
·SEASLOG_WARNING "warning"
·SEASLOG_ERROR "error"
·SEASLOG_CRITICAL "critical"
·SEASLOG_ALERT "alert"
·SEASLOG_EMERGENCY "emergency"
关于作者：
　　高驰涛(Neeke)，云智慧高级架构师，PHP开发组成员，同时也是PECL/SeasLog等多个开源软件作者与贡献者。8年研发管理经验，早期从事大规模企业信息化研发架构，09年涉足互联网数字营销领域并深入研究架构与性能优化。对高并发、高性能、高可用系统设计实现有丰富经验。崇尚规范、敏捷、高效、GettingReal。目前在云智慧致力于APM产品的架构与研发。主要负责PHP、Python、Go等语言的底层扩展与SmartAgent的架构研发。