gamernetwork/yolk-log

Gamer Network's PHP logging component

v1.0 2015-07-24 13:18 UTC

Requires

• php: >=5.4.0
• gamernetwork/yolk-contracts: 1.*
• psr/log: ~1.0

Requires (Dev)

• phpunit/phpunit: 4.*
• sami/sami: 3.*

MIT

• Simon Downes

• logging
• logger
• eurogamer
• gamer network

README

Want to work for Gamer Network? We are hiring!

Yolk Logger

A simple PSR-3 logging library with support for the following outputs:

• PHP error log
• Files
• Null
• Stdout (CLI only)
• Stderr (CLI only)
• Syslog

Requirements

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

Installation

It is installable and autoloadable via Composer as gamer-network/yolk-logger.

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

License

Yolk Logger is open-sourced software licensed under the MIT license.

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',
	]
);