README

这是一个用于最新 Airbrake PHP 包的 Laravel 服务提供者 https://github.com/airbrake/phpbrake

服务提供者将配置一个带有 ID、密钥和环境名称的 Airbrake\Notifier 实例。

安装

使用 composer 安装此包。

composer require kouz/laravel-airbrake

对于 Laravel >=5.5，此包将被发现。对于 Laravel <=5.4，请将包添加到 config/app.php 中的服务提供者列表。

<?php

    //config/app.php
  
    'providers' => [
        Kouz\LaravelAirbrake\ServiceProvider::class,
    ],

发布并填写 config/airbrake.php 文件中的您的 ID 和密钥。

php artisan vendor:publish --provider="Kouz\LaravelAirbrake\ServiceProvider"

配置

projectId 和 projectKey 变量是必需的。其余留空以使用 Airbrake 的默认值。

    'projectId'     => '',
    'projectKey'    => '',
    'environment'   => env('APP_ENV', 'production'),

    //leave the following options empty to use defaults

    'host'          => null, #airbrake api host e.g.: 'api.airbrake.io' or 'http://errbit.example.com
    'appVersion'    => null,
    'revision'      => null, #git revision
    'rootDirectory' => null,
    'keysBlacklist' => null, #list of keys containing sensitive information that must be filtered out
    'httpClient'    => null, #http client implementing GuzzleHttp\ClientInterface

基本用法

>=5.6 自定义通道

将自定义的 "airbrake" 通道（如下所示）添加到 config/logging.php。然后将 "airbrake" 通道添加到堆栈通道。

//config/logging.php

    'channels' => [
        'stack' => [
            'driver' => 'stack',
            'channels' => ['single', 'airbrake'],
        ],

        'airbrake' => [
            'driver' => 'custom',
            'via' => Kouz\LaravelAirbrake\AirbrakeLogger::class,
            'level' => 'error',
        ],
    ]

异常处理器

如下代码片段所示，通过 Laravel 异常处理器通知 airbrake。注入或创建一个新的 Airbrake\Notifier 对象实例，然后传递一个异常给 notify 函数。

//app/Exceptions/Handler.php

/**
 * Report or log an exception.
 *
 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
 *
 * @param  \Exception  $exception
 * @return void
 */
public function report(Exception $exception)
{
    if ($this->shouldReport($exception) && App::environment(['production', 'staging'])) {
        $airbrakeNotifier = \App::make('Airbrake\Notifier');
        $airbrakeNotifier->notify($exception);
    }

    parent::report($exception);
}

<=5.5 自定义 Monolog 配置

要将其配置为 Monolog 处理器，您必须在 bootstrap/app.php 中创建一个自定义配置。此回调函数在服务提供者加载之前被调用。因此，有必要直接使用我们的 AirbrakeHandler 类而不是提供者。

//bootstrap/app.php

$app->configureMonologUsing(function($monolog) use ($app) {
    $airbrakeNotifier = (new Kouz\LaravelAirbrake\AirbrakeHandler($app))->handle();
    $monologHandler = new Airbrake\MonologHandler($airbrakeNotifier, Monolog\Logger::ERROR);
    $monolog->pushHandler($monologHandler);
});