microparts/logs-php

This package is abandoned and no longer maintained. No replacement package was suggested.

Simple pre-configured Monolog wrapper. Without fucking brackets.

1.0.3 2019-05-17 15:42 UTC

This package is auto-updated.

Last update: 2020-07-05 18:02:49 UTC


README

CircleCI codecov

THIS PACKAGE PERMANENTLY MOVED TO: https://github.com/spacetab-io/logger-php

I create this library with one target, — I'm sick of always copies and paste same code to any of my microservices with logs.

This wrapper solves one problem with logs. And it name, — fucking brackets -> [] [] [] [].

Example, how this wrapper present the logs:

[2019-04-29 21:39:52] Server.INFO: CONFIG_PATH = ./configuration  
[2019-04-29 21:39:52] Server.INFO: STAGE = local  
[2019-04-29 21:39:52] Server.INFO: Configuration module loaded  
[2019-04-29 21:39:52] Server.INFO: HTTP static server started at 0.0.0.0:8080  
 

This is a normal view and without fucking brackets of Monolog's. Okay, I'm hate it too, how it use?

Usage

  1. Install library through composer:
composer require microparts/logs-php
  1. Basic example for most cases will do like as:
use Microparts\Logger\Logger;

$log = Logger::default(); // Psr\Log\LoggerInterface
$log->info('write something');
  1. If you want register this library thought Service Provider (add to application DI container), see this example:
// this code uses Igni framework with Laravel DI container.
use Igni\Application\Providers\ServiceProvider;
use Monolog\Logger;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerInterface;

class LoggerModule implements ServiceProvider
{
    /**
     * @param \Illuminate\Container\Container|ContainerInterface $container
     */
    public function provideServices($container): void
    {
        $container->singleton(LoggerInterface::class, function () {
            return Logger::default(); // it's all!
        });
    }
}
  1. How to register logger without static:: method? It also very simple.
use Microparts\Logger\Logger;
use Psr\Log\LogLevel;

$log = new Logger('Haku', LogLevel::DEBUG); // enabled debug mode and set the channel name
$log->addErrorLogHandler();
$log->register();

$log->getMonolog()->info('Let\'s fly!');
  1. Okay. It's cool. But I have write logs to multiple streams. How I do it?
use Microparts\Logger\Logger;
use Monolog\Handler\HandlerInterface;
use Monolog\Handler\NullHandler;
use Psr\Log\LogLevel;

$log = new Logger('Sen', LogLevel::DEBUG); // enabled debug mode and set the channel name
$log->addErrorLogHandler();
$log->addHandler(function (string $level): HandlerInterface {
    return new NullHandler($level);
});

$log->register();

$log->getMonolog()->info('Diligence is the mother of success');

Simple? Yes. And without fucking brackets.

Tests

  • Coverage 100%. I'm say truth. Maybe.
  • vendor/bin/phpunit

License

The MIT License

Copyright © 2019 teamc.io, Inc. https://teamc.io

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.