nohnaimer/yii2-sentry

Yii2 logger for Sentry

2.0.0 2024-02-09 10:01 UTC

Requires

• php: ^7.2|^8.0
• sentry/sdk: 4.0.*
• yiisoft/yii2: ^2.0

Requires (Dev)

• codeception/codeception: ^4.0
• codeception/module-asserts: ^1.3
• codeception/module-yii2: ^1.1
• roave/security-advisories: dev-latest

MIT

• sentry
• yii2

README

Installation

composer require nohnaimer/yii2-sentry

Add target class in the application config:

return [
    'components' => [
        'sentry' => [
            'class' => 'nohnaimer\sentry\Component',
            'dsn' => 'http://2682ybvhbs347:[e-mail]/1',
            // Additional options for `Sentry\init`:
            'clientOptions' => [
                'release' => 'my-project-name@2.3.12',
                //Performance Monitoring
                'traces_sample_rate' => 1.0,
            ],
            //collect JavaScript errors, default false
            'jsNotifier' => true,
            //Collect javascript errors to different project
            'jsDsn' => 'http://[e-mail]/2',
            // Additional options for javascript `Sentry\init`:
            'jsClientOptions' => [
                'release' => 'my-project-name@2.3.12',
                //Performance Monitoring
                'integrations' => '[new Sentry.Integrations.BrowserTracing()]',
                'tracesSampleRate' => 0.2,
            ],
            // Write the context information (the default is true):
            'context' => true,
            //add Environment application
            'environment' => 'test',
        ],
        'log' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
                [
                    'class' => 'nohnaimer\sentry\Target',
                    'levels' => ['error', 'warning'],
                ],
            ],
        ],
    ],
];

Usage

Writing simple message:

\Yii::error('message', 'category');

Writing messages with extra data:

\Yii::warning([
    'msg' => 'message',
    'extra' => 'value',
], 'category');

Extra callback

extraCallback property can modify extra's data as callable function:

    'targets' => [
        [
            'class' => 'nohnaimer\sentry\Target',
            'levels' => ['error', 'warning'],
            'extraCallback' => function ($message, $extra) {
                // some manipulation with data
                $extra['some_data'] = \Yii::$app->someComponent->someMethod();
                return $extra;
            }
        ],
    ],

Tags

Writing messages with additional tags. If need to add additional tags for event, add tags key in message. Tags are various key/value pairs that get assigned to an event, and can later be used as a breakdown or quick access to finding related events.

Example:

\Yii::warning([
    'msg' => 'message',
    'extra' => 'value',
    'tags' => [
        'extraTagKey' => 'extraTagValue',
    ]
], 'category');

More about tags see https://docs.sentry.io/learn/context/#tagging-events

Additional context

You can add additional context (such as user information, fingerprint, etc) by calling \Sentry\configureScope() before logging. For example in main configuration on beforeAction event (real place will dependant on your project):

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([
                    // User ID and IP will be added by logger automatically
                    'username' => $identity->username,
                    'email' => $identity->email,
                ]);
            });
        }
    
        return $event->isValid;
    },
    // ...
];

Log levels

Yii2 log levels converts to Sentry levels:

\yii\log\Logger::LEVEL_ERROR => 'error',
\yii\log\Logger::LEVEL_WARNING => 'warning',
\yii\log\Logger::LEVEL_INFO => 'info',
\yii\log\Logger::LEVEL_TRACE => 'debug',
\yii\log\Logger::LEVEL_PROFILE_BEGIN => 'debug',
\yii\log\Logger::LEVEL_PROFILE_END => 'debug',