ez-php/logging
最新稳定版本:1.11.1
Composer 安装命令:
composer require ez-php/logging
包简介
Logging module for the ez-php framework — structured logging with file, stdout, and null drivers
README 文档
README
Logging module for the ez-php framework — structured logging with pluggable drivers, minimum-level filtering, JSON formatting, request context injection, and automatic exception logging.
Requirements
- PHP 8.5+
- ez-php/framework 0.*
Installation
composer require ez-php/logging
Setup
Register the service provider:
$app->register(\EzPhp\Logging\LogServiceProvider::class);
Configure in config/logging.php:
return [ 'driver' => env('LOG_DRIVER', 'file'), // file | stdout | null | json | stack 'path' => env('LOG_PATH', 'storage/logs'), 'min_level' => env('LOG_MIN_LEVEL', ''), // DEBUG|INFO|WARNING|ERROR|CRITICAL — empty = all 'json_inner'=> env('LOG_JSON_INNER', 'stdout'), // inner driver when driver=json 'stack' => ['file', 'stdout'], // used when driver=stack ];
Usage
use EzPhp\Logging\Log; Log::debug('Cache miss', ['key' => 'users.all']); Log::info('User registered', ['id' => 42]); Log::warning('Rate limit approaching', ['remaining' => 5]); Log::error('Payment failed', ['order' => 'ORD-99']); Log::critical('Database unreachable'); // Generic level dispatch Log::log('info', 'Something happened');
Drivers
| Driver | Description |
|---|---|
file |
Appends to {path}/app-YYYY-MM-DD.log (daily rotation) |
stdout |
debug/info/warning → stdout · error/critical → stderr |
null |
Discards all entries — useful in tests |
json |
Decorator: serialises entries as JSON and forwards to an inner driver |
stack |
Decorator: fans each call out to multiple inner drivers simultaneously |
Wrap any driver with a minimum-level filter by setting LOG_MIN_LEVEL:
LOG_DRIVER=file LOG_MIN_LEVEL=WARNING # drops DEBUG and INFO entries
JSON structured logging
LOG_DRIVER=json LOG_JSON_INNER=stdout
Each entry is written as a single JSON line:
{"timestamp":"2026-03-21T12:00:00+00:00","level":"info","message":"tick.event","context":{"user_id":5}}
Stack driver
Write to multiple destinations simultaneously:
LOG_DRIVER=stack
// config/logging.php return [ 'driver' => 'stack', 'stack' => ['file', 'stdout'], ];
Request context middleware
RequestContextMiddleware injects request_id, ip, method, and path into every log entry produced during a request:
$app->middleware(\EzPhp\Logging\RequestContextMiddleware::class);
The middleware wraps the current logger in a ContextualLogger and restores the original logger in finally.
Exception logging
LogServiceProvider automatically wraps the ExceptionHandler with LoggingExceptionHandler, so all unhandled exceptions are logged at error level (with exception class, code, file, and line) before the response is rendered. No extra configuration needed.
Log format (file/stdout)
[2026-03-15 12:00:00] INFO: User registered {"id":42}
[2026-03-15 12:00:01] ERROR: Payment failed {"order":"ORD-99"}
Classes
| Class | Description |
|---|---|
LoggerInterface |
Contract: log(), debug(), info(), warning(), error(), critical() |
LogLevel |
Backed enum: DEBUG|INFO|WARNING|ERROR|CRITICAL; severity(), isAtLeast() |
FileDriver |
Appends to daily-rotated log files; creates directory on demand |
StdoutDriver |
stdout for debug/info/warning, stderr for error/critical |
NullDriver |
No-op — discards all entries |
JsonDriver |
Decorator: serialises entries as JSON, forwards to inner driver |
StackDriver |
Decorator: fans calls out to a list of inner drivers |
MinLevelDriver |
Decorator: drops entries below a configured minimum severity |
ContextualLogger |
Decorator: merges a fixed context array into every log call |
RequestContextMiddleware |
Injects request_id/ip/method/path context for the duration of a request |
Log |
Static façade backed by a managed LoggerInterface singleton |
LoggingExceptionHandler |
Decorator: logs exceptions at error level, then delegates to inner handler |
LogServiceProvider |
Config-driven driver binding; wraps ExceptionHandler; wires Log façade |
License
MIT — Andreas Uretschnig
统计信息
- 总下载量: 25
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 2
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2026-03-15