phossa/phossa-logger

The PSR-3 compliant PHP logging library.

phossa-logger [ABANDONED]

, _(*1)

See new lib at phoole/logger, _(*2)

Introduction

Phossa-logger is a PSR-3 compliant logging library. It is a rewrite of Monolog with lots of changes., _(*3)

More information about PSR-3, _(*4)

Installation

Install via the composer utility., _(*5)

composer require "phossa/phossa-logger=1.*"

or add the following lines to your composer.json, _(*6)

{
    "require": {
       "phossa/phossa-logger": "^1.0.5"
    }
}

Usage

• Simple usage, _(*7)

  // logger with id 'mylogger'
  $logger = new \Phossa\Logger\Logger('mylogger');
  
  // a notice
  $logger->notice('a notice from code');
  
  // a warning
  $logger->warning('a warning from code');
  

Features

• Decorator: used to modify the $logEntry in some way., _(*8)

  • Implements the __invoke() method, makes decorator a callable

  class InterpolateDecorator extends DecoratorAbstract
  {
      public function __invoke(LogEntryInterface $log)
      {
          // ...
      }
  }
  

  • User-defined functions can also be used as decorator

  $logger->setDecorators([
      new Decorator/InterpolateDecorator(),
      function ($logEntry) {
          // ...
      }
  ]);
  

  • Decorator implements DecoratorInterface can be disabled at runtime

  $inter = new Decorator/InterpolateDecorator();
  $logger->addDecorator($inter);
  // ...
  
  // disble the InterpolateDecorator at runtime
  $inter->stopDecorator();
  

• Handler: distribute log entry to different devices. Multiple handlers can be set at the same time., _(*9)

  // create a logger with channel 'MyLogger'
  $logger  = new Logger('MyLogger');
  
  // syslog handler with ident set to 'MyLogger'
  $syslog  = new Handler\SyslogerHandler($logger->getChannel());
  
  // console handler with output to stderr
  $console = new Handler\TerminalHandler();
  
  // add handlers
  $logger->addHandler($syslog);
  $logger->addHandler($console);
  
  // ...
  // at some point, stop console logging
  $console->stopHandler();
  

• Formatter: turn log entry object into string. A formatter is bound to a specific handler., _(*10)

  // console handler with output to stderr
  $console = new Handler\TerminalHandler();
  
  // set AnsiFormatter
  $console->setFormatter(new Formatter\AnsiFormatter());
  

• Handler/Decorator/Formatter all enforce '__invoke()' in the their interface, which makes them callable., _(*11)

• User may use all sorts of callable as handler, decorator or formatter., _(*12)

  // handler
  $syslog = new SyslogHandler();
  
  // set a anonymous function as a formatter
  $syslog->setFormatter(
    function ($log) {
        // ...
        return $string;
    }
  );
  
  // adding different handlers
  $logger->setHandlers([
    $syslog,
    function ($log) {
        // convert $log to string and send to a log device
        // ...
    }
  ]);
  

• LogEntryInterface for log entry (or call it message). It is now possible to extend LogEntry and use a factory closure to create log entry., _(*13)

  $logger = new Logger('MyLogger', [], [],
    function ($level, $message, $context) {
        return new MyLogEntry($level, $message, $context);
    }
  );
  

• Support PHP 5.4+, PHP 7.0+, HHVM, _(*14)

• PHP7 ready for return type declarations and argument type declarations., _(*15)

• PSR-1, PSR-2, PSR-3, PSR-4 compliant., _(*16)

Dependencies

• PHP >= 5.4.0
• phossa/phossa-shared >= 1.0.3
• psr/log

License

MIT License, _(*17)