[5.3] Fire events when command starts and terminates

[bmitch]

No description provided.

[bmitch]

Related to #15613

Thought I'd piggy back on the contributions by @themsaid and @lucasmichot to have events fired with a console command is starting and terminating.

One use case for this would be logging a message when a command starts and ends. I have scenarios where multiple commands are run throughout the night and this would be an easy way to have these messages logged.

[lucasmichot]

I think this would be just fine:

/**
 * {@inheritdoc}
 */

[lucasmichot]

$this->getCommandName($input) is repeated twice and could be extracted to $commandName

[lucasmichot]

Missing $exitCode argument

[bmitch]

Thanks for the feedback @lucasmichot I have updated the pull request.

[lucasmichot]

$exitCode should also be declared as a public property and set in the constructor.

[bmitch]

Thanks again @lucasmichot

[taylorotwell]

I don't know. I'm not very sold on this PR yet. If you have things you want to log from a command just put it in the command itself.

[Exadra37]

@taylorotwell

I see a very good use case here to avoid code duplication on very common task we use across hundreds of commands for mission critical batch processes that run all the day, some of them every 5 minutes.

On Command Start:

• $nagios->start();
• $log->info("{$startTime}|{$uniqueIdentifier}: Command {$commandName} starting");

On Command End:

• $nagios->success()
• $log->info("{$endTime}|{$uniqueIdentifier}: Command {$commandName} ending");

Advantages:

• So with this pull request we will avoid to have to declare this piece of logic in hundreds of command we need to maintain.
• In case we need to fix or change how we log and monitor commands start and end we only need to do it in 1 place, not in hundreds of places.
• This will allow more maintainable and clean code.

Please consider to merge it again.

Why Log and Monitor:

• We have automated tools parsing ElasticSearch logs to check for commands execution time and creating alerts when they exceed a threshold.
• Plus we have the Nagios checks alerting us when some Command fails to terminate.

[JosephSilber]

Could this not be done in a base class that all your commands extend?

[Exadra37]

We use micro services architecture and Inheritance is not used in our code base...

And yes it can be achieved in several different ways, but if the Framework can easily handle that with events, like in the Models, than no reason to duplicate efforts across several packages or create dependencies to handle this bit of logic.

[lucasmichot]

Can this not be reconsidered @taylorotwell ?

[bmitch]

For those interested I ended up creating a package that should fill the need:

https://github.com/bmitch/consoleEvents

Any feedback is greatly appreciated. Thanks.