README

flytachi/winter-logger — multi-runtime PSR-3 logger for the Winter framework. Wraps Monolog with coroutine-safe context isolation, Spring Boot-style output, and a Java-style static factory.

The library is infrastructure-agnostic: it knows nothing about env vars, Docker, SAPI, or Swoole detection — that responsibility belongs to the framework that boots it.

Requirements

• PHP >= 8.3
• psr/log ^3.0
• monolog/monolog ^3.5 (suggested — without it every logger silently becomes NullLogger)
• ext-swoole (optional — required only for CoroutineContext)

Installation

composer require flytachi/winter-logger monolog/monolog

Monolog-free (every logger will be a no-op NullLogger):

composer require flytachi/winter-logger

Quick Start

1. Build a LoggerManager

The manager accepts a ready-made config — the framework resolves env vars and infrastructure details before calling this:

use Monolog\Level;
use Flytachi\Winter\Logger\LoggerManager;
use Flytachi\Winter\Logger\Context\ProcessContext;   // FPM / CLI
// use Flytachi\Winter\Logger\Context\CoroutineContext; // Swoole

$manager = new LoggerManager(
    contextStorage: new ProcessContext(),
    channels: [
        'http' => [
            'level'        => Level::Info,
            'format'       => 'line',       // 'line' | 'json'
            'output'       => 'stderr',     // 'stdout' | 'stderr' | 'syslog' | 'file' | 'null'
            'file_path'    => null,
            'file_max'     => 30,
            'syslog_ident' => 'winter',
        ],
        'cli' => [
            'level'        => Level::Debug,
            'format'       => 'line',
            'output'       => 'stdout',
            'file_path'    => null,
            'file_max'     => 30,
            'syslog_ident' => 'winter',
        ],
    ],
);

2. Register with LoggerFactory

use Flytachi\Winter\Logger\LoggerFactory;

LoggerFactory::setManager($manager);

3. Log from anywhere

use Flytachi\Winter\Logger\LoggerFactory;

// Per-class logger — Java-style:
LoggerFactory::getLogger(UserService::class, 'http')->info('user created', ['id' => 42]);
LoggerFactory::getLogger($this, 'cli')->debug('job started');

// Raw channel:
LoggerFactory::channel('http')->warning('rate limit hit');

// Bound context — fields appear in every subsequent call:
$log = LoggerFactory::getLogger(self::class, 'http')->withContext(['request_id' => $id]);
$log->info('processing');
$log->info('done');

Output (line format)

[2024-01-01 12:00:00] [INFO ] -http- [4821] (UserService): user created {"id":42,"class":"App\\Service\\UserService"}
[2024-01-01 12:00:00] [WARN ] -http- [4821]: rate limit hit

Request-scoped context

Set fields once at the start of a request/job and they appear in every log line automatically via ContextInjectingProcessor:

// At request start (FPM middleware / Swoole onRequest):
$manager->contextStorage()->set('request_id', $requestId);
$manager->contextStorage()->set('user_id',    $userId);

// At request end — must clear in long-running processes to prevent leaks:
$manager->contextStorage()->clear();

For Swoole use CoroutineContext — it isolates context per coroutine so concurrent requests never bleed into each other.

Channel config reference

Processors

ContextInjectingProcessor is added to every channel automatically — no config needed.

SensitiveMaskingProcessor is optional. Add it after building the manager:

use Flytachi\Winter\Logger\Processor\SensitiveMaskingProcessor;

$monolog = $manager->channel('http')->monolog();
$monolog->pushProcessor(new SensitiveMaskingProcessor(['my_secret']));

Default masked keys: password, token, secret, api_key, authorization, cookie, credit_card, cvv, ssn, pin, and more.

Documentation

License

MIT License. See LICENSE.