abryb/console-handler

Monolog console handler with output sections for symfony. Progress bar based on logs.

v0.1.0 2021-01-13 13:08 UTC

Requires

• php: ^7.1 || ^8.0
• symfony/console: ^4.0
• symfony/dependency-injection: ^4.0
• symfony/monolog-bridge: ^4.0
• symfony/monolog-bundle: ^3.0

MIT

• Błażej Rybarkiewicz

README

Installation

Install package

composer require abryb/console-handler

Register service

# config/services.yaml
Abryb\ConsoleHandler\ConsoleHandler:
    decorates: monolog.handler.console
    class: Abryb\ConsoleHandler\ConsoleHandler

Add progress bar based on application logs

<?php

namespace App\Command;


use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Command\Command;
use Abryb\ConsoleHandler\ConsoleHandler;
use Abryb\ConsoleHandler\ConsoleHandlerAwareCommand;
use Abryb\ConsoleHandler\Section\Log\RotateLogSection;
use Abryb\ConsoleHandler\Section\ProgressBar\RegexProgressBarSection;

class MyCommand extends Command implements ConsoleHandlerAwareCommand
{
    private $logger;
    
    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
        parent::__construct();
    }

    public function configureConsoleHandler(ConsoleHandler $consoleHandler)
    {
        $consoleHandler->setSections([
            new RotateLogSection(), 
            new RegexProgressBarSection(
                '#My loop with (?<maxCount>\\d+) items#', // start regex
                '#Loop item \d+', // advance regex
                '#Loop finished#', // finish regex
                'Foo bar' // name of progress bar
            ),
        ]);        
    }
    
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        // Do my very long job with loop ...
        $this->logger->debug('My loop with 1000 items');
        for ($i = 0; $i < 1000; $i++) {
            usleep(500);
            $this->logger->debug("Loop item {$i}");
        }
        $this->logger->debug("Loop finished");
        
        return 0;
    }    
}