imtigger/laravel-custom-log

Laravel Custom Log

Laravel CustomLog

Laravel failsafe custom logging library, _(*1)

• Log to multiple destinations
• Log to Console (STDOUT)
• Log to File
• Log to MySQL
• Log to Redis
• Log to syslog (Local/Remote)
• Log to Graylog (TCP/UDP)
• (Optional) Failsafe (Don't throw any exceptions in case logger fails)
• (Optional) Replace Laravel log (Laravel <= 5.5)
• (Optional) Register as Laravel logger channel (Laravel >= 5.6)

Installation

composer require imtigger/laravel-custom-log, _(*2)

On Laravel 5.4 and below, add the ServiceProvider to your config/app.php, _(*3)

Imtigger\LaravelCustomLog\LaravelCustomLogServiceProvider::class, _(*4)

Publish Config, _(*5)

php artisan vendor:publish --provider="Imtigger\\LaravelCustomLog\\LaravelCustomLogServiceProvider" --tag=config, _(*6)

Publish MySQL Migration (Optional, for Log to MySQL), _(*7)

php artisan vendor:publish --provider="Imtigger\\LaravelCustomLog\\LaravelCustomLogServiceProvider" --tag=migration, _(*8)

Choose Log Destinations

Add config into .env, you may enable multiple destinations, _(*9)

Console (STDOUT)

• CUSTOM_LOG_CONSOLE_ENABLE (true|false, default=false)

File

• CUSTOM_LOG_FILE_ENABLE (true|false, default=true)

MySQL

• CUSTOM_LOG_MYSQL_ENABLE (true|false, default=false)
• DB_LOG_CONNECTION (connection defined in database.php, default=mysql)
• DB_LOG_TABLE (default=logs)

Redis

• CUSTOM_LOG_REDIS_ENABLE (true|false, default=false)
• REDIS_LOG_CONNECTION (connection defined in cache.php, default=default)
• REDIS_LOG_KEY

Syslog

• CUSTOM_LOG_SYSLOG_ENABLE (true|false, default=false)
• CUSTOM_LOG_SYSLOG_HOST
• CUSTOM_LOG_SYSLOG_PORT (default=514)

Gelf (Graylog)

• CUSTOM_LOG_GELF_ENABLE (true|false, default=false)
• CUSTOM_LOG_GELF_PROTOCOL (TCP|UDP, default=UDP)
• CUSTOM_LOG_GELF_HOST
• CUSTOM_LOG_GELF_PORT (default=12201)

Basic Usage

CustomLog::emergency($channel, $message, $context), _(*10)

CustomLog::alert($channel, $message, $context), _(*11)

CustomLog::critical($channel, $message, $context), _(*12)

CustomLog::error($channel, $message, $context), _(*13)

CustomLog::warning($channel, $message, $context), _(*14)

CustomLog::notice($channel, $message, $context), _(*15)

CustomLog::info($channel, $message, $context), _(*16)

CustomLog::debug($channel, $message, $context), _(*17)

CustomLog::log($level, $channel, $message, $context), _(*18)

Replace Laravel log (Laravel <= 5.5)

Edit your bootstrap/app.php, add this before returning the application, _(*19)

$app->configureMonologUsing(function ($monolog) {
    $monolog->pushHandler(Imtigger\LaravelCustomLog\CustomLog::getSystemHandler());
});

Register as Laravel logger channel (Laravel >= 5.6)

Edit your config/logging.php, add this to the channels array, _(*20)

'customlog' => [
    'driver' => 'custom',
    'via' => Imtigger\LaravelCustomLog\CustomLog::class,
]