errorstream/errorstream-laravel

Laravel集成ErrorStream.com的包

4.1 2018-04-30 22:05 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:20:02 UTC


README

Laravel与Errorstream集成。

##安装说明

首先,在终端运行以下命令以下载和安装包

composer require errorstream/errorstream-laravel 3.*

接下来,在config/app.php文件中注册服务提供者。

'providers' => [
     // ...
     ErrorStream\ErrorStream\ErrorStreamServiceProvider::class,
]

然后,在config/app.php文件中将Facade添加到aliases数组中。

'aliases' => [
    // ...
    'ErrorStream' => ErrorStream\ErrorStream\Facades\ErrorStream::class,
]

然后,在App/Exceptions/Handler.php文件中挂钩,以便将错误发送到我们的服务。

public function report(Exception $e)
{
    if ($this->shouldReport($exception) && config('services.errorstream.enabled')) {
        ErrorStream::reportException($exception);
    }
     parent::report($e);
}

将以下两个配置条目添加到.env文件中。您可以在要集成的项目的项目设置页面上找到您的API密钥和项目令牌。

ERROR_STREAM_API_TOKEN=YOUR_API_TOKEN
ERROR_STREAM_PROJECT_TOKEN=YOUR_PROJECT_TOKEN
ERROR_STREAM_ENABLED=1

最后,在您的config/services.php中添加errorstream配置条目

'errorstream' => [
    'api_token'     => env('ERROR_STREAM_API_TOKEN'),
    'project_token' => env('ERROR_STREAM_PROJECT_TOKEN'),
    'enabled'       => env('ERROR_STREAM_ENABLED'),
],

##在任何地方标记您的应用程序,您都可以在生成的报告中附加到errorstream.com的标签。标签非常适合将代码分组在一起。您可以通过调用addTag()在任何地方添加标签。一个很好的地方是在扩展您的Handler类修改中这样做。例如

public function report(Exception $e)
{
     if ($this->shouldReport($e)) {
          ErrorStream::addTag('v1.0.2');
          ErrorStream::reportException($e);
     }
     parent::report($e);
}

##添加上下文有时您需要额外的信息来诊断问题。上下文非常适合向错误添加更多信息。也许您想发送构建号、用户ID或其他任何信息。您可以在Laravel应用程序的任何地方使用它

ErrorStream::addContext('some more details about variables that are set');