Laravel console logger

Provides logging and email notifications for Laravel console commands.

Dependencies

• PHP >=5.5.9
• Laravel >=5.2

Usage

1. Install package through composer:

   composer require illuminated/console-logger

2. Use Illuminated\Console\Loggable trait and specify notification recipients:

   namespace App\Console\Commands;
   
   use Illuminate\Console\Command;
   use Illuminated\Console\Loggable;
   
   class Foo extends Command
   {
       use Loggable;
   
       protected function getNotificationRecipients()
       {
           return [
               ['address' => 'john.doe@example.com', 'name' => 'John Doe'],
               ['address' => 'jane.smith@example.com', 'name' => 'Jane Smith'],
           ];
       }
   
       // ...
   }

3. Now your command is loggable!

   You have logs separated by commands and by dates, auto-rotation, global error handler, email notifications for any kind of errors (even for PHP notices in your commands), auto saving to DB, set of useful info added to each iteration, context support with nice dumps for each type of message and even more cool features right out of the box!

   These PSR-3 methods are available for you:

   • logDebug
   • logInfo
   • logNotice
   • logWarning
   • logError
   • logCritical
   • logAlert
   • logEmergency

   Here is the basic example of usage:

   class Foo extends Command
   {
       use Loggable;
   
       public function handle()
       {
           $this->logInfo('Hello World!');
       }
   
       // ...
   }

   [2016-05-11 17:19:21]: [INFO]: Command `App\Console\Commands\Foo` initialized.
   [2016-05-11 17:19:21]: [INFO]: Host: `MyHost.local` (`10.0.1.1`).
   [2016-05-11 17:19:21]: [INFO]: Database host: `MyHost.local`, port: `3306`, ip: ``.
   [2016-05-11 17:19:21]: [INFO]: Database date: `2016-05-11 17:19:21`.
   [2016-05-11 17:19:21]: [INFO]: Hello World!
   [2016-05-11 17:19:21]: [INFO]: Execution time: 0.009 sec.
   [2016-05-11 17:19:21]: [INFO]: Memory peak usage: 8 MB.
   

Location

Each command has a separate folder for it's logs. Path is generated according to the command's name. For example, command php artisan foo would have it's logs on ./storage/logs/foo/ folder, and command php artisan foo:bar on ./storage/logs/foo/bar/. Log file names are corresponding to dates, and only latest thirty files are stored.

Notifications

Notification recipients were set, so they would get email notifications according to execution process and log events. By default, you'll get notification of each level which is higher than NOTICE (see PSR-3 log levels). This means, that you'll get notification about each NOTICE, WARNING, ERROR, CRITICAL, ALERT and EMERGENCY, occurred while execution.

You can change this behaviour and customize other aspects of notifications too. Subject, "from address" and maybe some others, could be customized by overriding proper methods:

use Monolog\Logger;

class Foo extends Command
{
    use Loggable;

    protected function getNotificationSubject()
    {
        return "Oups! %level_name% while execution!";
    }

    protected function getNotificationFrom()
    {
        return ['address' => 'no-reply@awesome.com', 'name' => 'My Awesome Notification'];
    }

    protected function getNotificationLevel()
    {
        return Logger::ERROR;
    }

    // ...
}

Error handler

Each exception, error and even PHP notice or warning are handled for you. It would be automatically logged, and you'll get email notification. You'll know immediately if something went wrong while execution. Very useful for scheduled commands.

class Foo extends Command
{
    use Loggable;

    public function handle()
    {
        fatal();
    }

    // ...
}

Fatal error is handled and logged:

[2016-05-11 17:19:21]: [ERROR]: Call to undefined function App\Console\Commands\fatal()
array:4 [
    "code" => 0
    "message" => "Call to undefined function App\Console\Commands\fatal()"
    "file" => "/Applications/MAMP/htdocs/illuminated-console-logger-test/app/Console/Commands/Foo.php"
    "line" => 15
]

