gamernetwork/yolk-log

Gamer Network's PHP logging component

Yolk Logger

, _(*1)

A simple PSR-3 logging library. Currently supports output to the standard PHP error log, files, stdout, stderr and syslog., _(*2)

Requirements

This library requires PHP 5.4 or later, the Yolk Contracts package (gamernetwork/yolk-contracts) and the PSR-3 reference logger (psr/log)., _(*3)

Installation

It is installable and autoloadable via Composer as gamer-network/yolk-logger., _(*4)

Alternatively, download a release or clone this repository, and add the \yolk\log and \Psr\Log namespaces to an autoloader., _(*5)

License

Yolk Logger is open-sourced software licensed under the MIT license, _(*6)

Quick Start

use yolk\log\LogLevel;

// create a factory
$f = new LoggerFactory();

// create some simple logs with default threshold (INFO)
$l = $f->create('php');
$l = $f->create('stderr');
$l = $f->create('stdout');
$l = $f->create('null');

// specify configuration options
$l = $f->create([
    'type' => 'file'
    'file' => '/var/log/php/myapp.log'
]);

$l = $f->create([
    'type'   => 'syslog'
    'prefix' => 'myapp'
]);

// specify a threshold
$l = $f->create([
    'type'      => 'stderr',
    'threshold' => LogLevel::INFO,
]);

// simple message
$l->warning('Ooops! Something went wrong');

// message with context
$l->info(
    "{user} logged in at {time}",
    [
        'user' => 'Gary',
        'time' => '2014-10-02 12:34:56',
    ]
);

Using as part of yolk Services

In your config file, put something like this:, _(*7)

$config['logs'] = array(
    // log using error_log for cli-server
    'log' => array( 'type' => 'syslog', 'threshold' => yolk\log\LogLevel::WARN ),
    'audit' => array( 'type' => 'file', 'file' => '/var/log/audit.log', 'threshold' => yolk\log\LogLevel::INFO )
);

...and use with:, _(*8)

$this->services["log.log"]->debug( "Dispatching for: '" . $request->uri() . "'");
$this->services["log.audit"]->info( "So and so did something or other");

If you're working with php cli-server, STDOUT and STDERR not available, but try this:, _(*9)

$config['logs'] = array(
    // log using error_log for cli-server
    'log' => array( 'type' => 'php', 'threshold' => yolk\log\LogLevel::DEBUG )
);