Log Laravel Package

Getting Started

Install via Composer: composer require consolidation/log. This package provides a StyledLogger that decorates any PSR-3 logger (e.g., Monolog) with CLI-friendly formatting. Start by instantiating a PSR-3 logger (e.g., Monolog\Logger) and wrapping it:

use Consolidation\Log\StyledLogger;
use Monolog\Logger;
use Monolog\Handler\StreamHandler;

$psr3Logger = new Logger('app', [new StreamHandler('php://stdout', Logger::INFO)]);
$logger = StyledLogger::create($psr3Logger);
$logger->info('Task started');

Use it in Symfony Console commands by injecting $logger and calling standard PSR-3 methods (info(), error(), etc.). Output appears styled (colors, indentation, timestamps) without manual formatting.

Implementation Patterns

• Wrap and delegate: Wrap Monolog or other PSR-3 loggers to inherit robust backends while gaining styled CLI output—no need to replace existing handlers.
• Symfony Console integration: Pass the StyledLogger to commands via DI; use $logger->debug(), $logger->warning(), etc., and it automatically adapts to verbosity (-v, -vv) and decoration settings.
• Context-enhanced messages: Embed structured data in context arrays:

  $logger->info('Processing batch', ['batch_size' => 100, 'user_id' => 42]);
  

  Output will include this metadata in a human-readable format (e.g., Processing batch [batch_size=100, user_id=42]).
• Color control: Check console capabilities before logging:

  if ($output->isDecorated()) {
      $logger->setIsColorized(true);
  }
  

  Avoids garbled output in pipelines or non-TTY environments.

Gotchas and Tips

• No PSR-3 impl shipped: This package only styles logs—it doesn’t provide a logger backend. Ensure monolog/monolog or similar is installed.
• NO_COLOR environment variable: Colors are disabled when NO_COLOR=1 is set (per spec). Test locally and in CI with this variable to avoid inconsistent output.
• Symfony Console verbosity mismatch: StyledLogger respects PSR-3 levels but doesn’t auto-map verbosity flags (e.g., -vvv). Explicitly bump log level in your command:

  $level = $this->input->getOption('verbose') ? Logger::DEBUG : Logger::INFO;
  $psr3Logger->setLevel($level);
  

• Output decoration quirks: In Windows (especially older PHP versions), colors may not render. Use symfony/console’s OutputInterface::isDecorated() to guard styling logic.
• Extensibility via subclassing: Override formatMessage() in a custom logger subclass to prepend module prefixes (e.g., [API]) or inject ANSI codes for custom highlighting.
• Avoid over-decoration: Don’t log massive context objects (e.g., full Doctrine entities)—truncate or select keys to keep CLI output clean and scannable.