PHP日志扩展SeasLog学习

文章来源于：开源中国社区http://www.oschina.NET/p/seaslog

附1：PECL项目主页http://pecl.php.net/package/SeasLog

附2：GitHub项目主页https://github.com/Neeke/SeasLog

SeasLog
Yet a log extension for PHP.A effective,fast,stable log extension for php
@author Chitao.Gao [[e-mail]]

为什么使用SeasLog

log日志，通常是系统或软件、应用的运行记录。通过log的分析，可以方便用户了解系统或软件、应用的运行情况；如果你的应用log足够丰富，也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息；如果一个应用的log同时也分了多个级别，那么可以很轻易地分析得到该应用的健康状况，及时发现问题并快速定位、解决问题，补救损失。

php内置error_log、syslog函数功能强大且性能极好，但由于各种缺陷(error_log无错误级别、无固定格式，syslog不分模块、与系统日志混合)，灵活度降低了很多，不能满足应用需求。

好消息是，有不少第三方的log类库弥补了上述缺陷，如log4php、plog、Analog等(当然也有很多应用在项目中自己开发的log类)。其中以log4php最为著名，设计精良、格式完美、文档完善、功能强大。推荐。

不过log4php在性能方面表现非常差,下图是SeasLog与log4php的ab并发性能测试( 测试环境:Ubuntu12.04单机,CPU I3,内存 16G,硬盘 SATA 7200): 

那么有没有一种log类库满足以下需求呢：

• 分模块、分级别

• 配置简单(最好是勿须配置)

• 日志格式清晰易读

• 应用简单、性能很棒

   SeasLog 正是应此需求而生。

目前提供了什么

• 在PHP项目中便捷、规范地记录log

• 可配置的默认log目录与模块

• 指定log目录与获取当前配置

• 初步的分析预警框架

• 高效的日志缓冲、便捷的缓冲debug

• 遵循 PSR-3 日志接口规范

• 自动记录错误信息

• 自动记录异常信息

目标是怎样的

• 便捷、规范的log记录

• 高效的海量log分析

• 可配置、多途径的log预警

安装

编译安装 seaslog

[php] view plain copy

1. $ /path/to/phpize  
2. $ ./configure --with-php-config=/path/to/php-config  
3. $ make && make install  

seaslog.ini 的配置

[php] view plain copy

1. ; configuration for php SeasLog module  
2. extension = seaslog.so  
3. seaslog.default_basepath = /log/seaslog-test            ;默认log根目录  
4. seaslog.default_logger = default                        ;默认logger目录  
5. seaslog.disting_type = 1                                ;是否以type分文件 1是 0否(默认)  
6. seaslog.disting_by_hour = 1                             ;是否每小时划分一个文件 1是 0否(默认)  
7. seaslog.use_buffer = 1                                  ;是否启用buffer 1是 0否(默认)  
8. seaslog.buffer_size = 100                               ;buffer中缓冲数量 默认0(不使用buffer_size)  
9. seaslog.level = 0                                       ;记录日志级别 默认0(所有日志)  
10. seaslog.trace_error = 1                                 ;自动记录错误 默认1(开启)  
11. seaslog.trace_exception = 0                             ;自动记录异常信息 默认0(关闭)  
12. seaslog.default_datetime_format = "%Y:%m:%d %H:%M:%S"   ;日期格式配置 默认"%Y:%m:%d %H:%M:%S"  

seaslog.disting_type = 1 开启以type分文件，即log文件区分info\warn\erro

seaslog.disting_by_hour = 1 开启每小时划分一个文件

seaslog.use_buffer = 1 开启buffer。默认关闭。当开启此项时，日志预存于内存，当请求结束时(或异常退出时)一次写入文件。

常量与函数

常量列表

[php] view plain copy

1. * SEASLOG_DEBUG                       "debug"  
2. * SEASLOG_INFO                        "info"  
3. * SEASLOG_NOTICE                      "notice"  
4. * SEASLOG_WARNING                     "warning"  
5. * SEASLOG_ERROR                       "error"  
6. * SEASLOG_CRITICAL                    "critical"  
7. * SEASLOG_ALERT                       "alert"  
8. * SEASLOG_EMERGENCY                   "emergency"  
9.    
10.    
11. var_dump(SEASLOG_DEBUG,SEASLOG_INFO,SEASLOG_NOTICE);  
12. /* 
13. string('debug') debug级别 
14. string('info')  info级别 
15. string('notice') notice级别 
16. */  

 函数列表

