README

这是为谁准备的？

这是为需要将他们的应用程序与Error Tracker集成的Yii2开发者准备的。此扩展使用Yii2日志组件将错误和警告直接发送到Error Tracker。

安装

使用composer安装此软件包。

composer require error-tracker/yii2-log-target

配置

要在您的应用程序中配置日志目标，请添加以下配置。每当服务器端发生错误时，这将像通常一样添加到文件日志中。此外，它还将被发送到错误跟踪仪表板，以便于搜索、警报和其他实用工具。

'log' => [
    'targets' => [
        [
            'class' => 'yii\log\FileTarget',
            'levels' => ['error', 'warning'],
        ],
        [
            'class' => 'ErrorTracker\Yii2\ErrorTrackerTarget',
            'levels' => ['error', 'warning'],
            'app_key' => 'YOUR_APP_KEY'
        ],
    ],
],

错误报告到Error Tracker时，它将保存一个参考。这是您的用户会话ID，也是您可以在文件日志中跟踪错误的ID，在那里您可以找到有关该错误更多信息的错误。

使用Yii2的日志功能

您可以使用Yii2的错误和警告方法将错误记录到Error Tracker，而无需抛出异常。这将仍然以相同的方式进行记录，并且如果您已配置日志目标，它将自动发送。以下代码将发送一个错误而不会抛出异常。

try {
    $this->willBreake();
} catch (\Exception $e) {
    Yii::error($e->getMessage(), $e->getName());
}

禁用

使用Yii2文档中记录的方法禁用您的日志目标。可选地，通过设置配置中的enabled属性来禁用目标。以下配置仅当您的应用程序处于生产环境时才启用记录器。

[
    'class' => 'ErrorTracker\Yii2\ErrorTrackerTarget',
    'levels' => ['error', 'warning'],
    'app_key' => 'YOUR_APP_KEY',
    'enabled' => YII_ENV_PROD,
],

贡献

设置

克隆存储库并运行composer install。然后开始编写代码！

测试

所有新功能都必须经过测试。测试使用phpunit进行，可以使用以下命令运行。

composer run-script test

编码标准

此库使用psr2编码标准和squizlabs/php_codesniffer进行linting。为此，有一个composer脚本

composer run-script lint

拉取请求

在创建带有更改的拉取请求之前，必须通过预提交脚本。可以按照以下方式运行

composer run-script pre-commit

鸣谢

此软件包由Practically.io创建和维护