adaptit-darshan/exception-notifier

一个易于使用的包,用于在您的Laravel应用程序中发生异常时发送带有堆栈跟踪的电子邮件通知。

This package is auto-updated.

Last update: 2024-09-12 10:48:33 UTC


README

一个易于使用的包,用于在您的Laravel应用程序中发生异常时发送带有堆栈跟踪的电子邮件通知。

exception-notifier 包旨在处理和通知您的应用程序中的异常。它提供了一个方便的方式来通知每次发生异常,使其更容易实时监控和响应问题。

目录

安装

要安装 exception-notifier 包,您可以使用 Composer。运行以下命令

composer require adaptit-darshan/exception-notifier

此命令将包添加到您的 composer.json 文件并在项目中安装它。

配置

安装包后,您需要根据需要配置它。以下是如何配置通知器的示例。

  1. 发布配置文件

通过运行以下 Artisan 命令发布 ExceptionEmail 配置文件

php artisan vendor:publish --provider="AdaptItDarshan\ExceptionNotifier\Providers\ExceptionNotifierServiceProvider"

这将创建一个配置文件在 config/exception-notifier.php

收件人 通过更新 email 数组指定应接收异常通知的电子邮件地址:您可以在 .env 文件中使用 EXCEPTION_NOTIFIER_EMAIL

'email' => [
    env('EXCEPTION_NOTIFIER_EMAIL', ['hello@example.com'])
],

自定义电子邮件 要自定义错误通知电子邮件的主题和正文,请创建位于 : \resources\views\vendor\exception-notifier\emails\ 下的 blade 文件

捕获异常 您可以指定应触发电子邮件通知的异常类型。默认情况下,该包包括 \Symfony\Component\ErrorHandler\Error\FatalError::class

'capture' => [
    \Symfony\Component\ErrorHandler\Error\FatalError::class,
],

要捕获所有异常,您可以使用通配符 '*'

'capture' => [
    '*'
],

忽略异常 您可以定义不应触发电子邮件通知的异常。这是通过将它们添加到 ignored_exception 数组来完成的。

'ignored_exception' => [
    \Illuminate\Validation\ValidationException::class,
],

忽略机器人 您可以配置包以忽略由机器人触发的错误,例如搜索引擎爬虫。默认配置包括常见机器人,例如

'ignored_bots' => [
    'googlebot',
    'bingbot',
    'slurp', 
    'ia_archiver',
],

使用

一旦您已配置包,它将根据您提供的设置自动处理和通知异常。如果需要,您还可以手动通知异常。

use ExceptionNotifier\ExceptionNotifier;

$notifier = new ExceptionNotifier(config('exception-notifier'));
$notifier->notify(new \Exception('Custom exception message'));

特性

  • 电子邮件通知:通过电子邮件向指定的收件人发送通知。
  • 日志记录:可选地将异常记录到文件以供将来参考。
  • 可定制配置:轻松定制配置以满足您的需求。

贡献

欢迎贡献!如果您有任何改进的想法或发现错误,请打开问题或在 GitHub 存储库 上提交拉取请求。

安全

如果您发现任何安全问题,请直接通过电子邮件联系我们在 damku999@gmail.com,而不是在 GitHub 上打开问题。

致谢

AboutWebmonks

Webmonks 是一家位于印度艾哈迈达巴德的初创产品开发公司。您可以在 GitHub 上探索我们所有的开源项目。

许可

exception-notifier 包是开源软件,根据 MIT 许可 许可。

有关更多详细信息,请访问 Packagist 页面 或查看 GitHub 存储库