dotburo/laravel-molog

Laravel tool to log model-specific messages and metrics

1.6.0 2023-06-13 14:39 UTC

Requires

• php: ^7.4 || ^8
• illuminate/config: ^7.4 || ^8.0 || ^9.0 || ^10.0
• illuminate/database: ^7.4 || ^8.0 || ^9.0 || ^10.0
• illuminate/support: ^7.4 || ^8.0 || ^9.0 || ^10.0
• psr/log: ^1.1 || ^2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• nunomaduro/collision: ^5.3 || ^6.0 || ^7.0
• orchestra/testbench: ^5.20 || ^6.23 || ^7.0 || ^8.0
• pestphp/pest: ^1.18 || ^2
• pestphp/pest-plugin-laravel: ^1.1 || ^2
• phpstan/phpstan: ^1.10
• vimeo/psalm: ^5.9

GPL-3.0-or-later

• dotburo

• logging
• laravel
• dotburo
• mertics

README

Laravel Molog enables you to log messages and store metrics that are related to specific models. Akin to Spatie's Activity Log, but slightly more generic and with the possibility to associate metrics (Gauges) to messages or to any other Laravel model. The gauges factory class also provides builtin timer, incrementation and percentage methods.

In its simplest form:

$user = auth()->user();

$this->message('Mail sent!')->concerning($user)->save();

A slightly more advanced example — a message with metrics for a custom model:

$model = new Model();

$this->gauges()->startTimer();

$this->message()->notice('Import started...')->concerning($model)->save();

// processing...

$this->gauges()
    ->concerning($this->messages()->last())
    ->gauge('Files accepted', 16)
    ->gauge('Files refused', 2)
    ->stopTimer()
    ->save();

Good old exception logging:

$msg = $this->message(new Exception('Oops'))->setContext('example');

echo $msg;              // 2023-04-10 17:34:22.348 [debug] [example] Oops
echo $msg->subject;     // Oops
echo $msg->body;        // Stack trace ...

Features

• Attach log messages and metrics (gauges) to models
• Follows the PSR-3: Logger Interface
• Exception logging
• Start & stop timer metrics
• Increment and decrement methods for gauges
• Output messages and metrics to string
• Generic HTTP controller

Usage

Install with composer from packagist.org:

composer require dotburo/laravel-molog

Publish the config file and migrations and migrate your app:

php artisan vendor:publish --provider="Dotburo\Molog\MologServiceProvider"

php artisan migrate

Wherever you need logging, use the Logging trait. See the documentation for more usage examples.

class YourClass {

    use \Dotburo\Molog\Traits\Logging;
    
    protected function handle()
    {
        // This will store three messages
        $this->messages()
            ->message('Import process initiated', \Psr\Log\LogLevel::INFO)
            ->notice('Import process ongoing')
            ->warn('Import process aborted')
            ->save();
        
       // This will store one message with the subject 'aborted' and level critical
       $this->message()
            ->setContext('Import process')
            ->notice('ongoing')
            ->warn('aborted')
            ->setLevel(\Dotburo\Molog\MologConstants::CRITICAL)
            ->save();
        
        // Associate all subsequent metrics with the last message
        $this->gauges()->concerning($this->messages()->last());
        
        // Associate this metric of type INT with the first message
        $this->gauge('density', 5)->concerning($this->messages()->first())->save();
        
        // Add three metrics associated with the last message
        $this->gauges()
            ->gauge('density', 5.3567)  // updates the previous 'density' metric to the FLOAT value
            ->gauge('pressure', 2.35, 'bar', \Dotburo\Molog\MologConstants::GAUGE_INT_TYPE) // forcibly cast to FLOAT
            ->gauge('quality', 3)
            ->save();
    }
}

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• dotburo
• All Contributors

License

GNU General Public License (GPL). Please see the license file for more information.