SeasLog 提供了这样一组函数，可以方便地获取与设置根目录、模块目录、快速写入与统计log。 相信从下述伪代码的注释中，您可以快速获取函数信息，具体使用将紧接其后：

[php] view plain copy

1. <?php  
2. /** 
3.  * @author [e-mail] 
4.  * Date: 14-1-27 下午4:47 
5.  */  
6.    
7.    
8. class SeasLog  
9. {  
10.     public function __construct()  
11.     {  
12.         #SeasLog init  
13.     }  
14.    
15.    
16.     public function __destruct()  
17.     {  
18.         #SeasLog distroy  
19.     }  
20.    
21.    
22.     /** 
23.      * 设置basePath 
24.      * @param $basePath 
25.      * @return bool 
26.      */  
27.     static public function setBasePath($basePath)  
28.     {  
29.         return TRUE;  
30.     }  
31.    
32.    
33.     /** 
34.      * 获取basePath 
35.      * @return string 
36.      */  
37.     static public function getBasePath()  
38.     {  
39.         return 'the base_path';  
40.     }  
41.    
42.    
43.     /** 
44.      * 设置模块目录 
45.      * @param $module 
46.      * @return bool 
47.      */  
48.     static public function setLogger($module)  
49.     {  
50.         return TRUE;  
51.     }  
52.    
53.    
54.     /** 
55.      * 获取最后一次设置的模块目录 
56.      * @return string 
57.      */  
58.     static public function getLastLogger()  
59.     {  
60.         return 'the lastLogger';  
61.     }  
62.    
63.    
64.     /** 
65.      * 统计所有类型（或单个类型）行数 
66.      * @param $level 
67.      * @param string $log_path 
68.      * @return array | long 
69.      */  
70.     static public function analyzerCount($level = 'all',$log_path = '*')  
71.     {  
72.         return array();  
73.     }  
74.    
75.    
76.     /** 
77.      * 以数组形式，快速取出某类型log的各行详情 
78.      * @param $level 
79.      * @param string $log_path 
80.      * @return array 
81.      */  
82.     static public function analyzerDetail($level = SEASLOG_INFO,$log_path = '*')  
83.     {  
84.         return array();  
85.     }  
86.    
87.    
88.     /** 
89.      * 获得当前日志buffer中的内容 
90.      * @return array 
91.      */  
92.     static public function getBuffer()  
93.     {  
94.         return array();  
95.     }  
96.    
97.     /** 
98.      * 将buffer中的日志立刻刷到硬盘 
99.      * 
100.      * @return bool 
101.      */  
102.     static public function flushBuffer()  
103.     {  
104.         return TRUE;  
105.     }  
106.    
107.    
108.     /** 
109.      * 记录debug日志 
110.      * @param $message 
111.      * @param array $content 
112.      * @param string $module 
113.      */  
114.     static public function debug($message,array $content = array(),$module = '')  
115.     {  
116.         #$level = SEASLOG_DEBUG  
117.     }  
118.    
119.    
120.     /** 
121.      * 记录info日志 
122.      * @param $message 
123.      * @param array $content 
124.      * @param string $module 
125.      */  
126.     static public function info($message,array $content = array(),$module = '')  
127.     {  
128.         #$level = SEASLOG_INFO  
129.     }  
130.    
131.    
132.     /** 
133.      * 记录notice日志 
134.      * @param $message 
135.      * @param array $content 
136.      * @param string $module 
137.      */  
138.     static public function notice($message,array $content = array(),$module = '')  
139.     {  
140.         #$level = SEASLOG_NOTICE  
141.     }  
142.    
143.    
144.     /** 
145.      * 记录warning日志 
146.      * @param $message 
147.      * @param array $content 
148.      * @param string $module 
149.      */  
150.     static public function warning($message,array $content = array(),$module = '')  
151.     {  
152.         #$level = SEASLOG_WARNING  
153.     }  
154.    
155.    
156.     /** 
157.      * 记录error日志 
158.      * @param $message 
159.      * @param array $content 
160.      * @param string $module 
161.      */  
162.     static public function error($message,array $content = array(),$module = '')  
163.     {  
164.         #$level = SEASLOG_ERROR  
165.     }  
166.    
167.    
168.     /** 
169.      * 记录critical日志 
170.      * @param $message 
171.      * @param array $content 
172.      * @param string $module 
173.      */  
174.     static public function critical($message,array $content = array(),$module = '')  
175.     {  
176.         #$level = SEASLOG_CRITICAL  
177.     }  
178.    
179.    
180.     /** 
181.      * 记录alert日志 
182.      * @param $message 
183.      * @param array $content 
184.      * @param string $module 
185.      */  
186.     static public function alert($message,array $content = array(),$module = '')  
187.     {  
188.         #$level = SEASLOG_ALERT  
189.     }  
190.    
191.    
192.     /** 
193.      * 记录emergency日志 
194.      * @param $message 
195.      * @param array $content 
196.      * @param string $module 
197.      */  
198.     static public function emergency($message,array $content = array(),$module = '')  
199.     {  
200.         #$level = SEASLOG_EMERGENCY  
201.     }  
202.    
203.    
204.     /** 
205.      * 通用日志方法 
206.      * @param $level 
207.      * @param $message 
208.      * @param array $content 
209.      * @param string $module 
210.      */  
211.     static public function log($level,$message,array $content = array(),$module = '')  
212.     {  
213.    
214.    
215.     }  
216. }  

