Log Laravel Package

Getting Started

Start by installing the package via Composer (composer require illuminate/log) in a standalone PHP project or when extending Laravel (it's included by default). For new projects, integrate it with a PSR-3 compatible logger (like Monolog) to get started quickly. The simplest use case is logging a message:

use Illuminate\Log\Logger;

$logger = new Logger('app', [new Monolog\Handler\StreamHandler(storage_path('logs/app.log'))]);
$logger->info('Application started');

Check the Laravel logging documentation since this package follows the same interface and patterns used in Laravel apps.

Implementation Patterns

• Singleton logger instance: Hoist the Logger instance in a service container or as a static service for DI-free scenarios.
• Channel-based configuration: Use different handlers per channel (e.g., single, daily, slack) by passing Monolog handlers grouped per channel to the Logger constructor.
• Tap handlers: Implement Tap interfaces to mutate log records before dispatch (e.g., adding metadata, scrubbing secrets).
• Context enrichment: Pass contextual data via the second argument:

  $logger->info('User logged in', ['user_id' => $user->id]);
  

• Custom levels: Although Logger extends Monolog, you can extend Logger and override log() to enforce custom level rules.

Gotchas and Tips

• No out-of-the-box config loader: Unlike Laravel, this subtree split does not include LogManager, so you must manually wire handlers (no config/logging.php equivalent).
• PHP 8.3+ required: Ensure your environment meets the strict requirement—common pitfall when upgrading to Laravel 11 or standalone use.
• Monolog version lock-in: Though it supports PSR-3, some advanced features (e.g., processors, formatters) depend on Monolog 3.x. Avoid mixing Monolog 2.x handlers inadvertently.
• Missing Laravel conveniences: Functions like Log::channel() or Log::stack() won’t be available without the full framework. Implement them yourself or use Laravel’s Log facade in actual Laravel projects instead.
• Testing tip: Mock or replace handlers in tests using Symfony\Component\HttpFoundation\StreamedResponse or in-memory handlers to assert log output.