nevar/laravel-slack-error-logger

Simple slack error logger package for lower laravel packages

dev-master 2019-07-01 15:23 UTC

Requires

• php: >=5.6.4
• guzzlehttp/guzzle: ^6.2
• laravel/framework: >=5.3 <5.5

MIT

• James Ng'ang'a

README

Simple slack error logger package for lower laravel packages

Note versions of laravel higher thatn 5.5 already have this functionality inbuilt within them; so use this package when looking for a quick patch for this functionality.Otherwise update your laravel version.

Also it would be a good idea to switch your queue driver from QUEUE_DRIVER=sync to QUEUE_DRIVER=redis when in a production environment (this package relies on laravel jobs)

1. Install composer require nevar/laravel-slack-error-logger "@dev",

2. Service Provider depending on your version of laravel copy and the following code to config/app.php,

return [
    /*
    * Application Service Providers...
    */
    Raven\Slack\Providers\SlackServiceProvider::class,
];

then run php artisan config:cache.

1. Configurations run php artisan vendor:publish --tag=raven-slack-error-logger to publish the configuration file config\slack.php which should look like this.

return [
    /**
     * ---------------------------------------------------------------------------------------------------
     * slack base uri
     * ---------------------------------------------------------------------------------------------------
     */
    'base_uri' => 'https://hooks.slack.com',

    /**
     * ---------------------------------------------------------------------------------------------------
     * Enable\disable the error logger default is *true*
     * ---------------------------------------------------------------------------------------------------
     */
    'enable_error_logging' => env('SLACK_ENABLE_ERROR_LOGGING',true),

    /**
     *  ---------------------------------------------------------------------------------------------------
     * Your slack channel web hook visit https://api.slack.com/incoming-webhooks for more
     * information on how to acquire one
     *  ---------------------------------------------------------------------------------------------------
     */
    'error_web_hook' => env('SLACK_ERROR_WEBHOOK','/services/ABCD/EFGH/ijklmnopqrst')
];

then override with your own settings by adding SLACK_ENABLE_ERROR_LOGGING and SLACK_ERROR_WEBHOOK

1. Alias add the following alias to to config/app.php

return [
    /*
    |--------------------------------------------------------------------------
    | Class Aliases
    |--------------------------------------------------------------------------
    |
    | This array of class aliases will be registered when this application
    | is started. However, feel free to register as many as you wish as
    | the aliases are "lazy" loaded so they don't hinder performance.
    |
     */
    'Slack'        => Raven\Slack\Facades\Slack::class,
];

then run php artisan config:cache again.

1. Implementation add the following line of code to your exception hander within app\Exceptions\Handler.php

    /**
     * Report or log an exception.
     *
     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
     *
     * @param  \Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        \Slack::log_error($exception);
        parent::report($exception);
    }