SeasLog

An effective,fast,stable log extension for PHP

@author Chitao.Gao [neeke@php.net]

@交流群 312910117

PHP手册

English Document

日志规范

日志收集

---

• 简介
  • 为什么使用SeasLog
  • 目前提供了什么
  • 目标是怎样的
• 安装
  • 编译安装 SeasLog
  • seaslog.ini的配置
  • 自定义日志模板
    • 日志模板说明
    • 预设变量表
• 使用
  • 常量与函数
    • 常量列表
    • 函数列表
  • PHP Re 结果
  • SeasLog Logger的使用
    • 获取与设置basePath
    • 设置logger与获取lastLogger
    • 快速写入log
    • 使用TCP或UDP发送时的数据格式
    • 手动清除LoggerStream缓存
  • SeasLog Analyzer的使用
    • 快速统计某类型log的count值
    • 获取某类型log列表
  • 使用SeasLog进行健康预警
    • 预警的配置
    • crontab配置
  • 目前已知使用SeasLog的企业
    • 企业名单
    • 接受捐赠

---

简介

为什么使用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区分请求
• 支持日志模板自定义

目标是怎样的

• 便捷、规范的log记录
• 高效的海量log分析
• 可配置、多途径的log预警

安装

编译安装 SeasLog

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

PECL安装SeasLog

$ pecl install seaslog

Windows环境中使用SeasLog

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

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"

;是否以目录区分Logger 1是(默认) 0否
seaslog.disting_folder = 1

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

;是否每小时划分一个文件 1是 0否(默认)
seaslog.disting_by_hour = 0

;是否启用buffer 1是 0否(默认)
seaslog.use_buffer = 0

;buffer中缓冲数量 默认0(不使用buffer_size)
seaslog.buffer_size = 100

;cli运行时关闭buffer
;1是 0否(默认)
seaslog.buffer_disabled_in_cli = 0

;记录日志级别，数字越大，根据级别记的日志越多。
;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

;自动记录notice 默认0(关闭)
seaslog.trace_notice = 0

;自动记录warning 默认0(关闭)
seaslog.trace_warning = 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

;接收端口的超时时间 默认1秒
seaslog.remote_timeout = 1

;过滤日志中的回车和换行符 (默认为0)
seaslog.trim_wrap = 0

;是否开启抛出SeasLog自身异常  1开启(默认) 0关闭
seaslog.throw_exception = 1

;是否开启忽略SeasLog自身warning  1开启(默认) 0关闭
seaslog.ignore_warning = 1

;是否开启性能追踪 1开启 0关闭(默认)
seaslog.trace_performance = 0

;性能追踪时的千分比采样率
;默认10，即百分之一
seaslog.trace_performance_sample_rate = 10

;性能追踪时的开始层级 默认从第1层开始
seaslog.trace_performance_start_depth = 1

;性能追踪时深度层级 默认5层
seaslog.trace_performance_max_depth = 5

;性能追踪时每层的函数最大数 按wall_time降序排列top 默认top5
seaslog.trace_performance_max_functions_per_depth = 5

;性能追踪时当前请求执行时间的记录阈值 只有当请求执行时间大于该值时，才记录性能日志 默认1000ms
seaslog.trace_performance_min_wall_time = 1000

;性能追踪时每个方法执行时间的记录阈值 只有当方法执行时间大于该值时，才参与计算 默认10ms
seaslog.trace_performance_min_function_wall_time = 10

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 开启性能追踪功能。性能日志如:

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 (方法调用计数)

自定义日志模板

很多朋友在使用过程中提到自定义日志模板的需求，于是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。不在类中使用时，记录函数名。 * %B - BasePath路径,如/var/log/www。受seaslog.default_basepath和setBasePath影响。

使用

常量与函数

常量列表

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

var_dump(SEASLOG_DEBUG,SEASLOG_INFO,SEASLOG_NOTICE);
/*
string('DEBUG') debug级别
string('INFO')  info级别
string('NOTICE') notice级别
*/

函数列表

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