kevariable/laravel-slack-logging

Laravel Slack Logging

Laravel Slack Logging is a package that sends exception notifications directly to a Slack channel using webhooks. It includes request payload in notifications, deduplicates repeated exceptions with escalating sleep intervals, and lets you skip specific exception classes or environments.

Preview

Installation

You can install the package via Composer:

composer require kevariable/laravel-slack-logging

You can publish the config file with:

php artisan vendor:publish --tag="laravel-slack-logging-config"

Usage

Add the Slack webhook URL to your .env file:

SLACK_LOGGING_WEBHOOK_URL=https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK

Then add the Slack logging channel to your config/logging.php:

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['single', 'slack'],
        ...
    ],

    'slack' => [
        'driver' => 'slack-logging',
        ...
    ],
],

Now any exception thrown in your application will be sent to Slack.

Configuration

The published config file (config/slack-logging.php) provides the following options:

Environments

Only send notifications in specified environments:

'environments' => [
    'production',
],

Except

Skip specific exception classes:

'except' => [
    Symfony\Component\HttpKernel\Exception\NotFoundHttpException::class,
],

Sleep (Deduplication)

Prevent duplicate exceptions from spamming your Slack channel. When the same exception is raised repeatedly, the sleep duration escalates through the configured steps:

'sleep' => [60, 120, 300],

Set to an empty array to disable deduplication:

'sleep' => [],

Payload

Request parameters are automatically included in the Slack notification when available, making it easier to debug the exception context.

Testing

composer test

Testing in Your Application

Use the facade fake to assert exceptions in your tests:

use Kevariable\SlackLogging\Facades\SlackLogging;

SlackLogging::fake();

// trigger exception...

SlackLogging::assertRequestsSent(1);

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

• kevariable
• All Contributors

License

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