[TOC] [SeasLog](https://github.com/neeke/seaslog) ## 安装 php5.6+ ### linux ``` $ /path/to/phpize $ ./configure --with-php-config=/path/to/php-config $ make && make instal ``` `$ pecl install seaslog ` ### widnow [PECL/SeasLog Windows Dll](http://pecl.php.net/package/SeasLog/1.8.4/windows) ### 说明 ## seaslog.ini的配置 ``` [SeasLog] ;configuration for php SeasLog module extension = seaslog.so ;默认log根目录 seaslog.default_basepath = "/var/log/www" ;默认logger目录 seaslog.default_logger = "default" ;日期格式配置 默认"Y-m-d H:i:s" seaslog.default_datetime_format = "Y-m-d H:i:s" ;日志格式模板 默认"%T | %L | %P | %Q | %t | %M" seaslog.default_template = "%T | %L | %P | %Q | %t | %M" ;是否以目录区分Logger 1是(默认) 0否 seaslog.disting_folder = 1 ;是否以type分文件 1是 0否(默认) ,即log文件区分info\\warn\\erro seaslog.disting_type = 0 ;是否每小时划分一个文件 1是 0否(默认) seaslog.disting_by_hour = 0 ;是否启用buffer 1是 0否(默认) ,当开启此项时,日志预存于内存,当请求结束时(或异常退出时)一次写入文件 seaslog.use_buffer = 1 ;buffer中缓冲数量 默认0(不使用buffer_size) seaslog.buffer_size = 100 ;cli运行时关闭buffer ;1是 0否(默认) seaslog.buffer_disabled_in_cli = 0 ;记录日志级别,数字越大,根据级别记的日志越多。 ;0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL ;默认8(所有日志) ; ; 注意, 该配置项自1.7.0版本开始有变动。 ; 在1.7.0版本之前, 该值数字越小,根据级别记的日志越多: ; 0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency ; 1.7.0 之前的版本,该值默认为0(所有日志); seaslog.level = 8 ;日志函数调用回溯层级 ;影响预定义变量 %F 中的行数 ;默认0 seaslog.recall_depth = 0 ;自动记录notice 默认0(关闭) seaslog.trace_notice = 0 ;自动记录warning 默认0(关闭) seaslog.trace_warning = 0 ;自动记录错误 默认1(开启) seaslog.trace_error = 1 ;自动记录异常信息 默认0(关闭) seaslog.trace_exception = 0 ;日志存储介质 1File 2TCP 3UDP (默认为1) seaslog.appender = 1 ;写入重试次数 ;默认0(不重试) seaslog.appender_retry = 0 ;接收ip 默认127.0.0.1 (当使用TCP或UDP时必填) seaslog.remote_host = "127.0.0.1" ;接收端口 默认514 (当使用TCP或UDP时必填) seaslog.remote_port = 514 ;接收端口的超时时间 默认1秒 seaslog.remote_timeout = 1 ;过滤日志中的回车和换行符 (默认为0) seaslog.trim_wrap = 0 ;是否开启抛出SeasLog自身异常 1开启(默认) 0关闭 seaslog.throw_exception = 1 ;是否开启忽略SeasLog自身warning 1开启(默认) 0关闭 seaslog.ignore_warning = 1 ;是否开启性能追踪 1开启 0关闭(默认) seaslog.trace_performance = 0 ;性能追踪时的千分比采样率 ;默认10,即百分之一 seaslog.trace_performance_sample_rate = 10 ;性能追踪时的开始层级 默认从第1层开始 seaslog.trace_performance_start_depth = 1 ;性能追踪时深度层级 默认5层 seaslog.trace_performance_max_depth = 5 ;性能追踪时每层的函数最大数 按wall_time降序排列top 默认top5 seaslog.trace_performance_max_functions_per_depth = 5 ;性能追踪时当前请求执行时间的记录阈值 只有当请求执行时间大于该值时,才记录性能日志 默认1000ms seaslog.trace_performance_min_wall_time = 1000 ;性能追踪时每个方法执行时间的记录阈值 只有当方法执行时间大于该值时,才参与计算 默认10ms seaslog.trace_performance_min_function_wall_time = 10 ``` ### 日志模板说明 #### 日志模板说明 * 模板默认为:`seaslog.default_template = "%T | %L | %P | %Q | %t | %M"` * 意味着,默认的格式为`{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}` * 如果自定义的格式为:`seaslog.default_template = "[%T]:%L %P %Q %t %M"` * 那么,日志格式将被自定义为:`[{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo}` #### 预设变量表 `SeasLog`提供了下列预设变量,可以直接使用在日志模板中,将在日志最终生成时替换成对应值。 * `%L`\- Level 日志级别。 * `%M`\- Message 日志信息。 * `%T`\- DateTime 如`2017-08-16 19:15:02`,受`seaslog.default_datetime_format`影响。 * `%t`\- Timestamp 如`1502882102.862`,精确到毫秒数。 * `%Q`\- RequestId 区分单次请求,如没有调用`SeasLog::setRequestId($string)`方法,则在初始化请求时,采用内置的`static char *get_uniqid()`方法生成的惟一值。 * `%H`\- HostName 主机名。 * `%P`\- ProcessId 进程ID。 * `%D`\- Domain:Port 域名:口号,如`www.cloudwise.com:8080`; Cli模式下为`cli`。 * `%R`\- Request URI 请求URI,如`/app/user/signin`; Cli模式下为入口文件,如`CliIndex.php`。 * `%m`\- Request Method 请求类型,如`GET`; Cli模式下为执行命令,如`/bin/bash`。 * `%I`\- Client IP 来源客户端IP; Cli模式下为`local`。取值优先级为:HTTP\_X\_REAL\_IP > HTTP\_X\_FORWARDED\_FOR > REMOTE\_ADDR * `%F`\- FileName:LineNo 文件名:行号,如`UserService.php:118`。 * `%U`\- MemoryUsage 当前内容使用量,单位byte。调用`zend_memory_usage`。 * `%u`\- PeakMemoryUsage 当前内容使用峰值量,单位byte。调用`zend_memory_peak_usage`。 * `%C`\- Class::Action 类名::方法名,如`UserService::getUserInfo`。不在类中使用时,记录函数名 * ### 预设变量表 [预设变量表 ](https://github.com/SeasX/SeasLog/blob/master/README_zh.md#%E9%A2%84%E8%AE%BE%E5%8F%98%E9%87%8F%E8%A1%A8) ### 编辑器代码提示 [SeasLogCodeTips.php](https://raw.githubusercontent.com/SeasX/SeasLog/master/CodeTips/SeasLogCodeTips.php) ### 日志级别 ``` SEASLOG_DEBUG debug信息、细粒度信息事件 SEASLOG_INFO 重要事件、强调应用程序的运行过程 SEASLOG_NOTICE 重要事件、强调应用程序的运行过程 SEASLOG_WARNING 出现了非错误性的异常信息、潜在异常信息、需要关注并且需要修复 SEASLOG_ERROR 运行时出现的错误、不必要立即进行修复、不影响整个逻辑的运行、需要记录并做检测 SEASLOG_CRITICAL 紧急情况、需要立刻进行修复、程序组件不可用 SEASLOG_ALERT 必须立即采取行动的紧急事件、需要立即通知相关人员紧急修复 SEASLOG_EMERGENCY 系统不可用 ``` ### 使用SeasLog进行健康预警 #### 预警的配置 ``` [base] wait_analyz_log_path = /log/base_test [fork] ;是否开启多线程 1开启 0关闭 fork_open = 1 ;线程个数 fork_count = 3 [warning] email[smtp_host] = smtp.163.com email[smtp_port] = 25 ; 是否开启加密协议 tsl ssl, 留空为不开启 email[smtp_secure] = ; 邮件发送类型 smtp, sendmail, mail ; smtp: PHP实现的smtp协议 ; sendmail: 需配置php.ini中sendmail_path ; mail: 使用PHP内置mail()函数 email[smtp_mailer] = smtp email[subject_pre] = 预警邮件 - email[smtp_user] = seaslogdemo@163.com email[smtp_pwd] = seaslog#demo email[mail_from] = seaslogdemo@163.com email[mail_to] = gaochitao@weiboyi.com email[mail_cc] = ciogao@gmail.com email[mail_bcc] = [analyz] ; enum ; SEASLOG_DEBUG "DEBUG" ; SEASLOG_INFO "INFO" ; SEASLOG_NOTICE "NOTICE" ; SEASLOG_WARNING "WARNING" ; SEASLOG_ERROR "ERROR" ; SEASLOG_CRITICAL "CRITICAL" ; SEASLOG_ALERT "ALERT" ; SEASLOG_EMERGENCY "EMERGENCY" ; 可以实现分别监控不同模块下特定级别的日志发送给不同的邮箱 ; test1 监控任务表示 ; 统计test模块SEASLOG_ERROR等级的日志数量,如果数量大于3则发送报警邮件到gaochitao@weiboyi.com test1[module] = test test1[level] = SEASLOG_ERROR test1[bar] = 3 test1[mail_to] = neeke@php.net test2[module] = 222 test2[level] = SEASLOG_WARNING test2[mail_to] = neeke@php.net,ciogao@gmail.com test3[module] = 333 test3[level] = SEASLOG_CRITICAL test4[module] = 444 test4[level] = SEASLOG_EMERGENCY test5[module] = 555 test5[level] = SEASLOG_DEBUG ``` crontab配置 ``` ;每天凌晨3点执行 0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php ``` ## 使用的demo ``` SeasLog::setLogger("api"); //设置 default(默认)目录为api $lastLogger_1 = SeasLog::getLastLogger(); var_dump($lastLogger_1);//api SeasLog::setBasePath('log/'); $basePath_2 = SeasLog::getBasePath(); var_dump($basePath_2);///api /* 此时生成日志结构为 log/api */ //SeasLog::setDatetimeFormat( "[%T]:%L %M"); //测试时在此无效, 得在php.ini中设置 SeasLog::log(SEASLOG_ERROR,'this is a error test by ::log'); SeasLog::debug('this is a {userName} debug',array('{userName}' => 'neeke')); SeasLog::info('this is a info log'); SeasLog::notice('this is a notice log'); SeasLog::warning('your {website} was down,please {action} it ASAP!',array('{website}' => 'github.com','{action}' => 'rboot')); SeasLog::error('a error log'); SeasLog::critical('some thing was critical'); SeasLog::alert('yes this is a {messageName}',array('{messageName}' => 'alertMSG')); SeasLog::emergency('Just now, the house next door was completely burnt out! {note}',array('{note}' => 'it`s a joke')); /*过滤出日志级别为Warning 级别的日志*/ $detailErrorArray_inAll = SeasLog::analyzerDetail(SEASLOG_WARNING); print_r($detailErrorArray_inAll);// [[0] => log\\api\20191017.log:[2019-10-17 13:45:07]:WARNING your github.com was down,please rboot it ASAP!] ```