websupport/yii-sentry

Layer for Yii framework for communication with Sentry logging API

dev-master / 0.x-dev 2023-03-21 10:34 UTC

Requires

• php: >=7.1
• guzzlehttp/psr7: ^1.6 || ^2.0
• php-http/curl-client: ^2.0
• sentry/sdk: ^3.1
• yiisoft/yii: ^1.1.18

Requires (Dev)

• roave/security-advisories: dev-latest

Conflicts

• yiisoft/yii2: *

BSD-3-Clause

• log
• sentry
• yii
• Yii1

README

Logging Extension for Yii framework for communication with Sentry logging API

Installation

Yii Sentry is composer library so you can install the latest version with:

composer require websupport/yii-sentry

Configuration

Add following to your application's config:

PHP error reporting

'components' => [
    'log' => [
        'class' => \CLogRouter::class,
        'routes' => [
            // your other log routers
            array(
                'class' => \Websupport\YiiSentry\LogRoute::class,
                'levels' => E_ALL,
                'enabled' => !YII_DEBUG,
            ],
        ],
    ],
    'sentry' => [
        'class' => \Websupport\YiiSentry\Client::class,
        'dsn' => '', // Your's DSN from Sentry
    ],
)

JS error reporting

'preload' => ['sentry'],
'components' => [
    'sentry' => [
        'class' => \Websupport\YiiSentry\Client::class,
        'jsDsn' => '', // Your's DSN from Sentry
    ],
]

Sending user context to JS

\Websupport\YiiSentry\Client component has public method: setJsUserContext($context) which will send $context to Raven JS instance. You can call this method multiple times from any part of the system. Recommended way however is to use it in CWebUser class right after init.