Artim Logger

How to start

At first we need install package:

composer require artim/logger

Add LARAVEL_START const to artisan file in root directory:

define('LARAVEL_START', microtime(true));

This is necessary to fix the start time of request processing.

Then we need append ArtimLoggerServiceProvider.php to app.php config. Here you can see the effect of configuration settings on the information that will be logged.

class ArtimLoggerServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        $this->publishes([
            __DIR__ . '/../config/artim-logger.php' => config_path('artim-logger.php'),
        ], 'config');
    }

    public function register(): void
    {
        $this->app->make(LogRegistrator::class)->set();
        $this->app->make(HttpRegistrator::class)->set();

        if (config('artim-logger.logs.application')) {
            $this->app->make(AppLogRegistrator::class)->set();
        }

        if (config('artim-logger.logs.db')) {
            $this->app->make(DBLogRegistrator::class)->set();
        }

        $this->mergeConfigFrom(__DIR__ . '/../config/artim-logger.php', 'artim-logger');
    }
}

class AppLogRegistrator extends AbstractRegistrator
{
    public function set(): void
    {
        $this->app->terminating(function () {
            $data = [
                'type' => 'application',
                'startedAt' => LARAVEL_START,
                'endedAt' => microtime(true),
                'peakMemoryUsage' => get_formatted_peak_memory_usage(),
            ];

            if (config('artim-logger.logs.request')) {
                $data['request'] = request();
            }

            \Log::info('App terminating', $data);
        });
    }
}

Then we need add Http facade to list of aliases in app.php:

'Http' => \Artim\Logger\Http\Http::class,

Now you can append configuration for logger in logging.php:

'artim' => [
    'driver' => 'monolog',
    'level' => env('LOG_LEVEL', 'debug'),
    'handler' => \Monolog\Handler\RotatingFileHandler::class,
    'formatter' => \Artim\Logger\Logger\File\JsonFormatter::class,
    'handler_with' => [
        'filename' => storage_path('logs/laravel-artim.log'),
    ],
],

It will write logs to storage/logs/laravel-test.log file:

\Log::info('Some log message', ['property' => 'some value of the property']);

{
  "message": "Some log message",
  "context": {
    "property": "some value of the property",
    "user": null,
    "token": "cd3856c0bc1abae60ebd8f1df9d0ebb8"
  },
  "level": 200,
  "level_name": "INFO",
  "channel": "local",
  "datetime": "2023-03-18T18:58:13.262363+00:00",
  "extra": {}
}

If you want to track the action of your application inside the queues, you can use the class Artim\Logger\Job

namespace Artim\Logger\Job;

use Illuminate\Contracts\Queue\ShouldQueue;

abstract class Job implements ShouldQueue
{
    use LogToken;

    protected string $logToken;
}