SeasLog PHP Extension

SeasLog is an effective, fast, and stable logging extension for PHP. It is designed to provide a high-performance alternative to libraries like log4php while addressing the limitations of PHP's built-in error_log and syslog functions.

Key Features:

• Standardized Logging: Follows the PSR-3 logger interface specification.
• High Performance: Optimized for high-concurrency environments.
• Automated Error/Exception Tracking: Automatically records error and exception information.
• Flexible Output: Supports configurable log directories and modules, and can send logs via TCP or UDP in RFC5424 format.
• Request Tracking: Supports RequestId to distinguish between different requests.
• Customization: Supports custom log templates and provides a framework for log analysis and alerting.

You can customize the log output format using the seaslog.default_template setting in seaslog.ini. The default template is %T | %L | %P | %Q | %t | %M.

Available Template Variables

Example

To change the format to [DateTime]:Level PID RequestId Timestamp Message, use:

seaslog.default_template = "[%T]:%L %P %Q %t %M"

SeasLog can trace execution performance, recording wall time (wt), memory usage (mu), and call counts (ct) for functions and methods.

Configuration

• seaslog.trace_performance: (1=On, 0=Off) Enables tracing.
• seaslog.trace_performance_sample_rate: Samples per thousand (Default: 10).
• seaslog.trace_performance_min_wall_time: Minimum request execution time (ms) to trigger a trace (Default: 1000).
• seaslog.trace_performance_min_function_wall_time: Minimum method execution time (ms) to include in trace (Default: 10).

Example Trace Output

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}, ... ]}

In the JSON payload:

• cm: function_name (ClassName::MethodName)
• wt: wall_time (ms)
• mu: memory_usage (bytes)
• ct: call_times

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":2566}]}

You can define a custom log format using seaslog.default_template. The template uses specific placeholders (prefixed with %) that are replaced at runtime.

Default Template: %T | %L | %P | %Q | %t | %M (Format: {dateTime} | {level} | {pid} | {uniqid} | {timeStamp} | {logInfo})

Available Variables

Note: If you haven't called SeasLog::setRequestId($string), %Q uses an internally generated unique ID.

seaslog.default_template = "[%T]:%L %P %Q %t %M"

SeasLog can monitor logs and send email alerts when certain thresholds are met. This is configured in seaslog.ini and executed via a cron job.

Configuration Steps

1. Define SMTP Settings: Configure the [warning] section with your SMTP host, port, user, and password.
2. Define Monitoring Rules: Create rules in the [analyz] section. Each rule (e.g., test1) requires:
   • module: The module to monitor.
   • level: The log level to watch (e.g., SEASLOG_ERROR).
   • bar: The threshold (number of occurrences) that triggers the alert.
   • mail_to: The recipient email(s).
3. Setup Cron Job: Run the SeasLogAnalyzer.php script via crontab to perform the check.

Example seaslog.ini snippet

[warning]
email[smtp_host] = smtp.163.com
email[smtp_user] = seaslogdemo@163.com
email[smtp_pwd] = seaslog#demo
email[mail_to] = gaochitao@weiboyi.com

[analyz]
; If 'test' module has > 3 ERROR logs, email neeke@php.net
test1[module] = test
test1[level] = SEASLOG_ERROR
test1[bar] = 3
test1[mail_to] = neeke@php.net

Crontab Command

# Run every day at 3:00 AM
0 3 * * * /path/to/php /path/to/SeasLog/Analyzer/SeasLogAnalyzer.php