SeasLogPHP 日志擴(kuò)展
SeasLog是一個輕量,高效,便捷,規(guī)范的PHP日志擴(kuò)展,精準(zhǔn)的定位、精巧的設(shè)計,使它成為一個非常優(yōu)秀的日志工具。
SeasLog地址:
PECL: http://pecl.php.net/package/SeasLog
Github: https://github.com/SeasX/SeasLog
國內(nèi)鏡像:https://gitee.com/neeke/SeasLog
SeasLogger(composer包項目)地址:
Github: https://github.com/SeasX/seas-logger
國內(nèi)鏡像:https://gitee.com/neeke/seas-logger
composer包地址:https://packagist.org/packages/seasx/seas-logger
為什么使用SeasLog
log日志,通常是系統(tǒng)或軟件、應(yīng)用的運行記錄。通過log的分析,可以方便用戶了解系統(tǒng)或軟件、應(yīng)用的運行情況;如果你的應(yīng)用log足夠豐富,也可以分析以往用戶的操作行為、類型喜好、地域分布或其他更多信息;如果一個應(yīng)用的log同時也分了多個級別,那么可以很輕易地分析得到該應(yīng)用的健康狀況,及時發(fā)現(xiàn)問題并快速定位、解決問題,補(bǔ)救損失。
php內(nèi)置error_log、syslog函數(shù)功能強(qiáng)大且性能極好,但由于各種缺陷(error_log無錯誤級別、無固定格式,syslog不分模塊、與系統(tǒng)日志混合),靈活度降低了很多,不能滿足應(yīng)用需求。
好消息是,有不少第三方的log類庫彌補(bǔ)了上述缺陷,如log4php、plog、Analog等(當(dāng)然也有很多應(yīng)用在項目中自己開發(fā)的log類)。其中以log4php最為著名,設(shè)計精良、格式完美、文檔完善、功能強(qiáng)大。推薦。
不過log4php在性能方面表現(xiàn)非常差,下圖是SeasLog與log4php的ab并發(fā)性能測試( 測試環(huán)境:Ubuntu12.04單機(jī),CPU I3,內(nèi)存 16G,硬盤 SATA 7200):
那么有沒有一種log類庫滿足以下需求呢:
分模塊、分級別
配置簡單(最好是勿須配置)
日志格式清晰易讀
應(yīng)用簡單、性能很棒
SeasLog 正是應(yīng)此需求而生。
目前提供了什么
在PHP項目中便捷、規(guī)范地記錄log
可配置的默認(rèn)log目錄與模塊
指定log目錄與獲取當(dāng)前配置
初步的分析預(yù)警框架
高效的日志緩沖、便捷的緩沖debug
遵循 PSR-3 日志接口規(guī)范
連接TCP端口,以RFC5424格式發(fā)送日志
連接UDP端口,以RFC5424格式發(fā)送日志
支持RequestId區(qū)分請求
支持日志模板自定義
自動記錄錯誤和異常日志
支持自動記錄性能日志(慢方法、支持層級和執(zhí)行時間閾值)
SeasLog的性能究竟怎么樣?
當(dāng)SeasLog不開啟buffer時,SeasLog是:
syslog()函數(shù)的8.6倍
file_put_contents()函數(shù)的240倍
fwrite()單例情況下的36倍
fwrite()非單例情況下的211倍
monolog不開啟buffer時的41倍
當(dāng)SeasLog開啟buffer且buffer_size為100時,SeasLog是:
syslog()函數(shù)的250倍
file_put_contents()函數(shù)的6962倍
fwrite()單例情況下的1052倍
fwrite()非單例情況下的6127倍
monolog開啟buffer且buffer size為100時的118倍
測試腳本參考:https://github.com/SeasX/SeasLog/blob/bug_fix/tests/bench_mark.php
目標(biāo)是怎樣的
便捷、規(guī)范的log記錄
高效的海量log分析
可配置、多途徑的log預(yù)警
安裝
編譯安裝 SeasLog
$ /path/to/phpize $ ./configure --with-php-config=/path/to/php-config $ make && make install
PECL安裝SeasLog
$ pecl install seaslog
Windows環(huán)境中使用SeasLog
到PECL/SeasLog主頁找到對應(yīng)的dll進(jìn)行安裝 PECL/SeasLog Windows Dll
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" ;是否以目錄區(qū)分Logger 1是(默認(rèn)) 0否 seaslog.disting_folder = 1 ;是否以type分文件 1是 0否(默認(rèn)) seaslog.disting_type = 0 ;是否每小時劃分一個文件 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 ;cli運行時關(guān)閉buffer ;1是 0否(默認(rèn)) seaslog.buffer_disabled_in_cli = 0 ;記錄日志級別,數(shù)字越大,根據(jù)級別記的日志越多。 ;0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL ;默認(rèn)8(所有日志) ; ; 注意, 該配置項自1.7.0版本開始有變動。 ; 在1.7.0版本之前, 該值數(shù)字越小,根據(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)用回溯層級 ;影響預(yù)定義變量 %F 中的行數(shù) ;默認(rèn)0 seaslog.recall_depth = 0 ;自動記錄notice 默認(rèn)0(關(guān)閉) seaslog.trace_notice = 0 ;自動記錄warning 默認(rèn)0(開啟) seaslog.trace_warning = 0 ;自動記錄錯誤 默認(rèn)1(開啟) seaslog.trace_error = 1 ;自動記錄異常信息 默認(rèn)0(關(guān)閉) seaslog.trace_exception = 0 ;日志存儲介質(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時必填) seaslog.remote_host = "127.0.0.1" ;接收端口 默認(rèn)514 (當(dāng)使用TCP或UDP時必填) seaslog.remote_port = 514 ;接收端口的超時時間 默認(rèn)1秒 seaslog.remote_timeout = 1 ;過濾日志中的回車和換行符 (默認(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 ;是否開啟性能追蹤 1開啟 0關(guān)閉(默認(rèn)) seaslog.trace_performance = 0 ;性能追蹤時的千分比采樣率 ;默認(rèn)10,即百分之一 seaslog.trace_performance_sample_rate = 10 ;性能追蹤時的開始層級 默認(rèn)從第1層開始 seaslog.trace_performance_start_depth = 1 ;性能追蹤時深度層級 默認(rèn)5層 seaslog.trace_performance_max_depth = 5 ;性能追蹤時每層的函數(shù)最大數(shù) 按wall_time降序排列top 默認(rèn)top5 seaslog.trace_performance_max_functions_per_depth = 5 ;性能追蹤時當(dāng)前請求執(zhí)行時間的記錄閾值 只有當(dāng)請求執(zhí)行時間大于該值時,才記錄性能日志 默認(rèn)1000ms seaslog.trace_performance_min_wall_time = 1000 ;性能追蹤時每個方法執(zhí)行時間的記錄閾值 只有當(dāng)方法執(zhí)行時間大于該值時,才參與計算 默認(rèn)10ms seaslog.trace_performance_min_function_wall_time = 10
seaslog.disting_folder = 1開啟以目錄分文件,即logger以目錄區(qū)分。當(dāng)關(guān)閉時,logger以下劃線拼接時間, 如default_20180211.log。
seaslog.disting_type = 1開啟以type分文件,即log文件區(qū)分info\warn\erro
seaslog.disting_by_hour = 1開啟每小時劃分一個文件
seaslog.use_buffer = 1開啟buffer。默認(rèn)關(guān)閉。當(dāng)開啟此項時,日志預(yù)存于內(nèi)存,當(dāng)請求結(jié)束時(或異常退出時)一次寫入文件。
seaslog.buffer_size = 100設(shè)置緩沖數(shù)量為100. 默認(rèn)為0,即無緩沖數(shù)量限制.當(dāng)buffer_size大于0時,緩沖量達(dá)到該值則寫一次文件.
seaslog.buffer_disabled_in_cli = 1開啟CLI運行時禁用緩存。默認(rèn)關(guān)閉。當(dāng)開啟此項時,CLI運行時將忽略seaslog.use_buffer設(shè)定,日志寫入文件。
seaslog.level = 8記錄的日志級別.默認(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ù)器端口不通等情況時,拋出異常;關(guān)閉時不拋出異常。
seaslog.ignore_warning = 1開啟忽略SeasLog自身的警告。當(dāng)出現(xiàn)目錄權(quán)限或接收服務(wù)器端口不通等情況時,將進(jìn)行忽略;關(guān)閉時,將拋出警告。
seaslog.trace_performance = 1開啟性能追蹤功能。性能日志如:
2019-01-30 11:46:53 | INFO | 91390 | 5c518ea46e010 | 1548848813.299 | {"main()":{"wt":8848,"mu":20712},"1":[{"cm":"Class0::Method0","ct":2,"wt":2007,"mu":192},{"cm":"Class1::Method1","ct":1,"wt":1002,"mu":192},{"cm":"Class2::Method2","ct":1,"wt":1001,"mu":192},{"cm":"Class3::Method3","ct":1,"wt":1000,"mu":192},{"cm":"Class4::Method4","ct":1,"wt":1000,"mu":192}],"2":[{"cm":"Class5::Method5","ct":1,"wt":1000,"mu":192}],"3":[{"cm":"Class5::Recursion","ct":1,"wt":1000,"mu":3248}],"4":[{"cm":"Class5::Recursion","ct":1,"wt":1000,"mu":2952}],"5":[{"cm":"Class5::Recursion","ct":1,"wt":1000,"mu":2656}]}
cm => function_name (類名::方法名)
wt => wall_time (ms)
mu => memory_usage (byte)
ct => call_times (方法調(diào)用計數(shù))
自定義日志模板
很多朋友在使用過程中提到自定義日志模板的需求,于是SeasLog自1.7.2版本開始,擁有了這個能力,允許用戶自定義日志的模板, 同時在模板中可以使用SeasLog預(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}
預(yù)設(shè)變量表
SeasLog提供了下列預(yù)設(shè)變量,可以直接使用在日志模板中,將在日志最終生成時替換成對應(yīng)值。
%L- Level 日志級別。%M- Message 日志信息。%T- DateTime 如2017-08-16 19:15:02,受seaslog.default_datetime_format影響。%t- Timestamp 如1502882102.862,精確到毫秒數(shù)。%Q- RequestId 區(qū)分單次請求,如沒有調(diào)用SeasLog::setRequestId($string)方法,則在初始化請求時,采用內(nèi)置的static char *get_uniqid()方法生成的惟一值。%H- HostName 主機(jī)名。%P- ProcessId 進(jìn)程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模式下為執(zhí)行命令,如/bin/bash。%I- Client IP 來源客戶端IP; Cli模式下為local。取值優(yōu)先級為:HTTP_X_REAL_IP > HTTP_X_FORWARDED_FOR > REMOTE_ADDR%F- FileName:LineNo 文件名:行號,如UserService.php:118。%U- MemoryUsage 當(dāng)前內(nèi)容使用量,單位byte。調(diào)用zend_memory_usage。%u- PeakMemoryUsage 當(dāng)前內(nèi)容使用峰值量,單位byte。調(diào)用zend_memory_peak_usage。%C- Class::Action 類名::方法名,如UserService::getUserInfo。不在類中使用時,記錄函數(shù)名
使用
常量與函數(shù)
常量列表
SeasLog 共將日志分成8個級別
SEASLOG_DEBUG
"DEBUG" - debug信息、細(xì)粒度信息事件
SEASLOG_INFO
"INFO" - 重要事件、強(qiáng)調(diào)應(yīng)用程序的運行過程
SEASLOG_NOTICE
"NOTICE" - 一般重要性事件、執(zhí)行過程中較INFO級別更為重要的信息
SEASLOG_WARNING
"WARNING" - 出現(xiàn)了非錯誤性的異常信息、潛在異常信息、需要關(guān)注并且需要修復(fù)
SEASLOG_ERROR
"ERROR" - 運行時出現(xiàn)的錯誤、不必要立即進(jìn)行修復(fù)、不影響整個邏輯的運行、需要記錄并做檢測
SEASLOG_CRITICAL
"CRITICAL" - 緊急情況、需要立刻進(jìn)行修復(fù)、程序組件不可用
SEASLOG_ALERT
"ALERT" - 必須立即采取行動的緊急事件、需要立即通知相關(guān)人員緊急修復(fù)
SEASLOG_EMERGENCY
"EMERGENCY" - 系統(tǒng)不可用
var_dump(SEASLOG_DEBUG,SEASLOG_INFO,SEASLOG_NOTICE);
/*
string('DEBUG') debug級別
string('INFO') info級別
string('NOTICE') notice級別
*/
函數(shù)列表
SeasLog 提供了這樣一組函數(shù),可以方便地獲取與設(shè)置根目錄、模塊目錄、快速寫入與統(tǒng)計log。 相信從下述偽代碼的注釋中,您可以快速獲取函數(shù)信息,具體使用將緊接其后:
<?php /** * @author [email protected] * 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); define('SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL', 1); define('SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN', 2); define('SEASLOG_REQUEST_VARIABLE_DOMAIN_PORT', 1); define('SEASLOG_REQUEST_VARIABLE_REQUEST_URI', 2); define('SEASLOG_REQUEST_VARIABLE_REQUEST_METHOD', 3); define('SEASLOG_REQUEST_VARIABLE_CLIENT_IP', 4); 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è)置本次請求標(biāo)識 * * @param string * * @return bool */ static public function setRequestID($request_id) { return true; } /** * 獲取本次請求標(biāo)識 * @return string */ static public function getRequestID() { return uniqid(); } /** * 設(shè)置模塊目錄 * * @param $module * * @return bool */ static public function setLogger($module) { return true; } /** * 手動清除logger的stream流 * * @param $model * @param $logger * * @return bool */ static public function closeLoggerStream($model = SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL, $logger) { 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'; } /** * 設(shè)置請求變量 * * @param $key * @param $value * * @return bool */ static public function setRequestVariable($key, $value) { return true; } /** * 獲取請求變量 * * @param $key * * @return string */ static public function getRequestVariable($key) { return ''; } /** * 統(tǒng)計所有類型(或單個類型)行數(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 * * @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 string|array $message * @param array $context * @param string $module */ static public function debug($message, array $context = array(), $module = '') { #$level = SEASLOG_DEBUG } /** * 記錄info日志 * * @param string|array $message * @param array $context * @param string $module */ static public function info($message, array $context = array(), $module = '') { #$level = SEASLOG_INFO } /** * 記錄notice日志 * * @param string|array $message * @param array $context * @param string $module */ static public function notice($message, array $context = array(), $module = '') { #$level = SEASLOG_NOTICE } /** * 記錄warning日志 * * @param string|array $message * @param array $context * @param string $module */ static public function warning($message, array $context = array(), $module = '') { #$level = SEASLOG_WARNING } /** * 記錄error日志 * * @param string|array $message * @param array $context * @param string $module */ static public function error($message, array $context = array(), $module = '') { #$level = SEASLOG_ERROR } /** * 記錄critical日志 * * @param string|array $message * @param array $context * @param string $module */ static public function critical($message, array $context = array(), $module = '') { #$level = SEASLOG_CRITICAL } /** * 記錄alert日志 * * @param string|array $message * @param array $context * @param string $module */ static public function alert($message, array $context = array(), $module = '') { #$level = SEASLOG_ALERT } /** * 記錄emergency日志 * * @param string|array $message * @param array $context * @param string $module */ static public function emergency($message, array $context = array(), $module = '') { #$level = SEASLOG_EMERGENCY } /** * 通用日志方法 * * @param $level * @param string|array $message * @param array $context * @param string $module */ static public function log($level, $message, array $context = array(), $module = '') { } }
PHP Re 結(jié)果
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文件將是這樣的三個文件
infoLogFile = basePath / logger / 20140218.INFO.log
warnLogFile = basePath / logger / 20140218.WARNING.log
erroLogFile = basePath / logger / 20140218.ERROR.log
用于記錄日志的函數(shù)原型有兩個:
SeasLog::log($level, $messages[, $context, $logger])
SeasLog::$level($messages[, $context, $logger])
$level - 參見上文所列的8個級別
$messages - 可以使用
string或array兩種類型,array僅接受一維數(shù)組
$context - 僅接受一維數(shù)組,用于替換$messages中l(wèi)og的占位符
$logger - 可以臨時為當(dāng)前操作指定一個logger,而不改變getLastLogger方法的取值
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'));
$aMessages = array('test log from array abc {website}','test log from array def {action}');
$aContent = array('website' => 'github.com','action' => 'rboot'));
SeasLog::debug($aMessages,$aContent);
/*
這些函數(shù)同時也接受第3個參數(shù)為logger的設(shè)置項
注意,當(dāng)last_logger == 'default'時等同于:
SeasLog::setLogger('test/new/path');
SeasLog::error('test error 3');
如果已經(jīng)在前文使用過SeasLog::setLogger()函數(shù),第3個參數(shù)的log只在此處臨時使用,不影響下文。
*/
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 2014-07-27 08:53:52 | DEBUG | 23625 | 599159975a9ff | 1406422432.787 | test log from array abc github.com 2014-07-27 08:53:52 | DEBUG | 23625 | 599159975a9ff | 1406422432.787 | test log from array def rboot
使用TCP或UDP發(fā)送時的數(shù)據(jù)格式
當(dāng)seaslog.appender配置為 2(TCP) 或 3(UDP) 時,日志將推送至remote_host:remote_port的TCP或UDP端口
SeasLog發(fā)送至遠(yuǎn)端時,遵循規(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
手動清除LoggerStream緩存
SeasLog會將日志Logger開啟的Stream句柄進(jìn)行緩存,以節(jié)省創(chuàng)建流時引起的開銷。句柄將在請求結(jié)束時自動釋放。 如果在CLI模式下,進(jìn)程退出時也會自動釋放?;蛘吣憧梢允褂孟旅娴暮瘮?shù)進(jìn)行手動釋放(手動釋放函數(shù)需要更新SeasLog 1.8.6或更新版本)。
手動關(guān)閉所有的Logger Stream句柄:
SeasLog::closeLoggerStream(); 或 SeasLog::closeLoggerStream(SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALL);
手動關(guān)閉指定的Logger Stream句柄:
SeasLog::closeLoggerStream(SEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN, 'logger_name');
SeasLog Analyzer的使用
快速統(tǒng)計某類型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 ;線程個數(shù) fork_count = 3 [warning] email[smtp_host] = smtp.163.com email[smtp_port] = 25 ; 是否開啟加密協(xié)議 tsl ssl, 留空為不開啟 email[smtp_secure] = ; 郵件發(fā)送類型 smtp, sendmail, mail ; smtp: PHP實現(xiàn)的smtp協(xié)議 ; sendmail: 需配置php.ini中sendmail_path ; mail: 使用PHP內(nèi)置mail()函數(shù) email[smtp_mailer] = smtp email[subject_pre] = 預(yù)警郵件 - email[smtp_user] = [email protected] email[smtp_pwd] = seaslog#demo email[mail_from] = [email protected] email[mail_to] = [email protected] email[mail_cc] = [email protected] 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" ; 可以實現(xiàn)分別監(jiān)控不同模塊下特定級別的日志發(fā)送給不同的郵箱 ; test1 監(jiān)控任務(wù)表示 ; 統(tǒng)計test模塊SEASLOG_ERROR等級的日志數(shù)量,如果數(shù)量大于3則發(fā)送報警郵件到[email protected] test1[module] = test test1[level] = SEASLOG_ERROR test1[bar] = 3 test1[mail_to] = [email protected] test2[module] = 222 test2[level] = SEASLOG_WARNING test2[mail_to] = [email protected],[email protected] test3[module] = 333 test3[level] = SEASLOG_CRITICAL test4[module] = 444 test4[level] = SEASLOG_EMERGENCY test5[module] = 555 test5[level] = SEASLOG_DEBUG
crontab配置
;每天凌晨3點執(zhí)行 0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php
