pinoy/pinoy

Taggable logger for PHP

Pinoy

Taggable logger for PHP., _(*1)

Features

• Tagging
• Logging backtraces
• Multiple writers

Installation

Pinoy can be insstalled using Composer., _(*2)

{
    "minimum-stability": "dev",
    "require": {
        "pinoy/pinoy": "*"
    }
}

Usage

Basic logging

<?php
// Setting minimum level
$logger = new Pinoy_Logger(Pinoy_Logger::LEVEL_WARN);

// Every logging uses this writer
$logger['**'] = new Pinoy_Writer_TextFileLogger('./logfile');

// Logged with tag "default"
$logger->debug('Error message');
// => 2012-09-02 02:45:24   DEBUG   default Error message /path/to/logging.php:9

Logging with specific tag

<?php
$sql = "SELECT * FROM users";
executeQuery($sql);
$logger->debug('db.sql', $sql);
// => 2012-09-02 02:49:33   DEBUG   db.sql  SELECT * FROM users /path/to/query.php:4

// Below is almost same meaning
$logger['db.sql']->debug($sql);

// All logging below is tagged as "db.sql"
$dbLogger = $logger['db.sql'];
$dbLogger->debug('DESC users');
$dbLogger->debug('SHOW TABLES');

Logging methods

<?php
$logger->debug('Error message');
$logger->info('Error message');
$logger->warn('Error message');
$logger->error('Error message');
$logger->fatal('Error message');

Changing trace to log

<?php
$sql = "SELECT * FROM users";

executeQueryWithMeaninglessLogging($sql);
// => 2012-09-02 02:51:17   DEBUG   db.sql  SELECT * FROM users /path/to/query.php:14

executeQueryWithMeaningfullLogging($sql);
// => 2012-09-02 02:51:17   DEBUG   db.sql  SELECT * FROM users /path/to/query.php:7

function executeQueryWithMeaninglessLogging($sql) {
    global $logger;

    executeQuery($sql);
    $logger->debug('sql.sql', $sql);
}

function executeQueryWithMeaningfullLogging($sql) {
    global $logger;

    executeQuery($sql);
    $logger->debug('sql.sql', $sql, array(
        'trace_pos' => 1, // Relative specification means +1
    ));
}

Specific writer per tag

Writer is selected using Pattern Match.
So the order of pattern/writer specification is important., _(*3)

If you specify writer with ** at first, all of logging uses its writer., _(*4)

<?php
$logger['foo.**'] = new Pinoy_Writer_TextFileLogger('./foo.log');
$logger['bar.*']  = new Pinoy_Writer_TextFileLogger('./bar.log');
$logger['**']     = new Pinoy_Writer_TextFileLogger('./default.log');

$logger->info('foo.bar', 'This message is logged into foo.log');
$logger->info('foo.baz', 'This message is also logged into foo.log');

$logger->info('bar.foo', 'This message is logged into bar.log');
$logger->info('bar.foo.foobar', 'This message is logged into NOT bar.log but default.log');

$logger->info('This message is logged into default.log');
$logger->info('baz', 'This message is also logged into default.log');
$logger->info('baz.foobar', 'This message is also logged into default.log');

Author

Yuya Takeyama, _(*5)