aydinhassan / progress-bar-log

A component to display a progress bar and last X logs at the same time.

Progress Bar Log

Display a progress bar and a portion of a log at the same time on the CLI!

Click the image above to see it in action.

Installation

$ composer require trash-panda/progress-bar-log

Use cases

Originally I wanted this for long running import/export work. Being able to see a subset of the most recent log entries and also still see the progress and memory usage without scrolling the terminal. I figured it might be useful for some other people too.

Usage

<?php

use Psr\Log\LogLevel;
use TrashPanda\ProgressBarLog\ProgressBarLog;

require_once __DIR__ . '/vendor/autoload.php';

//The first parameter is the number of log lines to be displayed. The newest entries will be displayed - like a tail.
//The second parameter is the maximum number of steps for the progress bar
$progressLog = new ProgressBarLog(6, 10);
$progressLog->start();

//advance the progress bar by one
$progressLog->advance();

//Add a log line - the first parameter is a psr/log severity constant
//you can pass whatever you want there - but if it is a psr/log constant then the severity is colored accordingly
$progressLog->addLog(LogLevel::CRITICAL, 'Some mission critical error');

See example.php for a working script:

git clone [email protected]:AydinHassan/progress-bar-log.git
cd progress-bar-log
php example.php

Customising the progress bar

The underlying progress bar is an instance of \Symfony\Component\Console\Helper\ProgressBar.

You can modify the settings of the progress bar by getting access to the instance via getProgressBar():

<?php

use TrashPanda\ProgressBarLog\ProgressBarLog;

require_once __DIR__ . '/vendor/autoload.php';

$progressLog = new ProgressBarLog(6, 10);
$progressLog->getProgressBar()->setFormat('normal');
$progressLog->getProgressBar()->setBarWidth(50);
$progressLog->start();

Running unit tests

$ composer test

progress-bar-log's Issues

Symfony console dependency version

Why is ^3.2 the version contraint for the symfony console?

As far as I can see, the ProgressBarLog only uses some base functions like start() and advance(). Right now its not usable inside Drupal8 projects which are currently locked to v2.8.17 (using the Drupal console).

[Feature-request] Don't clear the whole screen

As I can see you're using 2J as an ASCII Escape command to clear the whole window.
I'd like to see a version where only the number of lines is cleared which are used.

It could calculate in this way: height of the progress bar + number of current log messages.
The height of the progress bar is calculated by the progress bar itself in its clear() method.

Maybe you could concatenate it. Using $this->clear() which clears all log lines and then calling $this->progressBar->clear() to clear the bar itself.