SeasLog Logger的使用（详细文档）

使用SeasLog进行健康预警

预警的配置

[php] view plain copy

1. [base]  
2. wait_analyz_log_path = /log/base_test  
3.    
4.    
5. [fork]  
6. ;是否开启多线程 1开启 0关闭  
7. fork_open = 1  
8.    
9.    
10. ;线程个数  
11. fork_count = 3  
12.    
13.    
14. [warning]  
15. email[smtp_host] = smtp.163.com  
16. email[smtp_port] = 25  
17. email[subject_pre] = 预警邮件 -  
18. email[smtp_user] = [e-mail]  
19. email[smtp_pwd] = seaslog#demo  
20. email[mail_from] = [e-mail]  
21. email[mail_to] = [e-mail]  
22. email[mail_cc] = [e-mail]  
23. email[mail_bcc] =  
24.    
25.    
26. [analyz]  
27. ; enum  
28. ; SEASLOG_DEBUG      "debug"  
29. ; SEASLOG_INFO       "info"  
30. ; SEASLOG_NOTICE     "notice"  
31. ; SEASLOG_WARNING    "warning"  
32. ; SEASLOG_ERROR      "error"  
33. ; SEASLOG_CRITICAL   "critical"  
34. ; SEASLOG_ALERT      "alert"  
35. ; SEASLOG_EMERGENCY  "emergency"  
36.    
37.    
38. test1[module] = test/bb  
39. test1[level] = SEASLOG_ERROR  
40. test1[bar] = 1  
41. test1[mail_to] = [e-mail]  
42.    
43.    
44. test2[module] = 222  
45. test2[level] = SEASLOG_WARNING  
46.    
47.    
48. test3[module] = 333  
49. test3[level] = SEASLOG_CRITICAL  
50.    
51.    
52. test4[module] = 444  
53. test4[level] = SEASLOG_EMERGENCY  
54.    
55.    
56. test5[module] = 555  
57. test5[level] = SEASLOG_DEBUG  

crontab配置

[php] view plain copy

1. ;每天凌晨3点执行  
2. 0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php  

Demo: 

[php] view plain copy

1. <?php  
2. /** 
3.  * @author [e-mail] 
4.  * Date: 14-1-27 下午4:41 
5.  */    
6.    
7. SeasLog::log(SEASLOG_ERROR,'this is a error test by ::log');  
8.    
9. SeasLog::debug('this is a {userName} debug',array('{userName}' => 'neeke'));  
10.    
11. SeasLog::info('this is a info log');  
12.    
13. SeasLog::notice('this is a notice log');  
14.    
15. SeasLog::warning('your {website} was down,please {action} it ASAP!',array('{website}' => 'github.com','{action}' => 'rboot'));  
16.    
17. SeasLog::error('a error log');  
18.    
19. SeasLog::critical('some thing was critical');  
20.    
21. SeasLog::alert('yes this is a {messageName}',array('{messageName}' => 'alertMSG'));  
22.    
23. SeasLog::emergency('Just now, the house next door was completely burnt out! {note}',array('{note}' => 'it`s a joke'));  
24. echo "\n";