README

当服务器上的Laravel应用程序发生异常时，一种简单的方式发送带有堆栈跟踪的电子邮件。

安装

通过Composer安装

对于Laravel <= 5.2，请使用v1分支！

$ composer require squareboat/sneaker

配置Laravel

安装操作完成后，只需将服务提供者添加到项目的 config/app.php 文件中

服务提供者

SquareBoat\Sneaker\SneakerServiceProvider::class,

添加Sneaker的异常捕获

将异常捕获添加到 app/Exceptions/Handler.php

public function report(Exception $exception)
{
    app('sneaker')->captureException($exception);

    parent::report($exception);
}

配置文件

使用以下命令创建Sneaker配置文件

$ php artisan vendor:publish --provider="SquareBoat\Sneaker\SneakerServiceProvider"

配置文件将发布在 config/sneaker.php

以下是Sneaker使用的配置属性。

silent

该软件包默认带有 'silent' => true, 配置，因为你可能不想在开发环境中启用错误电子邮件。特别是如果你已经设置了 'debug' => true,。

'silent' => env('SNEAKER_SILENT', true),

要发送异常发生时的电子邮件，请在 .env 文件中设置 SNEAKER_SILENT=false。

capture

它包含应该捕获的异常类型的列表。您可以在此处添加您想要发送错误电子邮件的异常。

默认情况下，该软件包已包含 Symfony\Component\Debug\Exception\FatalErrorException::class。

'capture' => [
    Symfony\Component\Debug\Exception\FatalErrorException::class,
],

您也可以在 $capture 数组中使用 '*'，这将反过来捕获每个异常。

'capture' => [
    '*'
],

要使用此功能，您应该在 app/Exceptions/Handler.php 中添加以下代码

public function report(Exception $exception)
{
    if ($this->shouldReport($exception)) {
        app('sneaker')->captureException($exception);
    }

    parent::report($exception);
}

到

这是错误电子邮件的收件人列表。

'to' => [
    // 'hello@example.com',
],

ignored_bots

这是我们不发送错误电子邮件的机器人的列表。

'ignored_bots' => [
    'googlebot',        // Googlebot
    'bingbot',          // Microsoft Bingbot
    'slurp',            // Yahoo! Slurp
    'ia_archiver',      // Alexa
],

自定义

如果您需要自定义电子邮件的主题和正文，请运行以下命令

$ php artisan vendor:publish --provider="SquareBoat\Sneaker\SneakerServiceProvider"

注意 - 如果您已经运行过此命令，请勿再次运行。

现在，电子邮件的主题和正文视图位于 resources/views/vendor/sneaker 目录中。

我们已经传递了抛出的异常对象 $exception 到视图中，您可以使用它来自定义视图以满足您的需求。

Sneak

测试您的集成

为了验证Sneaker配置正确且我们的集成正常工作，请使用 sneaker:sneak Artisan命令

$ php artisan sneaker:sneak

将抛出并捕获的 SquareBoat\Sneaker\Exceptions\DummyException 类。捕获的异常将立即出现在您配置的电子邮件中。

安全

如果您发现任何与安全相关的问题，请通过电子邮件发送至 amit.gupta@squareboat.com，而不是使用问题跟踪器。

鸣谢

关于SquareBoat

SquareBoat 是一家位于印度古尔冈的初创企业，专注于产品开发。您可以在 GitHub 上找到我们所有开源项目的概述在这里。

nicoalvarez-cd / sneaker

维护者

详细信息