簡介

使用SeasLog好處

log日志，通常是系統或軟件、應用的運行記錄。通過log的分析，可以方便用戶了解系統或軟件、應用的運行情況；如果你的應用log足夠豐富，也可以分析以往用戶的操作行為、類型喜好、地域分布或其他更多信息；如果一個應用的log同時也分了多個級別，那么可以很輕易地分析得到該應用的健康狀況，及時發現問題並快速定位、解決問題，補救損失。
php內置error_log、syslog函數功能強大且性能極好，但由於各種缺陷(error_log無錯誤級別、無固定格式，syslog不分模塊、與系統日志混合)，靈活度降低了很多，不能滿足應用需求。
好消息是，有不少第三方的log類庫彌補了上述缺陷，如log4php、plog、Analog等(當然也有很多應用在項目中自己開發的log類)。其中以log4php最為著名，設計精良、格式完美、文檔完善、功能強大。推薦。
SeasLog具有以下優點
- 分模塊、分級別
- 配置簡單(最好是勿須配置)
- 日志格式清晰易讀
- 應用簡單、性能很棒

SeasLog配置說明 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"

;是否以type分文件 1是 0否(默認)
seaslog.disting_type = 1

;是否每小時划分一個文件 1是 0否(默認)
seaslog.disting_by_hour = 0

;是否啟用buffer 1是 0否(默認)
seaslog.use_buffer = 0

;buffer中緩沖數量 默認0(不使用buffer_size)
seaslog.buffer_size = 100

;記錄日志級別，數字越大，根據級別記的日志越多。
;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

;自動記錄錯誤 默認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

;過濾日志中的回車和換行符 (默認為0)
seaslog.trim_wrap = 0

;是否開啟拋出SeasLog自身異常  1開啟(默認) 0否
seaslog.throw_exception = 1

;是否開啟忽略SeasLog自身warning  1開啟(默認) 0否
seaslog.ignore_warning = 1

注：

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 = 8 記錄的日志級別.默認為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拋出自身的異常。當出現錄權限或接收服務器端口不通等情況時，拋出異常；關閉時不拋出異常。
seaslog.ignore_warning = 1 開啟忽略SeasLog自身的警告。當出現目錄權限或接收服務器端口不通等情況時，將進行忽略；關閉時，將拋出警告。

自定義日志模板

自1.7.2版本開始，擁有了這個能力，允許用戶自定義日志的模板，同時在模板中可以使用預置的諸多預設變量，參照預設變量表。日志模板說明

模板默認為：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}
注意：%L 必須在%M之前，即：日志級別，必須在日志內容之前。

自定義日志模版變量表

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。
%C - TODO Class::Action 類名::方法名，如UserService::getUserInfo。

SeasLog使用

一常量與函數

1、常量列表

SeasLog 共將日志分成8個級別

SEASLOG_DEBUG
　　"DEBUG" - debug信息、細粒度信息事件
SEASLOG_INFO
　　"INFO" - 重要事件、強調應用程序的運行過程
SEASLOG_NOTICE
　　"NOTICE" - 一般重要性事件、執行過程中較INFO級別更為重要的信息
SEASLOG_WARNING
　　"WARNING" - 出現了非錯誤性的異常信息、潛在異常信息、需要關注並且需要修復
SEASLOG_ERROR
　　"ERROR" - 運行時出現的錯誤、不必要立即進行修復、不影響整個邏輯的運行、需要記錄並做檢測
SEASLOG_CRITICAL
　　"CRITICAL" - 緊急情況、需要立刻進行修復、程序組件不可用
SEASLOG_ALERT
　　"ALERT" - 必級立即采取行動的緊急事件、需要立即通知相關人員緊急修復
SEASLOG_EMERGENCY
　　"EMERGENCY" - 系統不可用

2、函數列表

SeasLog 提供了這樣一組函數，可以方便地獲取與設置根目錄、模塊目錄、快速寫入與統計log。相信從下述偽代碼的注釋中，您可以快速獲取函數信息：

<?php
/**
 * @author @php.net
 * Date: 19-1-17 下午1: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
    }

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

    /**
     * 獲取basePath
     *
     * @return string
     */
    static public function getBasePath()
    {
        return 'the base_path';
    }
    
    /**
     * 設置本次請求標識
     * @param string
     * @return bool
     */
    static public function setRequestID($request_id){
        return TRUE;
    }
    /**
     * 獲取本次請求標識
     * @return string
     */
    static public function getRequestID(){
        return uniqid();
    }

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

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

    /**
     * 設置DatetimeFormat配置
     * @param $format
     *
     * @return bool
     */
    static public function setDatetimeFormat($format)
    {
        return TRUE;
    }

    /**
     * 返回當前DatetimeFormat配置格式
     * @return string
     */
    static public function getDatetimeFormat()
    {
        return 'the datetimeFormat';
    }

    /**
     * 統計所有類型（或單個類型）行數
     * @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();
    }

    /**
     * 以數組形式，快速取出某類型log的各行詳情
     *
     * @param        $level
     * @param string $log_path
     * @param null   $key_word
     * @param int    $start
     * @param int    $limit
     * @param        $order 默認為正序 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();
    }

    /**
     * 獲得當前日志buffer中的內容
     *
     * @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 = '')
    {

    }
}

3、函數使用說明

　　（1）SeasLog::getBasePath()，將獲取php.ini(seaslog.ini)中設置的seaslog.default_basepath 的值　

　　$basePath_1 = SeasLog::getBasePath();

　　SeasLog::setBasePath('/log/base_test');
　　$basePath_2 = SeasLog::getBasePath();

　　var_dump($basePath_1,$basePath_2);

　　（2）設置logger與獲取lastLogger

與basePath相類似的，
直接使用 SeasLog::getLastLogger()，將獲取php.ini(seaslog.ini)中設置的seaslog.default_logger的值。
使用 SeasLog::setLogger() 函數，將改變 SeasLog::getLastLogger()的取值。

　　（3）快速寫入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'));

log格式受seaslog.default_template影響。 seaslog.default_template默認模板為 seaslog.default_template = "%T | %L | %P | %Q | %t | %M" 那么在默認情況下，日志格式為： {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo} 關於自定義模板，及SeasLog中的預置值，可參閱自定義日志模板

　　（4）當seaslog.appender配置為 2（TCP）或 3（UDP）時，日志將推送至remote_host:remote_port的TCP或UDP端口　

　　SeasLog發送至遠端時，遵循規范RFC5424
　　log格式統一為：
　　<PRI>1 {timeStampWithRFC3339} {HostName} {loggerName}[{pid}]: {logInfo}
　　上述{logInfo} 受配置 seaslog.default_template影響。

　　（5）SeasLog Analyzer的使用

　　$countResult_1 = SeasLog::analyzerCount();
　　$countResult_2 = SeasLog::analyzerCount(SEASLOG_WARNING);
　　$countResult_3 = SeasLog::analyzerCount(SEASLOG_ERROR,date('Ymd',time()));

　　（6）獲取某類型log列表，SeasLog在擴展中使用管道調用shell命令 grep -w快速地取得列表，並返回array給PHP。

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

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 PHP擴展高性能日志系統SeasLog簡單上手高性能PHP日志插件--Seaslog 【PHP調試篇】PHP高性能日志組件SeasLog php 之日志系統seaslog安裝 php 日志處理工具 SeasLog 的使用 php seaslog的使用 Php擴展--seasLog日志擴展安裝 C++高性能服務器框架——日志系統 C++ 高性能無鎖日志系統 PHP秒殺系統高並發高性能的極致挑戰☆