PHP日誌擴充套件SeasLog - 高效輕量

neeke發表於2014-10-23

PECL專案主頁: http://pecl.php.net/package/SeasLog
Github專案主頁: http://neeke.github.io/SeasLog
（作者在極思維的採訪稿：高馳濤—裸奔到北京的序猿）

為什麼使用SeasLog
log日誌，通常是系統或軟體、應用的執行記錄。通過log的分析，可以方便使用者瞭解系統或軟體、應用的執行情況；如果你的應用log足夠豐富，也可以分析以往使用者的操作行為、型別喜好、地域分佈或其他更多資訊；如果一個應用的log同時也分了多個級別，那麼可以很輕易地分析得到該應用的健康狀況，及時發現問題並快速定位、解決問題，補救損失。
php內建error_log、syslog函式功能強大且效能極好，但由於各種缺陷(error_log無錯誤級別、無固定格式，syslog不分模組、與系統日誌混合)，靈活度降低了很多，不能滿足應用需求。
好訊息是，有不少第三方的log類庫彌補了上述缺陷，如log4php、plog、Analog等(當然也有很多應用在專案中自己開發的log類)。其中以log4php最為著名，設計精良、格式完美、文件完善、功能強大。推薦。(log4php的效能經測試,實在不敢恭維.)

那麼有沒有一種log類庫滿足以下需求呢：

分模組、分級別
配置簡單(最好是勿須配置)
日誌格式清晰易讀
應用簡單、效能很棒

SeasLog 正是應此需求而生。

目前提供了什麼

在PHP專案中便捷、規範地記錄log
可配置的預設log目錄與模組
指定log目錄與獲取當前配置
初步的分析預警框架
高效的日誌緩衝、便捷的緩衝debug
遵循 PSR-3 日誌介面規範

目標是怎樣的

便捷、規範的log記錄
高效的海量log分析
可配置、多途徑的log預警

編譯安裝 seaslog

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

或

$ 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時，所有日誌均不記錄。

常量與函式
常量列表
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"

var_dump(SEASLOG_DEBUG,SEASLOG_INFO,SEASLOG_NOTICE); 
/* 
string('debug') debug級別 
string('info')  info級別 
string('notice') notice級別 
*/

函式列表
SeasLog 提供了這樣一組函式，可以方便地獲取與設定根目錄、模組目錄、快速寫入與統計log。相信從下述虛擬碼的註釋中，您可以快速獲取函式資訊，具體使用將緊接其後：

<?php
/**
 * @author ciogao@gmail.com
 * Date: 14-1-27 下午4:47
 */

class SeasLog
{
    public function __construct()
    {
        #SeasLog init
    }

    public function __destruct()
    {
        #SeasLog distroy
    }

    /**
     * 設定basePath
     * @param $basePath
     * @return bool
     */
    static public function setBasePath($basePath)
    {
        return TRUE;
    }

    /**
     * 獲取basePath
     * @return string
     */
    static public function getBasePath()
    {
        return 'the base_path';
    }

    /**
     * 設定模組目錄
     * @param $module
     * @return bool
     */
    static public function setLogger($module)
    {
        return TRUE;
    }

    /**
     * 獲取最後一次設定的模組目錄
     * @return string
     */
    static public function getLastLogger()
    {
        return 'the lastLogger';
    }

    /**
     * 統計所有型別（或單個型別）行數
     * @param $level
     * @param string $log_path
     * @return array | long
     */
    static public function analyzerCount($level = 'all',$log_path = '*')
    {
        return array();
    }

    /**
     * 以陣列形式，快速取出某型別log的各行詳情
     * @param $level
     * @param string $log_path
     * @return array
     */
    static public function analyzerDetail($level = SEASLOG_INFO,$log_path = '*')
    {
        return array();
    }

    /**
     * 獲得當前日誌buffer中的內容
     * @return array
     */
    static public function getBuffer()
    {
        return array();
    }

