danielme85/laravel-log-to-db

Custom Larvel 5.6+ Log channel handler that can store log events to SQL or MongoDB databases. Uses Laravel native logging functionality.

v2.0.2 2019-10-11 17:57 UTC

README

GitHub PHP from Packagist GitHub release GitHub tag Travis (.org) Codecov CodeFactor

Custom Laravel 6 and >=5.6 Log channel handler that can store log events to SQL or MongoDB databases. Uses Laravel native logging functionality.

Installation

Use the composer require or add to composer.json.

require danielme85/laravel-log-to-db

If you are using SQL database server to store log events you would need to run the migrations first. The MongoDB driver does not require the migration.

php artisan migrate

Configuration

Starting with Laravel 5.6 you will have a new settings file: "config/logging.php". You will need to add an array under 'channels' for Log-to-DB here like so:

'channels' => [
    'stack' => [
        'name' => 'Log Stack',
        'driver' => 'stack',
        'channels' => ['database', 'mongodb'],
    ],
    
    'database' => [
        'driver' => 'custom',
        'via' => danielme85\LaravelLogToDB\LogToDbHandler::class,
        'level' => env('APP_LOG_LEVEL', 'debug'),
        'name' => 'My DB Log',
        'connection' => 'default',
        'collection' => 'log',
        'detailed' => true,
        'queue' => false,
        'queue_name' => '',
        'queue_connection' => '',
        'processors' => [
              //Monolog\Processor\HostnameProcessor::class
         ]
    ],
    ...
]
  • driver = Required to trigger the log driver.
  • via = The Log handler class.
  • level = The minimum error level to trigger this Log Channel.
  • name = The channel name that will be stored with the Log event. Please note that if you use the stack driver the name value in the stack array is used.
  • connection = The DB connection from config/database.php to use (default: 'default').
  • collection = The DB table or collection name. (Default: log).
  • detailed = Store detailed log on Exceptions like stack-trace (default: true).
  • processors = Array of additional processors. These will add additional info into the 'extra' field in the logged data. More information about processors

More info about some of these options: https://laravel.com/docs/5.6/logging#customizing-monolog-for-channels

There are some default settings and more information about configuring the logger in the 'logtodb.php' config file. This could be copied to your project if you would like edit it with the vendor publish command.

php artisan vendor:publish

You can also set default log-to-db config settings in your .env file, for ex:

LOG_DB_CONNECTION='default'
LOG_DB_DETAILED=false
LOG_DB_MAX=100
LOG_DB_QUEUE=false
LOG_DB_QUEUE_NAME='logToDBQueue'
LOG_DB_QUEUE_CONNECTION='default'

