簡(jiǎn)介
為什么使用SeasLog
log日志抓艳,通常是系統(tǒng)或軟件触机、應(yīng)用的運(yùn)行記錄。通過log的分析玷或,可以方便用戶了解系統(tǒng)或軟件儡首、應(yīng)用的運(yùn)行情況;如果你的應(yīng)用log足夠豐富偏友,也可以分析以往用戶的操作行為蔬胯、類型喜好、地域分布或其他更多信息位他;如果一個(gè)應(yīng)用的log同時(shí)也分了多個(gè)級(jí)別氛濒,那么可以很輕易地分析得到該應(yīng)用的健康狀況产场,及時(shí)發(fā)現(xiàn)問題并快速定位、解決問題舞竿,補(bǔ)救損失京景。
php內(nèi)置error_log、syslog函數(shù)功能強(qiáng)大且性能極好骗奖,但由于各種缺陷(error_log無錯(cuò)誤級(jí)別确徙、無固定格式,syslog不分模塊重归、與系統(tǒng)日志混合)米愿,靈活度降低了很多,不能滿足應(yīng)用需求鼻吮。
好消息是育苟,有不少第三方的log類庫彌補(bǔ)了上述缺陷,如log4php椎木、plog违柏、Analog等(當(dāng)然也有很多應(yīng)用在項(xiàng)目中自己開發(fā)的log類)。其中以log4php最為著名香椎,設(shè)計(jì)精良漱竖、格式完美、文檔完善畜伐、功能強(qiáng)大馍惹。推薦。
不過log4php在性能方面表現(xiàn)非常差,下圖是SeasLog與log4php的ab并發(fā)性能測(cè)試( 測(cè)試環(huán)境:Ubuntu12.04單機(jī),CPU I3,內(nèi)存 16G,硬盤 SATA 7200):
那么有沒有一種log類庫滿足以下需求呢:
- 分模塊玛界、分級(jí)別
- 配置簡(jiǎn)單(最好是勿須配置)
- 日志格式清晰易讀
- 應(yīng)用簡(jiǎn)單万矾、性能很棒
SeasLog 正是應(yīng)此需求而生。
目前提供了什么
- 在PHP項(xiàng)目中便捷慎框、規(guī)范地記錄log
- 可配置的默認(rèn)log目錄與模塊
- 指定log目錄與獲取當(dāng)前配置
- 初步的分析預(yù)警框架
- 高效的日志緩沖良狈、便捷的緩沖debug
- 遵循 PSR-3 日志接口規(guī)范
- 自動(dòng)記錄錯(cuò)誤信息
- 自動(dòng)記錄異常信息
- 連接TCP端口,以RFC5424格式發(fā)送日志
- 連接UDP端口笨枯,以RFC5424格式發(fā)送日志
- 支持RequestId區(qū)分請(qǐng)求
- 支持日志模板自定義
目標(biāo)是怎樣的
- 便捷薪丁、規(guī)范的log記錄
- 高效的海量log分析
- 可配置、多途徑的log預(yù)警
安裝
編譯安裝 SeasLog
$ wget https://github.com/Neeke/SeasLog/archive/master.zip
$ unzip master.zip
$ cd /path/to/SeasLog
$ phpize
$ ./configure --with-php-config=/path/to/php-config
$ make -j2
$ sudo make install
seaslog.ini的配置
[SeasLog]
;configuration for php SeasLog module
extension = seaslog.so
;默認(rèn)log根目錄
seaslog.default_basepath = "/var/log/www"
;默認(rèn)logger目錄
seaslog.default_logger = "default"
;日期格式配置 默認(rèn)"Y-m-d H:i:s"
seaslog.default_datetime_format = "Y-m-d H:i:s"
;日志格式模板 默認(rèn)"%T | %L | %P | %Q | %t | %M"
seaslog.default_template = "%T | %L | %P | %Q | %t | %M"
;是否以type分文件 1是 0否(默認(rèn))
seaslog.disting_type = 1
;是否每小時(shí)劃分一個(gè)文件 1是 0否(默認(rèn))
seaslog.disting_by_hour = 0
;是否啟用buffer 1是 0否(默認(rèn))
seaslog.use_buffer = 0
;buffer中緩沖數(shù)量 默認(rèn)0(不使用buffer_size)
seaslog.buffer_size = 100
;記錄日志級(jí)別馅精,數(shù)字越大严嗜,根據(jù)級(jí)別記的日志越多。
;0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL
;默認(rèn)8(所有日志)
;
; 注意, 該配置項(xiàng)自1.7.0版本開始有變動(dòng)洲敢。
; 在1.7.0版本之前, 該值數(shù)字越小阻问,根據(jù)級(jí)別記的日志越多:
; 0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency
; 1.7.0 之前的版本,該值默認(rèn)為0(所有日志);
seaslog.level = 8
;日志函數(shù)調(diào)用回溯層級(jí)
;影響預(yù)定義變量 %F 中的行數(shù)
;默認(rèn)0
seaslog.recall_depth = 0
;自動(dòng)記錄錯(cuò)誤 默認(rèn)1(開啟)
seaslog.trace_error = 1
;自動(dòng)記錄異常信息 默認(rèn)0(關(guān)閉)
seaslog.trace_exception = 0
;日志存儲(chǔ)介質(zhì) 1File 2TCP 3UDP (默認(rèn)為1)
seaslog.appender = 1
;寫入重試次數(shù)
;默認(rèn)0(不重試)
seaslog.appender_retry = 0
;接收ip 默認(rèn)127.0.0.1 (當(dāng)使用TCP或UDP時(shí)必填)
seaslog.remote_host = "127.0.0.1"
;接收端口 默認(rèn)514 (當(dāng)使用TCP或UDP時(shí)必填)
seaslog.remote_port = 514
;過濾日志中的回車和換行符 (默認(rèn)為0)
seaslog.trim_wrap = 0
;是否開啟拋出SeasLog自身異常 1開啟(默認(rèn)) 0否
seaslog.throw_exception = 1
;是否開啟忽略SeasLog自身warning 1開啟(默認(rèn)) 0否
seaslog.ignore_warning = 1
- seaslog.disting_type = 1 開啟以type分文件沦疾,即log文件區(qū)分info\warn\erro
- seaslog.disting_by_hour = 1 開啟每小時(shí)劃分一個(gè)文件
- seaslog.use_buffer = 1 開啟buffer称近。默認(rèn)關(guān)閉。當(dāng)開啟此項(xiàng)時(shí)哮塞,日志預(yù)存于內(nèi)存刨秆,當(dāng)請(qǐng)求結(jié)束時(shí)(或異常退出時(shí))一次寫入文件。
- seaslog.buffer_size = 100 設(shè)置緩沖數(shù)量為100. 默認(rèn)為0,即無緩沖數(shù)量限制.當(dāng)buffer_size大于0時(shí),緩沖量達(dá)到該值則寫一次文件.
- seaslog.level = 8 記錄的日志級(jí)別.默認(rèn)為8,即所有日志均記錄忆畅。
- seaslog.level = 0 記錄EMERGENCY衡未。
- seaslog.level = 1 記錄EMERGENCY、ALERT家凯。
- seaslog.level = 2 記錄EMERGENCY缓醋、ALERT、CRITICAL绊诲。
- seaslog.level = 3 記錄EMERGENCY送粱、ALERT、CRITICAL掂之、ERROR抗俄。
- seaslog.level = 4 記錄EMERGENCY、ALERT世舰、CRITICAL动雹、ERROR、- WARNING跟压。
- seaslog.level = 5 記錄EMERGENCY胰蝠、ALERT、CRITICAL震蒋、ERROR茸塞、WARNING、NOTICE喷好。
- seaslog.level = 6 記錄EMERGENCY翔横、ALERT、CRITICAL梗搅、ERROR禾唁、WARNING、NOTICE无切、INFO荡短。
- seaslog.level = 7 記錄EMERGENCY、ALERT哆键、CRITICAL掘托、ERROR、WARNING籍嘹、NOTICE闪盔、INFO弯院、DEBUG。
- seaslog.throw_exception = 1 開啟拋出SeasLog拋出自身的異常泪掀。當(dāng)出現(xiàn)錄權(quán)限或接收服務(wù)器端口不通等情況時(shí)仔掸,拋出異常蝗碎;關(guān)閉時(shí)不拋出異常。
- seaslog.ignore_warning = 1 開啟忽略SeasLog自身的警告。當(dāng)出現(xiàn)目錄權(quán)限或接收服務(wù)器端口不通等情況時(shí)系吭,將進(jìn)行忽略啊易;關(guān)閉時(shí)欠橘,將拋出警告涛目。
自定義日志模板
很多朋友在使用過程中提到自定義日志模板的需求,于是自1.7.2版本開始靠抑,擁有了這個(gè)能力量九,允許用戶自定義日志的模板, 同時(shí)在模板中可以使用預(yù)置的諸多預(yù)設(shè)變量孕荠,參照預(yù)設(shè)變量表娩鹉。
日志模板說明
- 模板默認(rèn)為:seaslog.default_template = "%T | %L | %P | %Q | %t | %M",意味著稚伍,默認(rèn)的格式為{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}
- 如果自定義的格式為:seaslog.default_template = "[%T]:%L %P %Q %t %M"
那么弯予,日志格式將被自定義為:[{dateTime}]:{level} {pid} {uniqid} {timeStamp} {logInfo}
注意:%L 必須在%M之前,即:日志級(jí)別个曙,必須在日志內(nèi)容之前锈嫩。
自定義日志模版變量表
SeasLog提供了下列預(yù)設(shè)變量,可以直接使用在日志模板中垦搬,將在日志最終生成時(shí)替換成對(duì)應(yīng)值呼寸。
- %L - Level 日志級(jí)別。
- %M - Message 日志信息猴贰。
- %T - DateTime 如2017-08-16 19:15:02对雪,受seaslog.default_datetime_format影響。
- %t - Timestamp 如1502882102.862米绕,精確到毫秒數(shù)瑟捣。
- %Q - RequestId 區(qū)分單次請(qǐng)求,如沒有調(diào)用SeasLog::setRequestId($string)方法栅干,則在初始化請(qǐng)求時(shí)迈套,采用內(nèi)置的static char *get_uniqid()方法生成的惟一值。
- %H - HostName 主機(jī)名碱鳞。
- %P - ProcessId 進(jìn)程ID桑李。
- %D - Domain:Port 域名:口號(hào),如www.cloudwise.com:8080; Cli模式下為cli。
- %R - Request URI 請(qǐng)求URI贵白,如/app/user/signin; Cli模式下為入口文件率拒,如CliIndex.php。
- %m - Request Method 請(qǐng)求類型戒洼,如GET; Cli模式下為執(zhí)行命令俏橘,如/bin/bash。
- %I - Client IP 來源客戶端IP; Cli模式下為local圈浇。取值優(yōu)先級(jí)為:HTTP_X_REAL_IP > HTTP_X_FORWARDED_FOR > REMOTE_ADDR
- %F - FileName:LineNo 文件名:行號(hào),如UserService.php:118靴寂。
- %C - TODO Class::Action 類名::方法名磷蜀,如UserService::getUserInfo。
使用
常量與函數(shù)
常量列表
SeasLog 共將日志分成8個(gè)級(jí)別
SEASLOG_DEBUG
- "DEBUG" - debug信息百炬、細(xì)粒度信息事件
SEASLOG_INFO
- "INFO" - 重要事件褐隆、強(qiáng)調(diào)應(yīng)用程序的運(yùn)行過程
SEASLOG_NOTICE
- "NOTICE" - 一般重要性事件、執(zhí)行過程中較INFO級(jí)別更為重要的信息
SEASLOG_WARNING
- "WARNING" - 出現(xiàn)了非錯(cuò)誤性的異常信息剖踊、潛在異常信息庶弃、需要關(guān)注并且需要修復(fù)
SEASLOG_ERROR
- "ERROR" - 運(yùn)行時(shí)出現(xiàn)的錯(cuò)誤、不必要立即進(jìn)行修復(fù)德澈、不影響整個(gè)邏輯的運(yùn)行歇攻、需要記錄并做檢測(cè)
SEASLOG_CRITICAL
- "CRITICAL" - 緊急情況、需要立刻進(jìn)行修復(fù)梆造、程序組件不可用
SEASLOG_ALERT
- "ALERT" - 必級(jí)立即采取行動(dòng)的緊急事件缴守、需要立即通知相關(guān)人員緊急修復(fù)
SEASLOG_EMERGENCY
- "EMERGENCY" - 系統(tǒng)不可用
var_dump(SEASLOG_DEBUG,SEASLOG_INFO,SEASLOG_NOTICE);
/*
string('DEBUG') debug級(jí)別
string('INFO') info級(jí)別
string('NOTICE') notice級(jí)別
*/
函數(shù)列表
SeasLog 提供了這樣一組函數(shù),可以方便地獲取與設(shè)置根目錄镇辉、模塊目錄屡穗、快速寫入與統(tǒng)計(jì)log。 相信從下述偽代碼的注釋中忽肛,您可以快速獲取函數(shù)信息村砂,具體使用將緊接其后:
<?php
/**
* @author neeke@php.net
* Date: 14-1-27 下午4:47
*/
define('SEASLOG_ALL', 'ALL');
define('SEASLOG_DEBUG', 'DEBUG');
define('SEASLOG_INFO', 'INFO');
define('SEASLOG_NOTICE', 'NOTICE');
define('SEASLOG_WARNING', 'WARNING');
define('SEASLOG_ERROR', 'ERROR');
define('SEASLOG_CRITICAL', 'CRITICAL');
define('SEASLOG_ALERT', 'ALERT');
define('SEASLOG_EMERGENCY', 'EMERGENCY');
define('SEASLOG_DETAIL_ORDER_ASC', 1);
define('SEASLOG_DETAIL_ORDER_DESC', 2);
class SeasLog
{
public function __construct()
{
#SeasLog init
}
public function __destruct()
{
#SeasLog distroy
}
/**
* 設(shè)置basePath
*
* @param $basePath
*
* @return bool
*/
static public function setBasePath($basePath)
{
return TRUE;
}
/**
* 獲取basePath
*
* @return string
*/
static public function getBasePath()
{
return 'the base_path';
}
/**
* 設(shè)置本次請(qǐng)求標(biāo)識(shí)
* @param string
* @return bool
*/
static public function setRequestID($request_id){
return TRUE;
}
/**
* 獲取本次請(qǐng)求標(biāo)識(shí)
* @return string
*/
static public function getRequestID(){
return uniqid();
}
/**
* 設(shè)置模塊目錄
* @param $module
*
* @return bool
*/
static public function setLogger($module)
{
return TRUE;
}
/**
* 獲取最后一次設(shè)置的模塊目錄
* @return string
*/
static public function getLastLogger()
{
return 'the lastLogger';
}
/**
* 設(shè)置DatetimeFormat配置
* @param $format
*
* @return bool
*/
static public function setDatetimeFormat($format)
{
return TRUE;
}
/**
* 返回當(dāng)前DatetimeFormat配置格式
* @return string
*/
static public function getDatetimeFormat()
{
return 'the datetimeFormat';
}
/**
* 統(tǒng)計(jì)所有類型(或單個(gè)類型)行數(shù)
* @param string $level
* @param string $log_path
* @param null $key_word
*
* @return array | long
*/
static public function analyzerCount($level = 'all', $log_path = '*', $key_word = NULL)
{
return array();
}
/**
* 以數(shù)組形式,快速取出某類型log的各行詳情
*
* @param $level
* @param string $log_path
* @param null $key_word
* @param int $start
* @param int $limit
* @param $order 默認(rèn)為正序 SEASLOG_DETAIL_ORDER_ASC屹逛,可選倒序 SEASLOG_DETAIL_ORDER_DESC
*
* @return array
*/
static public function analyzerDetail($level = SEASLOG_INFO, $log_path = '*', $key_word = NULL, $start = 1, $limit = 20, $order = SEASLOG_DETAIL_ORDER_ASC)
{
return array();
}
/**
* 獲得當(dāng)前日志buffer中的內(nèi)容
*
* @return array
*/
static public function getBuffer()
{
return array();
}
/**
* 將buffer中的日志立刻刷到硬盤
*
* @return bool
*/
static public function flushBuffer()
{
return TRUE;
}
/**
* 記錄debug日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function debug($message, array $content = array(), $module = '')
{
#$level = SEASLOG_DEBUG
}
/**
* 記錄info日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function info($message, array $content = array(), $module = '')
{
#$level = SEASLOG_INFO
}
/**
* 記錄notice日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function notice($message, array $content = array(), $module = '')
{
#$level = SEASLOG_NOTICE
}
/**
* 記錄warning日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function warning($message, array $content = array(), $module = '')
{
#$level = SEASLOG_WARNING
}
/**
* 記錄error日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function error($message, array $content = array(), $module = '')
{
#$level = SEASLOG_ERROR
}
/**
* 記錄critical日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function critical($message, array $content = array(), $module = '')
{
#$level = SEASLOG_CRITICAL
}
/**
* 記錄alert日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function alert($message, array $content = array(), $module = '')
{
#$level = SEASLOG_ALERT
}
/**
* 記錄emergency日志
*
* @param $message
* @param array $content
* @param string $module
*/
static public function emergency($message, array $content = array(), $module = '')
{
#$level = SEASLOG_EMERGENCY
}
/**
* 通用日志方法
* @param $level
* @param $message
* @param array $content
* @param string $module
*/
static public function log($level, $message, array $content = array(), $module = '')
{
}
}
PHP Re 結(jié)果
/usr/local/php/php-7.0.6-zts-debug/bin/php --re seaslog
Extension [ <persistent> extension #32 SeasLog version 1.6.9 ] {
- Dependencies {
}
- INI {
Entry [ seaslog.default_basepath <ALL> ]
Current = '/var/log/www'
}
Entry [ seaslog.default_logger <ALL> ]
Current = 'defauult'
}
Entry [ seaslog.default_datetime_format <ALL> ]
Current = 'Y-m-d H:i:s'
}
Entry [ seaslog.default_template <ALL> ]
Current = '%L | %P | %Q | %t | %T | %M'
}
Entry [ seaslog.disting_type <ALL> ]
Current = '0'
}
Entry [ seaslog.disting_by_hour <ALL> ]
Current = '0'
}
Entry [ seaslog.use_buffer <ALL> ]
Current = '1'
}
Entry [ seaslog.trace_error <ALL> ]
Current = '1'
}
Entry [ seaslog.trace_exception <ALL> ]
Current = '1'
}
Entry [ seaslog.buffer_size <ALL> ]
Current = '10'
}
Entry [ seaslog.level <ALL> ]
Current = '0'
}
Entry [ seaslog.appender <ALL> ]
Current = '1'
}
Entry [ seaslog.remote_host <ALL> ]
Current = '127.0.0.1'
}
Entry [ seaslog.remote_port <ALL> ]
Current = '514'
}
Entry [ seaslog.trim_wrap <ALL> ]
Current = '0'
}
Entry [ seaslog.throw_exception <ALL> ]
Current = '1'
}
Entry [ seaslog.ignore_warning <ALL> ]
Current = '1'
}
}
- Constants [16] {
Constant [ string SEASLOG_VERSION ] { 1.7.5 }
Constant [ string SEASLOG_AUTHOR ] { Chitao.Gao [ neeke@php.net ] }
Constant [ string SEASLOG_ALL ] { ALL }
Constant [ string SEASLOG_DEBUG ] { DEBUG }
Constant [ string SEASLOG_INFO ] { INFO }
Constant [ string SEASLOG_NOTICE ] { NOTICE }
Constant [ string SEASLOG_WARNING ] { WARNING }
Constant [ string SEASLOG_ERROR ] { ERROR }
Constant [ string SEASLOG_CRITICAL ] { CRITICAL }
Constant [ string SEASLOG_ALERT ] { ALERT }
Constant [ string SEASLOG_EMERGENCY ] { EMERGENCY }
Constant [ integer SEASLOG_DETAIL_ORDER_ASC ] { 1 }
Constant [ integer SEASLOG_DETAIL_ORDER_DESC ] { 2 }
Constant [ integer SEASLOG_APPENDER_FILE ] { 1 }
Constant [ integer SEASLOG_APPENDER_TCP ] { 2 }
Constant [ integer SEASLOG_APPENDER_UDP ] { 3 }
}
- Functions {
Function [ <internal:SeasLog> function seaslog_get_version ] {
}
Function [ <internal:SeasLog> function seaslog_get_author ] {
}
}
- Classes [1] {
Class [ <internal:SeasLog> class SeasLog ] {
- Constants [0] {
}
- Static properties [0] {
}
- Static methods [19] {
Method [ <internal:SeasLog> static public method setBasePath ] {
- Parameters [1] {
Parameter #0 [ <required> $base_path ]
}
}
Method [ <internal:SeasLog> static public method getBasePath ] {
}
Method [ <internal:SeasLog> static public method setLogger ] {
- Parameters [1] {
Parameter #0 [ <required> $logger ]
}
}
Method [ <internal:SeasLog> static public method getLastLogger ] {
}
Method [ <internal:SeasLog> static public method setRequestID ] {
- Parameters [1] {
Parameter #0 [ <required> $request_id ]
}
}
Method [ <internal:SeasLog> static public method getRequestID ] {
}
Method [ <internal:SeasLog> static public method setDatetimeFormat ] {
- Parameters [1] {
Parameter #0 [ <required> $format ]
}
}
Method [ <internal:SeasLog> static public method getDatetimeFormat ] {
}
Method [ <internal:SeasLog> static public method analyzerCount ] {
- Parameters [3] {
Parameter #0 [ <required> $level ]
Parameter #1 [ <optional> $log_path ]
Parameter #2 [ <optional> $key_word ]
}
}
Method [ <internal:SeasLog> static public method analyzerDetail ] {
- Parameters [6] {
Parameter #0 [ <required> $level ]
Parameter #1 [ <optional> $log_path ]
Parameter #2 [ <optional> $key_word ]
Parameter #3 [ <optional> $start ]
Parameter #4 [ <optional> $limit ]
Parameter #5 [ <optional> $order ]
}
}
Method [ <internal:SeasLog> static public method getBuffer ] {
}
Method [ <internal:SeasLog> static public method flushBuffer ] {
}
Method [ <internal:SeasLog> static public method log ] {
- Parameters [4] {
Parameter #0 [ <required> $level ]
Parameter #1 [ <optional> $message ]
Parameter #2 [ <optional> $content ]
Parameter #3 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method debug ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method info ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method notice ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method warning ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method error ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method critical ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method alert ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
Method [ <internal:SeasLog> static public method emergency ] {
- Parameters [3] {
Parameter #0 [ <required> $message ]
Parameter #1 [ <optional> $content ]
Parameter #2 [ <optional> $logger ]
}
}
}
- Properties [0] {
}
- Methods [2] {
Method [ <internal:SeasLog, ctor> public method __construct ] {
}
Method [ <internal:SeasLog, dtor> public method __destruct ] {
}
}
}
}
}
SeasLog Logger的使用
獲取與設(shè)置basePath
$basePath_1 = SeasLog::getBasePath();
SeasLog::setBasePath('/log/base_test');
$basePath_2 = SeasLog::getBasePath();
var_dump($basePath_1,$basePath_2);
/*
string(19) "/log/seaslog-ciogao"
string(14) "/log/base_test"
*/
直接使用 SeasLog::getBasePath()础废,將獲取php.ini(seaslog.ini)中設(shè)置的seaslog.default_basepath 的值。
使用 SeasLog::setBasePath() 函數(shù)煎源,將改變 SeasLog::getBasePath() 的取值色迂。
設(shè)置logger與獲取lastLogger
$lastLogger_1 = SeasLog::getLastLogger();
SeasLog::setLogger('testModule/app1');
$lastLogger_2 = SeasLog::getLastLogger();
var_dump($lastLogger_1,$lastLogger_2);
/*
string(7) "default"
string(15) "testModule/app1"
*/
- 與basePath相類似的,
- 直接使用 SeasLog::getLastLogger()手销,將獲取php.ini(seaslog.ini)中設(shè)置的seaslog.default_logger的值歇僧。
- 使用 SeasLog::setLogger() 函數(shù),將改變 SeasLog::getLastLogger()的取值。
快速寫入log
上面已經(jīng)設(shè)置過了basePath與logger诈悍,于是log記錄的目錄已經(jīng)產(chǎn)生了祸轮,
log記錄目錄 = basePath / logger / {fileName}.log log文件名,以 年月日 分文件侥钳,如今天是2014年02月18日期适袜,那么 {fileName} = 20140218;
還記得 php.ini 中設(shè)置的 seaslog.disting_type 嗎?
默認(rèn)的 seaslog.disting_type = 0舷夺,如果今天我使用了 SeasLog 苦酱,那么將產(chǎn)生最終的log文件:
- LogFile = basePath / logger / 20140218.log 如果 seaslog.disting_type = 1,則最終的log文件將是這樣的三個(gè)文件
- infoLogFile = basePath / logger / 20140218.INFO.log
- warnLogFile = basePath / logger / 20140218.WARNING.log
- erroLogFile = basePath / logger / 20140218.ERROR.log
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'));
/*
這些函數(shù)同時(shí)也接受第3個(gè)參數(shù)為logger的設(shè)置項(xiàng)
注意给猾,當(dāng)last_logger == 'default'時(shí)等同于:
SeasLog::setLogger('test/new/path');
SeasLog::error('test error 3');
如果已經(jīng)在前文使用過SeasLog::setLogger()函數(shù)疫萤,第3個(gè)參數(shù)的log只在此處臨時(shí)使用,不影響下文敢伸。
*/
log格式受
seaslog.default_template
影響扯饶。 seaslog.default_template默認(rèn)模板為 seaslog.default_template = "%T | %L | %P | %Q | %t | %M" 那么在默認(rèn)情況下,日志格式為:
{dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo}
關(guān)于自定義模板池颈,及SeasLog中的預(yù)置值尾序,可參閱
自定義日志模板
2014-07-27 08:53:52 | ERROR | 23625 | 599159975a9ff | 1406422432.786 | this is a error test by log
2014-07-27 08:53:52 | DEBUG | 23625 | 599159975a9ff | 1406422432.786 | this is a neeke debug
2014-07-27 08:53:52 | INFO | 23625 | 599159975a9ff | 1406422432.787 | this is a info log
2014-07-27 08:53:52 | NOTICE | 23625 | 599159975a9ff | 1406422432.787 | this is a notice log
2014-07-27 08:53:52 | WARNING | 23625 | 599159975a9ff | 1406422432.787 | your github.com was down,please rboot it ASAP!
2014-07-27 08:53:52 | ERROR | 23625 | 599159975a9ff | 1406422432.787 | a error log
2014-07-27 08:53:52 | CRITICAL | 23625 | 599159975a9ff | 1406422432.787 | some thing was critical
2014-07-27 08:53:52 | EMERGENCY | 23625 | 599159975a9ff | 1406422432.787 | Just now, the house next door was completely burnt out! it is a joke
當(dāng)seaslog.appender配置為 2(TCP) 或 3(UDP) 時(shí),日志將推送至remote_host:remote_port的TCP或UDP端口
SeasLog發(fā)送至遠(yuǎn)端時(shí)躯砰,遵循規(guī)范RFC5424
log格式統(tǒng)一為:
<PRI>1 {timeStampWithRFC3339} {HostName} {loggerName}[{pid}]: {logInfo}
上述{logInfo}
受配置 seaslog.default_template影響每币。
發(fā)送出去的格式如:
<15>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | DEBUG | 21423 | 599157af4e937 | 1466787583.322 | this is a neeke debug
<14>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | INFO | 21423 | 599157af4e937 | 1466787583.323 | this is a info log
<13>1 2017-08-27T01:24:59+08:00 vagrant-ubuntu-trusty test/logger[27171]: 2016-06-25 00:59:43 | NOTICE | 21423 | 599157af4e937 | 1466787583.324 | this is a notice log
SeasLog Analyzer的使用
快速統(tǒng)計(jì)某類型log的count值
SeasLog在擴(kuò)展中使用管道調(diào)用shell命令 grep -wc快速地取得count值,并返回值(array || int)給PHP弃揽。
$countResult_1 = SeasLog::analyzerCount();
$countResult_2 = SeasLog::analyzerCount(SEASLOG_WARNING);
$countResult_3 = SeasLog::analyzerCount(SEASLOG_ERROR,date('Ymd',time()));
var_dump($countResult_1,$countResult_2,$countResult_3);
/*
array(8) {
["DEBUG"]=>
int(3)
["INFO"]=>
int(3)
["NOTICE"]=>
int(3)
["WARNING"]=>
int(3)
["ERROR"]=>
int(6)
["CRITICAL"]=>
int(3)
["ALERT"]=>
int(3)
["EMERGENCY"]=>
int(3)
}
int(7)
int(1)
*/
獲取某類型log列表
SeasLog在擴(kuò)展中使用管道調(diào)用shell命令 grep -w快速地取得列表脯爪,并返回array給PHP。
$detailErrorArray_inAll = SeasLog::analyzerDetail(SEASLOG_ERROR);
$detailErrorArray_today = SeasLog::analyzerDetail(SEASLOG_ERROR,date('Ymd',time()));
var_dump($detailErrorArray_inAll,$detailErrorArray_today);
/*
SeasLog::analyzerDetail(SEASLOG_ERROR) == SeasLog::analyzerDetail(SEASLOG_ERROR,'*');
取當(dāng)前模塊下所有l(wèi)evel為 SEASLOG_ERROR 的信息列表:
array(6) {
[0] =>
string(66) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 "
[1] =>
string(66) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 "
[2] =>
string(66) "2014-02-24 00:14:04 | ERROR | 8620 | 1502697015147 | 1393172044.862 | test error 3 "
[3] =>
string(66) "2014-02-24 00:14:05 | ERROR | 8646 | 599159975a9ff | 1393172045.989 | test error 3 "
[4] =>
string(66) "2014-02-24 00:14:07 | ERROR | 8672 | 599159986ec28 | 1393172047.882 | test error 3 "
[5] =>
string(66) "2014-02-24 00:14:08 | ERROR | 8698 | 5991599981cec | 1393172048.736 | test error 3 "
}
SeasLog::analyzerDetail(SEASLOG_ERROR,date('Ymd',time()));
只取得當(dāng)前模塊下矿微,當(dāng)前一天內(nèi),level為SEASLOG_ERROR 的信息列表:
array(2) {
[0] =>
string(66) "2014-02-24 00:14:02 | ERROR | 8568 | 599157af4e937 | 1393172042.717 | test error 3 "
[1] =>
string(66) "2014-02-24 00:14:04 | ERROR | 8594 | 5991576584446 | 1393172044.104 | test error 3 "
}
同理痕慢,取當(dāng)月
$detailErrorArray_mouth = SeasLog::analyzerDetail(SEASLOG_ERROR,date('Ym',time()));
*/
使用SeasLog進(jìn)行健康預(yù)警
預(yù)警的配置
[base]
wait_analyz_log_path = /log/base_test
[fork]
;是否開啟多線程 1開啟 0關(guān)閉
fork_open = 1
;線程個(gè)數(shù)
fork_count = 3
[warning]
email[smtp_host] = smtp.163.com
email[smtp_port] = 25
email[subject_pre] = 預(yù)警郵件 -
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[module] = test/bb
test1[level] = SEASLOG_ERROR
test1[bar] = 1
test1[mail_to] = gaochitao@weiboyi.com
test2[module] = 222
test2[level] = SEASLOG_WARNING
test3[module] = 333
test3[level] = SEASLOG_CRITICAL
test4[module] = 444
test4[level] = SEASLOG_EMERGENCY
test5[module] = 555
test5[level] = SEASLOG_DEBUG
crontab配置
;每天凌晨3點(diǎn)執(zhí)行
0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php