Seaslog使用

SeasLog是一个轻量,高效,便捷,规范的PHP日志扩展,精准的定位、精巧的设计,使它成为一个非常优秀的日志工具。

SeasLog地址：

PECL: http://pecl.php.net/package/SeasLog

Github: https://github.com/SeasX/SeasLog

国内镜像：https://gitee.com/neeke/SeasLog

SeasLogger(composer包项目)地址：

Github: https://github.com/SeasX/seas-logger

国内镜像：https://gitee.com/neeke/seas-logger

composer包地址：https://packagist.org/packages/seasx/seas-logger

为什么使用SeasLog

log日志，通常是系统或软件、应用的运行记录。通过log的分析，可以方便用户了解系统或软件、应用的运行情况；如果你的应用log足够丰富，也可以分析以往用户的操作行为、类型喜好、地域分布或其他更多信息；如果一个应用的log同时也分了多个级别，那么可以很轻易地分析得到该应用的健康状况，及时发现问题并快速定位、解决问题，补救损失。

php内置error_log、syslog函数功能强大且性能极好，但由于各种缺陷(error_log无错误级别、无固定格式，syslog不分模块、与系统日志混合)，灵活度降低了很多，不能满足应用需求。

好消息是，有不少第三方的log类库弥补了上述缺陷，如log4php、plog、Analog等(当然也有很多应用在项目中自己开发的log类)。其中以log4php最为著名，设计精良、格式完美、文档完善、功能强大。推荐。

不过log4php在性能方面表现非常差,下图是SeasLog与log4php的ab并发性能测试( 测试环境:Ubuntu12.04单机,CPU I3,内存 16G,硬盘 SATA 7200): 

那么有没有一种log类库满足以下需求呢：

  • 分模块、分级别

  • 配置简单(最好是勿须配置)

  • 日志格式清晰易读

  • 应用简单、性能很棒

    SeasLog 正是应此需求而生。

目前提供了什么

  • 在PHP项目中便捷、规范地记录log

  • 可配置的默认log目录与模块

  • 指定log目录与获取当前配置

  • 初步的分析预警框架

  • 高效的日志缓冲、便捷的缓冲debug

  • 遵循 PSR-3 日志接口规范

  • 连接TCP端口，以RFC5424格式发送日志

  • 连接UDP端口，以RFC5424格式发送日志

  • 支持RequestId区分请求

  • 支持日志模板自定义

  • 自动记录错误和异常日志

  • 支持自动记录性能日志（慢方法、支持层级和执行时间阈值）

SeasLog的性能究竟怎么样？

当SeasLog不开启buffer时，SeasLog是：

  • syslog()函数的8.6倍

  • file_put_contents()函数的240倍

  • fwrite()单例情况下的36倍

  • fwrite()非单例情况下的211倍

  • monolog不开启buffer时的41倍

当SeasLog开启buffer且buffer_size为100时，SeasLog是：

  • syslog()函数的250倍

  • file_put_contents()函数的6962倍

  • fwrite()单例情况下的1052倍

  • fwrite()非单例情况下的6127倍

  • monolog开启buffer且buffer size为100时的118倍

测试脚本参考：https://github.com/SeasX/SeasLog/blob/bug_fix/tests/bench_mark.php

目标是怎样的

  • 便捷、规范的log记录

  • 高效的海量log分析

  • 可配置、多途径的log预警

安装

编译安装 SeasLog



PECL安装SeasLog




Windows环境中使用SeasLog


到PECL/SeasLog主页找到对应的dll进行安装 PECL/SeasLog Windows Dll


seaslog.ini的配置






seaslog.disting_folder = 1 开启以目录分文件，即logger以目录区分。当关闭时，logger以下划线拼接时间, 如default_20180211.log。






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.buffer_disabled_in_cli = 1 开启CLI运行时禁用缓存。默认关闭。当开启此项时，CLI运行时将忽略seaslog.use_buffer设定，日志写入文件。






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自身的警告。当出现目录权限或接收服务器端口不通等情况时，将进行忽略；关闭时，将抛出警告。






seaslog.trace_performance = 1 开启性能追踪功能。性能日志如:






自定义日志模板


很多朋友在使用过程中提到自定义日志模板的需求，于是SeasLog自1.7.2版本开始，拥有了这个能力，允许用户自定义日志的模板， 同时在模板中可以使用SeasLog预置的诸多预设变量，参照预设变量表。


日志模板说明


    

  • 

    模板默认为：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}
    

    • 



预设变量表


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。
    

    • 

  • 

    %U - MemoryUsage 当前内容使用量，单位byte。调用zend_memory_usage。
    

    • 

  • 

    %u - PeakMemoryUsage 当前内容使用峰值量，单位byte。调用zend_memory_peak_usage。
    

    • 

  • 

    %C - Class::Action 类名::方法名，如UserService::getUserInfo。不在类中使用时，记录函数名
    

    • 



使用


常量与函数


常量列表


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" - 系统不可用
    

    • 





函数列表


SeasLog 提供了这样一组函数，可以方便地获取与设置根目录、模块目录、快速写入与统计log。 相信从下述伪代码的注释中，您可以快速获取函数信息，具体使用将紧接其后：




PHP Re 结果


SeasLog_PHP_Re_Result


SeasLog Logger的使用


获取与设置basePath






直接使用 SeasLog::getBasePath()，将获取php.ini(seaslog.ini)中设置的 seaslog.default_basepath 的值。






使用 SeasLog::setBasePath() 函数，将改变 SeasLog::getBasePath() 的取值。




设置logger与获取lastLogger






与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 / 20140218.INFO.log
    

    • 

  • 

    warnLogFile = basePath / logger / 20140218.WARNING.log
    

    • 

  • 

    erroLogFile = basePath / logger / 20140218.ERROR.log
    

    • 



用于记录日志的函数原型有两个：


    

  • 

    SeasLog::log($level, $messages[, $context, $logger])
    

    • 

  • 

    SeasLog::$level($messages[, $context, $logger])
    

    • 





$level - 参见上文所列的8个级别






$messages - 可以使用string或array两种类型, array仅接受一维数组






$context - 仅接受一维数组，用于替换$messages中log的占位符






$logger - 可以临时为当前操作指定一个logger，而不改变getLastLogger方法的取值








log格式受seaslog.default_template影响。 seaslog.default_template默认模板为 seaslog.default_template = "%T | %L | %P | %Q | %t | %M" 那么在默认情况下，日志格式为： {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo} 关于自定义模板，及SeasLog中的预置值，可参阅 自定义日志模板






使用TCP或UDP发送时的数据格式


当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影响。






手动清除LoggerStream缓存


SeasLog会将日志Logger开启的Stream句柄进行缓存，以节省创建流时引起的开销。句柄将在请求结束时自动释放。 如果在CLI模式下，进程退出时也会自动释放。或者你可以使用下面的函数进行手动释放(手动释放函数需要更新SeasLog 1.8.6或更新版本)。




手动关闭所有的Logger Stream句柄：








手动关闭指定的Logger Stream句柄：






SeasLog Analyzer的使用


快速统计某类型log的count值


SeasLog在扩展中使用管道调用shell命令 grep -wc快速地取得count值，并返回值(array || int)给PHP。




获取某类型log列表


SeasLog在扩展中使用管道调用shell命令 grep -w快速地取得列表，并返回array给PHP。




使用SeasLog进行健康预警


预警的配置




crontab配置






            

            
posted @ 
2019-05-22 19:55 
sea24 
阅读(377) 
评论(0) 
编辑 
收藏 
举报