README

Preface

This helper should be used for all workcells, all log generated will be sent to the Newrelic (if enabled and configured) and also to file system formatted with LogstashFormatter.

Instalation

The package is available on Packagist. Autoloading is PSR-4 compatible.

{
    "require": {
        "dafiti/logging-helper": "0.0.4"
    }
}

The minimal log level default is \Monolog\Logger::ERROR, when the third parameter has been omitted, this will be the minimum log level of logger instance All messages sent with a less log level (example: \Monolog\Logger::DEBUG) will not be logged because the minimum log level is greater

Usage

Basic

logging message

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->log(<log level>, '<log message>');

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"<log level>"}

Logging message and more values

You can send an array of key value pair:

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->log(<log level>, '<log message>', [<key-value-pair>]);

Example:

$values = ['string' => 'value', 'int' => 10, 'float' => 10.0, 'bool' => true, 'resource' => null, 'object' => (new stdClass()), 'sub-array' => range('A', 'D')];
$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->log(<log level>, '<log message>', $values);

outputs

{"@timestamp":"2015-09-16T14:51:42.636524-03:00","@version":1,"host":"7dd53b17bdec","message":"<log message>","type":"<log name>","channel":"<log name>","level":"<log level>","string":"value","int":10,"float":10,"bool":true,"resource":null,"object":"[object] (stdClass: {})","sub-array":["A","B","C","D","E"]}

Alternative

In alternative to log method you can use the add methods:

Debug

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->debug('<log message>', [<key-value-pair>]);
// or
$logger->addDebug('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"DEBUG"}

Info

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->info('<log message>', [<key-value-pair>]);
// or
$logger->addInfo('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"INFO"}

Notice

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->notice('<log message>', [<key-value-pair>]);
// or
$logger->addNotice('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"NOTICE"}

Warning or warning

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->warning('<log message>', [<key-value-pair>]);
// or
$logger->addWarning('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"WARNING"}

Error

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->error('<log message>', [<key-value-pair>]);
// or
$logger->addError('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"ERROR"}

Critical

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->critical('<log message>', [<key-value-pair>]);
// or
$logger->addCritical('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"CRITICAL"}

Alert

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->alert('<log message>', [<key-value-pair>]);
// or
$logger->addAlert('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"ALERT"}

Emergency

$logger = (new \Dafiti\Log\Factory())->createInstance('<log name>', '<log path/filename>');
$logger->emergency('<log message>', [<key-value-pair>]);
// or
$logger->addEmergency('<log message>', [<key-value-pair>]);

outputs

{"@timestamp":"2015-09-16T13:41:15.626418-03:00","@version":1,"host":"server01","message":"<log message>","type":"<log name>","channel":"<log name>","level":"EMERGENCY"}

<log name> samples:

• alice
• bob
• checkout
• payment
• mobileapi
• braspag
• adyen
• others

<log path/filename>:

Use the default log path

<log level> available:

<log message>:

The message to be logged

License

MIT License