tylercd100/lern

LERN (Laravel Exception Recorder and Notifier) is a Laravel 5 package that will record exceptions into a database and will notify you via Email, Pushover or Slack.

Wednesday, July 4, 2018
by tylercd100
Repository
15 Watchers
367 Stars
53,282 Installations

PHP
4 Dependents
0 Suggesters
27 Forks
5 Open issues
65 Versions
9 % Grown

The README.md

LERN (Laravel Exception Recorder and Notifier)

, _(*1)

LERN from your mistakes, _(*2)

LERN is a Laravel 5 package that will record exceptions into a database and will send you a notification., _(*3)

Currently supported notification channels via Monolog - Email - Pushover - Slack - Fleephook - Flowdock - Plivo an SMS messaging service. - Twilio an SMS messaging service. - Sentry via Sentry SDK for PHP - Mailgun, _(*4)

Version Compatibility

Laravel	LERN
5.1.x	3.x
5.2.x	3.x
5.3.x	3.x
5.4.x	3.x
5.5.x	4.x
5.6.x	4.x
6.x	5.x and 6.x
7.x	6.x
8.x	6.x

Migrating from `3.x` to `4.x`

Make sure that the config file now includes the new lern.notify.class and lern.record.class settings. Check the config file to see how they are used., _(*5)

Migrating from `2.x` to `3.x`

Version 3.x introduces the ability to collect more information from the error such as the user_id, url, method, and input data. In order to use 3.x you will need to copy over the new config file, the migration file and then migrate it., _(*6)

# This will only copy over the migration file. For the config file you can either include the --force flag (Which will overwrite it) or copy it manually from github
php artisan vendor:publish --provider="Tylercd100\LERN\LERNServiceProvider"
php artisan migrate

Installation

Version 4.x uses Package Discovery. If you are using 3.x you will need to follow these instructions., _(*7)

Install via composer - In the terminal:, _(*8)

composer require tylercd100/lern

Then you will need to run these commands in the terminal in order to copy the config and migration files, _(*9)

php artisan vendor:publish --provider="Tylercd100\LERN\LERNServiceProvider"

Before you run the migration you may want to take a look at config/lern.php and change the table property to a table name that you would like to use. After that run the migration, _(*10)

php artisan migrate

Usage

To use LERN modify the report method in the app/Exceptions/Handler.php file, _(*11)

public function report(Throwable $e)
{
    if ($this->shouldReport($e)) {

        //Check to see if LERN is installed otherwise you will not get an exception.
        if (app()->bound("lern")) {
            app()->make("lern")->handle($e); //Record and Notify the Exception

            /*
            OR...
            app()->make("lern")->record($e); //Record the Exception to the database
            app()->make("lern")->notify($e); //Notify the Exception
            */
        }
    }

    return parent::report($e);
}

Dont forget to add this to the top of the file, _(*12)

//If you updated your aliases array in "config/app.php"
use LERN;
use Throwable;
//or if you didnt...
use Tylercd100\LERN\Facades\LERN;
use Throwable;

Recording

You can call LERN::record($exception); to record an Exception to the database. To query any Exception that has been recorded you can use ExceptionModel which is an Eloquent Model, _(*13)

use Tylercd100\LERN\Models\ExceptionModel;
$mostRecentException = ExceptionModel::orderBy('created_at','DESC')->first();

To change what is recorded in to the database take a look at config/lern.php, _(*14)

'record'=>[
    /**
     * The Model to use
     */
    'model' => \Tylercd100\LERN\Models\ExceptionModel::class,

    /**
     * Database connection to use. Null is the default connection.
     */
    'connection'=>null,

    /**
     * Database table to use
     */
    'table'=>'vendor_tylercd100_lern_exceptions',

    /**
     * Information to store
     */
    'collect'=>[
        'method'=>false, //When true it will collect GET, POST, DELETE, PUT, etc...
        'data'=>false, //When true it will collect Input data
        'status_code'=>true,
        'user_id'=>false,
        'url'=>false,
        'ip'=>false,
    ],
],

Note: If you change lern.recorder.model then lern.recorder.table and lern.recorder.connection will be ignored unless you extend \Tylercd100\LERN\Models\ExceptionModel::class, _(*15)

Notifications

LERN uses the Monolog library to send notifications. If you need more than the supported notification channels, then you can add your own custom Monolog handlers. To start using any of the supported handlers just edit the provided config file config/lern.php., _(*16)

Changing the log level programmatically

Some notification services support different log levels. If changing the config value lern.notify.log_level is not enough then try it this way:, _(*17)

// Change the log level.
// Default is: critical
// Options are: debug, info, notice, warning, error, critical, alert, emergency
LERN::setLogLevel("emergency");

Changing the subject line

Some notification services support a subject line, this is how you change it., _(*18)

//Change the subject
LERN::setSubject("An Exception was thrown!");

Changing the body of the notification

LERN publishes a default blade template file that you can find at resources/views/exceptions/default.blade.php. The blade template file is compiled with these values: $exception $url $method $data $user. To specify a different blade template file, just edit the config file, _(*19)

'notify'=>[
    'view'=>'exceptions.default',
],

(deprecated) Using the `LERN::setMessage()` function

Make sure that you set the view config value to null or the LERN::setMessage() will not work, _(*20)

'notify'=>[
    'view'=>null,
],

Custom Monolog Handlers

To use a custom Monolog Handler call the pushHandler method, _(*21)

use Monolog\Handler\SlackHandler;
$handler = new SlackHandler($token, $channel);
LERN::pushHandler($handler);
LERN::notify($exception);

Roadmap

Support more Monolog Handlers
Exception report page or command to easily identify your application's issues.

The Versions

04/07 2018

dev-master

9999999-dev https://github.com/tylercd100/lern

LERN (Laravel Exception Recorder and Notifier) is a Laravel 5 package that will record exceptions into a database and will notify you via Email, Pushover or Slack.

laravel-package lern