    /**
     * 記錄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 = '')
    {

    }
}

SeasLog Logger的使用
獲取與設定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)中設定的seaslog.default_basepath 的值。
使用 SeasLog::getBasePath() 函式，將改變 seaslog_get_basepath() 的取值。

設定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)中設定的seaslog.default_logger 的值。
使用 SeasLog::setLogger() 函式，將改變 SeasLog::getLastLogger() 的取值。

快速寫入log
上面已經設定過了basePath與logger，於是log記錄的目錄已經產生了，

log記錄目錄 = basePath / logger / {fileName}.log log檔名，以年月日分檔案，
如今天是2014年02月18日期，那麼 {fileName} = 20140218;

還記得 php.ini 中設定的 seaslog.disting_type 嗎？
預設的 seaslog.disting_type = 0，如果今天我使用了 SeasLog ，那麼將產生最終的log檔案：

LogFile = basePath / logger / 20140218.log

如果 seaslog.disting_type = 1，則最終的log檔案將是這樣的三個檔案

infoLogFile = basePath / logger / INFO.20140218.log
warnLogFile = basePath / logger / WARN.20140218.log
erroLogFile = basePath / logger / ERRO.20140218.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'));

/*
這些函式同時也接受第3個引數為logger的設定項
注意，當last_logger == 'default'時等同於:
SeasLog::setLogger('test/new/path');
SeasLog::error('test error 3');
如果已經在前文使用過SeasLog::setLogger()函式，第3個引數的log只在此處臨時使用，不影響下文。
*/

log格式統一為： {type} | {pid} | {timeStamp} |{dateTime} | {logInfo}
error | 23625 | 1406422432.786 | 2014:07:27 08:53:52 | this is a error test by ::log

debug | 23625 | 1406422432.786 | 2014:07:27 08:53:52 | this is a neeke debug
info | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | this is a info log
notice | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | this is a notice log
warning | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | your github.com was down,please rboot it ASAP!
error | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | a error log
critical | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | some thing was critical
emergency | 23625 | 1406422432.787 | 2014:07:27 08:53:52 | Just now, the house next door was completely burnt out! it`s a joke

### SeasLog Analyzer的使用
#### 快速統計某型別log的count值
`SeasLog`在擴充套件中使用管道呼叫shell命令 `grep -wc`快速地取得count值，並返回值(array || int)給PHP。
```php
$countResult_1 = SeasLog::analyzerCount();
$countResult_2 = SeasLog::analyzerCount(SEASLOG_WARNING);
$countResult_3 = SeasLog::analyzerCount(SEASLOG_ERRO,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在擴充套件中使用管道呼叫shell命令 grep -w快速地取得列表，並返回array給PHP。

$detailErrorArray_inAll   = SeasLog::analyzerDetail(SEASLOG_ERRO);
$detailErrorArray_today   = SeasLog::analyzerDetail(SEASLOG_ERRO,date('Ymd',time()));

var_dump($detailErrorArray_inAll,$detailErrorArray_today);

/*
SeasLog::analyzerDetail(SEASLOG_ERRO) == SeasLog::analyzerDetail(SEASLOG_ERRO,'*');
取當前模組下所有level為 SEASLOG_ERRO 的資訊列表:
array(6) {
 [0] =>
  string(66) "ERRO | 8568 | 1393172042.717 | 2014:02:24 00:14:02 | test error 3 "
  [1] =>
  string(66) "ERRO | 8594 | 1393172044.104 | 2014:02:24 00:14:04 | test error 3 "
  [2] =>
  string(66) "ERRO | 8620 | 1393172044.862 | 2014:02:24 00:14:04 | test error 3 "
  [3] =>
  string(66) "ERRO | 8646 | 1393172045.989 | 2014:02:24 00:14:05 | test error 3 "
  [4] =>
  string(66) "ERRO | 8672 | 1393172047.882 | 2014:02:24 00:14:07 | test error 3 "
  [5] =>
  string(66) "ERRO | 8698 | 1393172048.736 | 2014:02:24 00:14:08 | test error 3 "
}

SeasLog::analyzerDetail(SEASLOG_ERRO,date('Ymd',time()));
只取得當前模組下，當前一天內,level為SEASLOG_ERRO 的資訊列表:
array(2) {
  [0] =>
  string(66) "ERRO | 8568 | 1393172042.717 | 2014:02:24 00:14:02 | test error 3 "
  [1] =>
  string(66) "ERRO | 8594 | 1393172044.104 | 2014:02:24 00:14:04 | test error 3 "
}

同理，取當月 
$detailErrorArray_mouth = SeasLog::analyzerDetail(SEASLOG_ERRO,date('Ym',time()));

*/

使用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
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[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點執行 
0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php

來自：php.net

PHP LOG 效能日誌擴充套件預警

評論(9)

PHP擴充套件高效能日誌系統SeasLog簡單上手
2017-09-14
PHP套件
用SeasLog打造PHP高效能日誌元件
2017-01-13
PHP元件
LoggerOne – 高效、簡約、強擴充套件性PHP日誌類庫
2019-02-16
套件PHP
新一代輕量級PHP擴充套件框架 Asf
2018-05-11
PHP套件框架
【記錄】編譯安裝 SeasLog 擴充套件
2019-07-03
編譯套件
[記錄] 編譯安裝 SeasLog 擴充套件
2019-07-03
編譯套件
[擴充套件包]-Laravel檢視日誌
2020-08-19
套件Laravel
使用 Zephir 輕鬆構建 PHP 擴充套件
2019-03-29
PHP套件
輕量ORM-SqlRepoEx （十一）擴充套件
2018-10-17
ORMSQL套件
日誌服務CLIETL-擴充套件UDF
2019-01-19
套件
Flask學習日誌（五） - Flask擴充套件
2017-08-05
Flask套件
PHP 高效能 Excel 擴充套件 1.2.7 釋出
2019-09-09
PHPExcel套件
新增php擴充套件
2021-09-09
PHP套件
php ubuntu 擴充套件
2017-11-13
PHPUbuntu套件
PHP擴充套件開發就是一個自己的PHP擴充套件
2020-11-05
PHP套件
ASP.NET擴充套件庫之Http日誌
2021-04-12
ASP.NET套件HTTP
開發php擴充套件
2021-09-09
PHP套件
PHP 擴充套件安裝
2021-07-29
PHP套件
PHP7擴充套件
2017-11-13
PHP套件
LAMP（php動態擴充套件模組，httpd的rewrite，php錯誤日誌，php.ini配置詳解）
2017-11-22
LAMPPHP套件httpd
php7安裝redis擴充套件和memcache擴充套件
2017-11-27
PHPRedis套件
PHP安裝redis擴充套件
2021-09-09
PHPRedis套件
php amqp擴充套件安裝
2021-05-15
PHPMQ套件
(MAC) PHP擴充套件安裝
2020-09-09
MacPHP套件
Go開發PHP擴充套件
2022-06-19
GoPHP套件
php mysql擴充套件安裝
2021-10-10
PHPMySql套件
php7windowsredis擴充套件
2016-10-22
PHPWindowsRedis套件
PHP 擴充套件 Mongo 與 MongoDB
2017-03-10
PHP套件MongoDB
PHP 擴充套件 Mysql 與 Mysqli
2017-03-23
PHP套件MySql
php 安裝yar擴充套件
2016-12-26
PHP套件
php安裝openssl 擴充套件
2017-10-10
PHP套件
php gmp擴充套件安裝
2017-09-22
PHP套件
PHP opcache擴充套件安裝
2017-05-17
PHPopcache套件
php開啟curl擴充套件
2017-11-26
PHP套件
PHP安裝fastDFS擴充套件
2017-11-09
PHPAST套件
php擴充套件開發初探
2015-02-26
PHP套件
使用 Rust 建立 PHP 擴充套件
2015-04-18
RustPHP套件
php8.2 redis擴充套件
2024-07-03
PHPRedis套件

PHP日誌擴充套件SeasLog - 高效輕量

相關文章