guanguans/laravel-exception-notify

Monitor exception and report it to notification channels(Dump、Log、Mail、AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPu

4.6.0 2024-08-16 08:02 UTC

Requires

• php: >=7.4
• ext-json: *
• guanguans/notify: ^2.11
• illuminate/support: ^8.23 || ^9.0 || ^10.0 || ^11.0

Requires (Dev)

• brainmaestro/composer-git-hooks: ^2.8 || ^3.0
• driftingly/rector-laravel: ^1.2
• ergebnis/composer-normalize: ^2.43
• ergebnis/license: ^2.4
• ergebnis/php-cs-fixer-config: dev-main
• ergebnis/rector-rules: ^1.0
• guanguans/monorepo-builder-worker: ^1.4
• hyperf/composer-plugin: ^1.0
• icanhazstring/composer-unused: ^0.8
• maglnet/composer-require-checker: ^3.8 || ^4.0
• mockery/mockery: ^1.6
• orchestra/testbench: ^6.45 || ^7.0 || ^8.0 || ^9.0
• pestphp/pest: ^1.23 || ^2.0
• pestphp/pest-plugin-faker: ^1.0 || ^2.0
• pestphp/pest-plugin-laravel: ^1.2 || ^2.0
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^1.11
• phpstan/phpstan-deprecation-rules: ^1.2
• rector/rector: ^1.2

MIT

• guanguans

• log
• mail
• dump
• email
• exception
• error
• logger
• sdk
• notification
• monitor
• bot
• laravel
• push
• notify
• notifier
• pushover
• qq
• notice
• slack
• pushbullet
• gitter
• telegram
• 微信
• discord
• dingtalk
• Mattermost
• 企业微信
• simplepush
• 钉钉
• lark
• wework
• rocketchat
• zulip
• 钉钉群机器人
• Bark
• Server酱
• 息知
• chanify
• serverChan
• xiZhi
• 飞书群机器人
• 飞书
• 企业微信群机器人
• Ntfy
• googleChat
• pushPlus
• pushBack
• iGot
• PushDeer
• QQ 频道机器人
• 一封传话
• MicrosoftTeams
• NowPush
• ShowdocPush
• YiFengChuanHua
• AnPush
• WPush

README

Monitor exception and report it to notification channels(Dump、Log、Mail、AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPush、XiZhi、YiFengChuanHua、Zulip).

Features

• Monitor exception and report it to notification channels
• Support for extending customized channels
• Support for notification rate limiting
• Support for customized data pipe
• Support for customized data collector

Related Links

• https://github.com/guanguans/notify
• https://github.com/guanguans/yii-log-target

Requirement

• PHP >= 7.4

Installation

composer require guanguans/laravel-exception-notify --ansi -v

Configuration

Publish files(optional)

php artisan vendor:publish --provider="Guanguans\\LaravelExceptionNotify\\ExceptionNotifyServiceProvider" --ansi -v

Apply for channel authentication and other information

• Notify
• Dump(For debugging exception messages)
• Log
• Mail

Configure channels in the config/exception-notify.php and .env file

# EXCEPTION_NOTIFY_DEFAULTS=dingTalk,lark,mail,slack,telegram,...
EXCEPTION_NOTIFY_DEFAULTS=log,slack,weWork
EXCEPTION_NOTIFY_SLACK_WEBHOOK=https://hooks.slack.com/services/TPU9A9/B038KNUC0GY/6pKH3vfa3mjlUPcgLSjzR
EXCEPTION_NOTIFY_WEWORK_TOKEN=73a3d5a3-ceff-4da8-bcf3-ff5891778

Usage

Test for exception notify

php artisan exception-notify:test --ansi -v

Notification examples

Skip report

Modify the boot method in the app/Providers/AppServiceProvider.php file

<?php

use Guanguans\LaravelExceptionNotify\Facades\ExceptionNotify;
use Illuminate\Support\Arr;

public function boot(): void
{
    ExceptionNotify::skipWhen(static fn (\Throwable $throwable) => Arr::first(
        [
            \Symfony\Component\HttpKernel\Exception\HttpException::class,
            \Illuminate\Http\Exceptions\HttpResponseException::class,
        ],
        static fn (string $exception): bool => $throwable instanceof $exception
    ));
}

Custom channel

Modify the boot method in the app/Providers/AppServiceProvider.php file

<?php

use Guanguans\LaravelExceptionNotify\Contracts\Channel;
use Guanguans\LaravelExceptionNotify\Facades\ExceptionNotify;
use Illuminate\Container\Container;

public function boot(): void
{
    ExceptionNotify::extend('YourChannelName', function (Container $container): Channel {
        return 'Instance of the `\Guanguans\LaravelExceptionNotify\Contracts\Channel`.';
    });
}

Testing

composer test

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

• guanguans
• All Contributors

Thanks

License

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