这篇主要是介绍和使用安装请参考我另一篇 docker php容器中添加seaslog拓展

简介

使用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()));

高性能的PHP日志系统 SeasLog 使用

简介

使用SeasLog好处

SeasLog配置说明 seaslog.ini

自定义日志模板

自定义日志模版变量表

SeasLog使用

猜你喜欢