README

为 Yii2 提供的 Airbrake 集成，它封装了官方的 Airbrake PHP 库（airbrake/phpbrake）。

安装

composer require biller/yii2-airbrake

用法

虽然不是显式要求的，但建议将 AirbrakeService 配置为环境（或甚至公共）配置中的一个组件，以便在整个应用程序中轻松访问（例如使用 Yii::$app->get('airbrakeService')）。

return [
    // ...
    'components' => [
        // ...
        'airbrakeService' => [
            'class' => biller\phpbrake\AirbrakeService::class,

            'enabled' => true, // default TRUE

            'projectId' => 'YOUR_PROJECT_ID',
            'projectKey' => 'YOUR_PROJECT_KEY',

            'environment' => YII_ENV, // default NULL
            'appVersion' => [your-app-version], // default NULL
            'rootDirectory' => [source-root-directory], // default NULL
            'host' => [api-endpoint-host], // default "api.airbrake.io"
            'httpClient' => [http-client-type], // default "default"

            'setGlobalInstance' => [boolean], // default TRUE
            'setErrorHandler' => [boolean], // default FALSE

            'filters' => [ // default NULL
                // 'PHPSESSID' and '_csrf' parameters should not be transferred to airbrake
                [
                    'class' => biller\phpbrake\ParamsFilter::class,
                    'params' => ['PHPSESSID', '_csrf'],
                ],
            ],
        ],
    ],
];

带有星号的配置选项是必需的，所有其他选项都是可选的。

• rootDirectory：应设置为您的源根目录，以便缩短文件路径
• httpClient：指定要使用的 HTTP 客户端类型，可以配置为
  • AirbrakeService::CLIENT_DEFAULT
  • AirbrakeService::CLIENT_GUZZLE
  • AirbrakeService::CLIENT_CURL
• setGlobalInstance：如果设置为 true，则当前实例将被设置为全局实例
• setErrorHandler：如果设置为 true，则当前实例将被设置为 PHP 运行时未处理的异常处理器
• filters：提供通知预处理的可调用数组

有关 API 的更多信息，请参阅官方 Airbrake PHP 库文档。

AirbrakeFilterFactory

一个可以用来创建各种过滤规则的工厂类。

AirbrakeFilterFactory::createParamsFilter(array $params, $replacement = 'FILTERED')

此方法将创建一个过滤可调用函数，该函数过滤由 $params 指定的参数，并用指定的 $replacement 替换它。示例用法见上面。

控制台支持

可以将集成添加到 Yii 控制台，其中它目前提供了一个用于跟踪部署的命令（Airbrake API 4 中的新功能，允许用部署标记错误时间线）。

用法

要使用 ConsoleController，应将 AirbrakeService 配置为组件。

import enscope\Yii2\Ext\Airbrake\ConsoleController;

return [
    // ...
    'controllerMap' => [
        // ...
        'airbrake' => [
            'class' => ConsoleController::class,
            'airbrakeService' => [component-name], // default "airbrakeService"
        ],
    ],
];

虽然参数可以在配置中硬编码，但控制台控制器支持通过命令行参数设置 inferParameters、username、revision 和 repository 参数。

• airbrakeService：组件名称或初始化的实例
• inferParameters：如果为 TRUE，则通过 exec() 调用发现 repository 和 revision
• revision：修订标识符，如果启用推断，则通过 git rev-parse HEAD 发现
• repository：仓库标识符，如果启用推断，则通过 git remote get-url origin 发现
• username：跟踪部署的用户名称（默认 "system"）

日志目标

您可以配置 Yii2 日志记录器，以便自动将错误记录到 Airbrake 服务。

用法

要使用 ConsoleController，应将 AirbrakeService 配置为组件。

return [
    'components' => [
        'log' => [
            'targets' => [
                [
                    'class' => biller\phpbrake\AirbrakeTarget::class,
                    'levels' => ['error'],
                ],
            ],
        ],
    ],
];

该目标当前不公开任何其他配置选项，除了由 yii\log\Target 公开的选项之外，还有服务组件。

• airbrakeService：组件名称或初始化的实例

许可证

Yii2 Airbrake 集成采用 MIT 许可证（MIT） 许可，原始 PHP Airbrake 库也是如此，并遵循该库的版本。