## Usage
Use the default Laravel Facade "Log"
```php
Log::channel()->info("This thing just happened");
Log::channel()->warning("This kind of bad thing happened...");

You can give the logging channels whatever name you want instead of: 'database', as well as the log levels. The naming can be used later if you want to send a Log event to a specific channel:

Log::channel('database')->info("This thing just happened");
Log::channel('mongodb')->info("This thing just happened");

This logger works the same as any other across Laravel, for example you can add it to a stack. You can log multiple levels to multiple DB connections... the possibilities are ENDLESS! 😎

Config priority order

Lowest number has highest priority (overrides the one below);

  1. Log Channel config array in config/logging.php overrides logtodb.php
  2. .env File overrides config/logtodb.php file
  3. config/logtodb.php is the default config.

Log Worker Queue

It might be a good idea to save the log events with a Queue Worker. This way your server does not have to wait for the save process to finish. You would have to configure the Laravel Queue settings and run the Queue listener. https://laravel.com/docs/5.6/queues#running-the-queue-worker

The queue can be enabled/disabled in any of the following places:

  • LOG_DB_QUEUE = true | in .env
  • queue_db_saves => true | in config/logtodb.php
  • queue => true | in the log channel config array -> config/logging.php

Usage

Since this is a custom log channel for Laravel, all "standard" ways of generating log events etc should work with the Laravel Log Facade. See https://laravel.com/docs/5.6/logging for more information.

Log::debug("This is an test DEBUG log event");
Log::info("This is an test INFO log event");
Log::notice("This is an test NOTICE log event");
Log::warning("This is an test WARNING log event");
Log::error("This is an test ERROR log event");
Log::critical("This is an test CRITICAL log event");
Log::alert("This is an test ALERT log event");
Log::emergency("This is an test EMERGENCY log event");

You can also log to specific log channels: Log::channel('database')debug("This is an test DEBUG log event");

Fetching Logs

The logging by this channel is done trough the Eloquent Model builder. LogToDB::model($channel, $connection, $collection); You can skip all function variables and the default settings from the config/logtodb.php will be used.

$model = LogToDB::model();
$model->get(); //All logs for default channel/connection

Some more examples of getting logs

$logs = LogToDB::model()->get();
$logs = LogToDB::model()->where('level_name', '=', 'INFO')->get();

When getting logs for specific channel or DB connection and collection you can either use the channel name matching config/logging.php or connection name from config/databases.php. You can also specify collection/table name if needed as the third function variable when fetching the model.

$logsFromDefault = LogDB::model()->get(); //Get the logs from the default log channel and default connection.
$logsFromChannel = LogDB::model('database')->get(); //Get logs from the 'database' log channel.
$logsFromChannel = LogDB::model('customname')->get(); //Get logs from the 'customname' log channel.
$logsFromMysql   = LogToDB::model(null, 'mysql')->get(); //Get all logs from the mysql connection (from Laravel database config)
$logsFromMongoDB = LogToDB::model(null, 'mongodb')->get(); //Get all logs from the mongodb connection (from Laravel database config)

Add your own Model in your app

Since Laravel is supposed to use static defined collection/table names, it might be better to use your own model in your app for a more solid approach.
https://laravel.com/docs/5.7/eloquent#eloquent-model-conventions

SQL
namespace App;

use Illuminate\Database\Eloquent\Model;

class Log extends Model
{
    protected $table = 'log';
    protected $connection = 'mysql'
    
}
MongoDB
namespace App;

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class LogMongo extends Eloquent
{
    protected $collection = 'log';
    protected $connection = 'mongodb';

}

Fetching the model trough the LogToDB class (like the examples above) might have some side-effects as tables and connections are declared dynamically... aka made by Hackerman!

Adding tables/expanding collections

The Log handler for SQL expects the following schema:

Schema::create('log', function (Blueprint $table) {
      $table->increments('id');
      $table->text('message')->nullable();
      $table->string('channel')->nullable();
      $table->integer('level')->default(0);
      $table->string('level_name', 20);
      $table->integer('unix_time');
      $table->text('datetime')->nullable();
      $table->longText('context')->nullable();
      $table->text('extra')->nullable();
      $table->timestamps();
 });

This is the migration that ships with this plugin. You can add as many tables as you want, and reference them in the 'collection' config value. Collection = table, I used the term collection as it works for both SQL/noSQL. No migrations needed for MongoDB.

No indexes are added per default, so if you fetch a lot of log results based on specific time ranges or types: it might be a good idea to add some indexes.

Log Cleanup

There is a helper function to remove the oldest log events and keep a specified number

LogToDB::removeOldestIfMoreThen(100);

Or based on date (most be valid date/datetime supported by strtotime()) http://php.net/manual/en/function.strtotime.php

LogToDB::model()->removeOlderThen('2019-01-01');
LogToDB::model()->removeOlderThen('2019-01-01 23:00:00');

Processors

Monolog ships with a set of processors, these will generate additional data and populate the 'extra' field.

You could also create your own custom processor, make sure they implement Monolog\Processor\ProcessorInterface.

Example of custom processor
<?php

namespace App\CustomProcessors;

use Monolog\Processor\ProcessorInterface;

class PhpVersionProcessor implements ProcessorInterface {
     /**
     * @return array The processed record
     */
     public function __invoke(array $record) {
         $record['extra']['php_version'] = phpversion();
         
         return $record;
     }
}

Advanced /config/logging.php example

'default' => env('LOG_CHANNEL', 'stack'),

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['database', 'mongodb', 'single'],
    ],
    
    'database' => [
        'driver' => 'custom',
        'via' => danielme85\LaravelLogToDB\LogToDbHandler::class,
        'level' => env('APP_LOG_LEVEL', 'debug'),
        'connection' => 'default',
        'collection' => 'log'
        'detailed' => true,
        'queue' => true
        'queue_name' => 'logQueue'
        'queue_connection' => 'redis'
    ],
    
    'mongodb' => [
        'driver' => 'custom',
        'via' => danielme85\LaravelLogToDB\LogToDbHandler::class,
        'level' => 'debug',
        'connection' => 'mongodb',
        'collection' => 'log',
        'detailed' => true,
        'queue' => true
        'queue_name' => 'logQueue'
        'queue_connection' => 'redis'
    ],
    
    'limited' => [
        'driver' => 'custom',
        'via' => danielme85\LaravelLogToDB\LogToDbHandler::class,
        'level' => 'warning',
        'detailed' => false,
        'max_rows' => 10,
        'name' => 'limited',
    ]
    
    'single' => [
        'driver' => 'single',
        'path' => storage_path('logs/laravel.log'),
        'level' => env('APP_LOG_LEVEL', 'debug'),
    ],
    //....
]