如何高效捕获并追踪Yii2应用中的错误和异常？notamedia/yii2-sentry助你实现实时错误监控

notamedia/yii2-sentry

<pre class="brush:php;toolbar:false;">composer require notamedia/yii2-sentry

config/web.php

config/main.php

components

log

SentryTarget

<pre class="brush:php;toolbar:false;">return [
    'components' => [
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0, // 生产环境建议设置为0
            'targets' => [
                [
                    'class' => 'notamedia\sentry\SentryTarget',
                    // 替换为你的Sentry DSN，这是连接Sentry服务的关键
                    'dsn' => 'http://2682ybvhbs347:235vvgy465346@sentry.io/1',
                    // 定义需要发送到Sentry的日志级别，例如错误和警告
                    'levels' => ['error', 'warning'],
                    // 是否写入上下文信息，默认为true，强烈建议开启
                    'context' => true,
                    // Sentry SDK的额外选项，例如指定应用版本，方便追踪
                    'clientOptions' => ['release' => 'my-project-name@2.3.12']
                ],
            ],
        ],
    ],
];

dsn

release

notamedia/yii2-sentry

levels

<pre class="brush:php;toolbar:false;">// 记录一个错误信息
\Yii::error('数据库连接失败，请检查配置！', 'database-error');

// 记录一个警告信息，并附带额外数据
\Yii::warning([
    'msg' => '用户尝试访问未授权资源',
    'userId' => \Yii::$app->user->id ?? 'guest',
    'ip' => \Yii::$app->request->userIP,
], 'security-warning');

notamedia/yii2-sentry

extraCallback

<pre class="brush:php;toolbar:false;">    'targets' => [
        [
            'class' => 'notamedia\sentry\SentryTarget',
            // ... 其他配置 ...
            'extraCallback' => function ($message, $extra) {
                // 假设你需要获取当前登录用户的角色信息
                if (\Yii::$app->has('user') && !\Yii::$app->user->isGuest) {
                    $extra['user_role'] = \Yii::$app->user->identity->role;
                }
                // 还可以添加其他任何你觉得有用的上下文数据
                $extra['server_env'] = YII_ENV;
                return $extra;
            }
        ],
    ],

extraCallback

<pre class="brush:php;toolbar:false;">\Yii::warning([
    'msg' => '支付模块回调失败',
    'order_id' => '20230815123456',
    'tags' => [
        'module' => 'payment', // 添加一个模块标签
        'payment_gateway' => 'alipay', // 添加支付网关标签
    ]
], 'payment-callback-error');

configureScope()

beforeAction

<pre class="brush:php;toolbar:false;">return [
    // ...
    'on beforeAction' => function (\yii\base\ActionEvent $event) {
        /** @var \yii\web\User $user */
        $user = Yii::$app->has('user', true) ? Yii::$app->get('user', false) : null;
        if ($user && ($identity = $user->getIdentity(false))) {
            \Sentry\configureScope(function (\Sentry\State\Scope $scope) use ($identity) {
                $scope->setUser([
                    // 用户ID和IP通常由Logger自动添加，这里可以补充更多信息
                    'id' => $identity->getId(), // 确保Sentry能识别到用户ID
                    'username' => $identity->username,
                    'email' => $identity->email,
                ]);
                // 还可以设置自定义上下文，例如用户的组织、订阅类型等
                $scope->setContext('organization', [
                    'name' => 'MyCompany',
                    'plan' => 'Premium',
                ]);
            });
        }

        return $event->isValid;
    },
    // ...
];

notamedia/yii2-sentry

notamedia/yii2-sentry