errorstream/errorstream-laravel

Laravel Package for ErrorStream.com integration

errorstream-laravel

Laravel integration with Errorstream., _(*1)

Installation Instructions

First, run the following command on the terminal to download and install the package, _(*2)

composer require errorstream/errorstream-laravel 3.*

Next, register the service provider in the config/app.php file., _(*3)

'providers' => [
     // ...
     ErrorStream\ErrorStream\ErrorStreamServiceProvider::class,
]

Then add the Facade to the aliases array in the config/app.php file., _(*4)

'aliases' => [
    // ...
    'ErrorStream' => ErrorStream\ErrorStream\Facades\ErrorStream::class,
]

Then hook into the App/Exceptions/Handler.php file to send errors to our service., _(*5)

public function report(Exception $e)
{
    if ($this->shouldReport($exception) && config('services.errorstream.enabled')) {
        ErrorStream::reportException($exception);
    }
     parent::report($e);
}

Add the following two configuration entries into .env. You can find your API key and project token on the project settings page for the project you wish to integrate., _(*6)

ERROR_STREAM_API_TOKEN=YOUR_API_TOKEN
ERROR_STREAM_PROJECT_TOKEN=YOUR_PROJECT_TOKEN
ERROR_STREAM_ENABLED=1

Finally, Add the errorstream config entries in your config/services.php, _(*7)

'errorstream' => [
    'api_token'     => env('ERROR_STREAM_API_TOKEN'),
    'project_token' => env('ERROR_STREAM_PROJECT_TOKEN'),
    'enabled'       => env('ERROR_STREAM_ENABLED'),
],

Tagging

Anywhere within your application you can append tags on to the reports that you generate and send to errorstream.com. Tags are great for grouping code together. You can make a call to add a tag anywhere by calling addTag(). A great place to do this would be to extend your Handler class modifications. For example:, _(*8)

public function report(Exception $e)
{
     if ($this->shouldReport($e)) {
          ErrorStream::addTag('v1.0.2');
          ErrorStream::reportException($e);
     }
     parent::report($e);
}

Adding Context

Sometimes you'll need additional information in order to diagnose issues. Context is great for adding more information to errors. Maybe you want to send a build number, user id, or anything else. You can use this in anywhere in your laravel application, _(*9)

ErrorStream::addContext('some more details about variables that are set');