skater4/laravel-sentry-notifications

Sends laravel sentry exceptions to messengers

1.0.9 2024-10-01 10:48 UTC

Requires

• php: >=7.3
• ext-mbstring: *
• laravel-notification-channels/telegram: *
• sentry/sentry-laravel: *

Requires (Dev)

• mockery/mockery: ^1.4
• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.5

MIT

• Stan Man

README

This package makes it easy to send Sentry notification to different channels in Laravel.

Contents

• Installation
  • Sentry
  • Telegram
• Usage
• Alternatives
• Changelog
• Testing
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require skater4/laravel-sentry-notifications

Setting up Sentry

After basic Sentry set up you have to add Issues URL to .env

SENTRY_ISSUES_URL=https://sentry.io/organizations/sentry/issues

Setting up Telegram

To use Telegram for your notifications you need first set up your telegram bot ant obtain Chat\Channel ID. Please, follow these instructions

Then add following settings to .env

SENTRY_TELEGRAM_BOT_TOKEN=<your:bot-token>
SENTRY_TELEGRAM_CHAT_ID=<your_chat_id>
SENTRY_NOTIFICATION_SERVICE=telegram

Usage

Just add following code where exception is handled to be reported

app(SentryNotifier::class)->reportSentryNotification($exception);

For example report method in default exception handler

public function report(Throwable $exception)
{
    if (app()->bound('sentry') && $this->shouldReport($exception)) {
        app(SentryNotifier::class)->reportSentryNotification($exception);
    }

    parent::report($exception);
}

Alternatives

For advance usage, please consider using laravel-notification-channels instead.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Credits

• Stan Man
• All Contributors

License

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