lynetechnologies/laravel-watchtower

Laravel Error Notification

1.0.0 2021-12-30 20:05 UTC

Requires

• php: ^8.0
• spatie/laravel-package-tools: ^1.4.3

Requires (Dev)

• nunomaduro/collision: ^5.3
• orchestra/testbench: ^6.15
• pestphp/pest: ^1.18
• pestphp/pest-plugin-laravel: ^1.1
• spatie/laravel-ray: ^1.23
• vimeo/psalm: ^4.8

MIT

• Luke Shell

• lynetechnologies
• laravel-watchtower

README

Looking for a free laravel error reporting package? Well you've arrived at the right place! Laravel Watchtower is simple yet affective package that notifies you when an error is hit on your site.

Installation

You can install the package via composer:

composer require lynetechnologies/laravel-watchtower

Next, in your app/Exceptions/Handle.php add the below in the register method.

use LyneTechnologies\LaravelWatchtower\LaravelWatchtower;

public function register()
{
    //...
    $this->reportable(function (Throwable $e) {
        (new LaravelWatchtower())->capture($e);
    });
    //...
}

Once enabled one or more notification streams below, you can then use the watchtower:test command to test everything is running as expected.

php artisan watchtower:test

Usage

Email

To enable email notifications add the below to your .env file.

WATCHTOWER_EMAIL_ACTIVE=true
WATCHTOWER_EMAIL_RECIPIENTS='[e-mail],[e-mail]'

Slack

To enable Slack notifications follow the below.

In your Slack App you see the + symbol next to "Apps", click on the icon, and search "Incoming Webhook" in the search bar.

Then install the Incoming Webhook application. Now go to the setting tab inside the Incoming Webhook app which you just install. You'll be asked to provide the channel name, then you’ll get a Webhook URL. Use that in your env file.

WATCHTOWER_SLACK_ACTIVE=true
WATCHTOWER_SLACK_HOOK='XXXXXXXX/WEBHOOK/URL_GOES_HERE_XXXXXX'

To change which channel the errors go to, you can either use the below or update the webhook settings.

WATCHTOWER_SLACK_CHANNEL='#error'

Local

You can store the error notifications locally for you to properly review at a later date.

WATCHTOWER_LOCAL_ACTIVE=true

Route names, endpoints and most importantly middleware can all be managed within the config file.

Prune the table

Use the below variable to define the age in days to prune. Defaults to 0, which will stop any pruning.

WATCHTOWER_LOCAL_PRUNE=14

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security Vulnerabilities

Please report security vulnerabilities to [e-mail].

License

The MIT License (MIT). Please see License File for more information.