afterbug/afterbug-yii

AfterBug Notifier for Yii 2 Applications.

1.0.2 2018-05-12 04:10 UTC

This package is not auto-updated.

Last update: 2024-09-27 08:08:36 UTC


README

StyleCI Total Downloads Latest Stable Version Latest Unstable Version License

此库检测您的Yii框架应用中的错误和异常,并将它们报告给AfterBug以进行警报和报告。

功能

  • 自动报告异常和错误
  • 发送自定义诊断数据
  • 附加用户信息以确定有多少人受到错误的影响。

安装

安装此扩展的首选方式是通过 composer

运行以下命令之一

composer require afterbug/afterbug-yii "~1.0"

或向您的 composer.json 添加 afterbug/afterbug-yii

"afterbug/afterbug-yii": "~1.0"

使用方法

扩展安装后,只需修改您的应用程序配置如下

$config = [
    // ...
    'components' => [
        'afterbug' => [
            'class' => 'AfterBug\AfterBugYii\AfterBug',
            'apiKey' => 'YOUR_AFTERBUG_API_KEY',
        ],
        // ...
        'errorHandler' => [
            'class' => 'AfterBug\AfterBugYii\Exceptions\ErrorHandler',
            'errorAction' => 'site/error',
        ],
    ]
];

排除异常

$config = [
    // ...
    'components' => [
        'afterbug' => [
            'class' => 'AfterBug\AfterBugYii\AfterBug',
            'apiKey' => 'YOUR_AFTERBUG_API_KEY',
            'excludeExceptions' => ['yii\web\NotFoundHttpException']
        ],
    ]
];

回调函数

设置回调以自定义数据。

$config = [
    // ...
    'components' => [
        'afterbug' => [
            'class' => 'AfterBug\AfterBugYii\AfterBug',
            'apiKey' => 'YOUR_AFTERBUG_API_KEY',
            'on beforeNotify' => function ($event) {
                $event->client->setMetaData([
                    'custom' => 'Your custom data',
                ]);
            }
        ],
    ]
];