And email notification is sent:

Custom exceptions

You can throw an exception of any type from your code, and it would be properly handled by logger. However, if you want to pass an additional context to your exception, use Illuminated\Console\RuntimeException class:

use Illuminated\Console\RuntimeException;

class Foo extends Command
{
    use Loggable;

    public function handle()
    {
        throw new RuntimeException('Oooups! Houston, we have a problem!', [
            'some' => 123,
            'extra' => true,
            'context' => null,
        ]);
    }

    // ...
}

[2016-05-11 17:19:21]: [ERROR]: Oooups! Houston, we have a problem!
array:5 [
    "code" => 0
    "message" => "Oooups! Houston, we have a problem!"
    "file" => "/Applications/MAMP/htdocs/illuminated-console-logger-test/app/Console/Commands/Foo.php"
    "line" => 22
    "context" => array:3 [
        "some" => 123
        "extra" => true
        "context" => null
    ]
]

Auto saving to DB

In progress...

Advanced

Custom location

Sometimes it's needed to change location of the log files. For example, you want it to be dependent on some command's argument. If that is your case, just override getLogPath method in your command class:

class Foo extends Command
{
    use Loggable;

    protected function getLogPath()
    {
        return storage_path('logs/anything/you/want/date.log');
    }

    // ...
}

Notifications mail driver

In order to send an email notifications, package would check mail configuration of your Laravel project. If you're using one of supported mail drivers, it would be used for email notifications automatically. Supported drivers are: mail, smtp, sendmail, mandrill. If you're using something else, for example, ses or sparkpost - native PHP mail() function would be used as a driver.

Unfortunately, we're currently not supporting all of Laravel's mail drivers, because Monolog email handlers don't. Maybe in future other drivers would be supported too.

However, you can totally change this behaviour, by overriding getMailerHandler method:

class Foo extends Command
{
    use Loggable;

    protected function getMailerHandler()
    {
        $mailer = app('my-swift-mailer');

        $message = $mailer->createMessage();
        $message->setSubject('Hey! Something went wrong!');
        $message->setFrom(['no-reply@example.com' => 'My Notification System']);
        $message->setTo(['john.doe@example.com' => 'John Doe']);
        $message->setContentType('text/html');
        $message->setCharset('utf-8');

        return new SwiftMailerHandler($mailer, $message);
    }

    // ...
}

Accessing Monolog instance

This package is using Monolog logging library with all of it's power and benefits. If needed, you may access the underlying Monolog instance in a two ways:

• Using icLogger command's method:

  class Foo extends Command
  {
      use Loggable;
  
      public function handle()
      {
          $log = $this->icLogger();
      }
  
      // ...
  }

• Through Laravel service container:

  $log = $app('log.iclogger');

Troubleshooting

Trait included, but nothing happens?

Note, that Loggable trait is overriding initialize method:

trait Loggable
{
    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        $this->initializeLogging();
    }

    // ...
}

If your command is overriding initialize method too, then you should call initializeLogging method by yourself:

class Foo extends Command
{
    use Loggable;

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        $this->initializeLogging();

        $this->bar = $this->argument('bar');
        $this->baz = $this->argument('baz');
    }

    // ...
}

Several traits conflict?

If you're using some other cool illuminated/console-% packages, well, then you can find yourself getting "traits conflict". For example, if you're trying to build loggable command, which is protected against overlapping:

class Foo extends Command
{
    use Loggable;
    use WithoutOverlapping;

    // ...
}

You'll get fatal error, the "traits conflict", because both of these traits are overriding initialize method:

If two traits insert a method with the same name, a fatal error is produced, if the conflict is not explicitly resolved.

But don't worry, solution is very simple. Just override initialize method by yourself, and initialize traits in required order:

class Foo extends Command
{
    use Loggable;
    use WithoutOverlapping;

    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        $this->initializeMutex();
        $this->initializeLogging();
    }

    // ...
}