README

Yii2 Sentry integration with log target support for error tracking and monitoring.

Important

Yii might look inactive, but it is still used a lot. This Sentry extension is actively supported, works with current PHP versions, and supports the latest Sentry SDK options.

Requirements

PHP >= 8.4
Yii2 >= 2.0
Sentry PHP SDK >= 4.9

Installation

Install via Composer:

composer require nadar/yii2-sentry

Configuration

Basic Configuration

Configure the Sentry component in your application config:

return [
    'components' => [
        'sentry' => [
            'class' => 'Nadar\Sentry\Sentry',
            'dsn' => 'YOUR_SENTRY_DSN',
        ],
    ],
];

Console Test Command (Optional)

For console applications, you can add the Sentry test command to verify your integration:

return [
    'controllerMap' => [
        'sentry-test' => [
            'class' => 'Nadar\Sentry\SentryTestCommand',
        ],
    ],
];

Then test your Sentry integration by running:

php yii sentry-test

This will send various test events to Sentry including exceptions, messages with different severity levels, log events, and events with custom context data. Check your Sentry dashboard to verify the events appear correctly.

Log Target Configuration

Add the Sentry log target to your log component:

return [
    'components' => [
        'log' => [
            'targets' => [
                [
                    'class' => 'Nadar\Sentry\SentryTarget',
                    'levels' => ['error', 'warning'],
                    'except' => [
                        'yii\web\HttpException:404',
                        'yii\web\HttpException:403',
                    ],
                    'logVars' => ['_GET', '_POST', '_SESSION', '_SERVER'],
                ],
            ],
        ],
    ],
];

Verifying Installation

After installing and configuring the package, you can verify that Sentry is working correctly:

Configure the Sentry component in your config/console.php (for console apps) or config/web.php (for web apps)
Add the test command to your console config (see Console Test Command section below)
Run the test command:
```
php yii sentry-test
```
Check your Sentry dashboard at https://sentry.io/ to see the test events

The test command will send multiple test events including exceptions, messages, and events with custom context to help you verify your integration is working correctly.

Configuration Options

Sentry Component Options

dsn (required): Your Sentry DSN (Data Source Name)
sampleRate: Sample rate for error events (0.0 to 1.0, default: 1.0)
tracesSampleRate: Sample rate for performance monitoring (0.0 to 1.0, default: 0.0)
sendDefaultPii: Whether to send default PII (Personally Identifiable Information)
maxBreadcrumbs: Maximum breadcrumbs (default: 100)
clientOptions: Additional client options for Sentry SDK
extraCallback: Global callback function to add extra data to all events (see below)

Log Target Options

sentry: The Sentry component ID (default: 'sentry')
levels: Array of log levels to capture (e.g., ['error', 'warning'])
except: Array of patterns to exclude from logging (e.g., ['yii\web\HttpException:404'])
logVars: Array of context variables to log (e.g., ['_GET', '_POST', '_SERVER'])

Usage

Manual Exception Capture

You can manually capture exceptions or messages:

try {
    // Your code
} catch (\Exception $e) {
    Yii::$app->sentry->captureException($e);
}

Manual Message Capture

Yii::$app->sentry->captureMessage('Something went wrong', 'error');

Using Yii2 Logger

The log target will automatically capture messages logged through Yii2's logger:

Yii::error('An error occurred');
Yii::warning('A warning message');

Extra Callbacks

Both the Sentry component and SentryTarget support extraCallback functions to add custom context data to events. When both callbacks are defined, they are merged together with the SentryTarget callback taking precedence.

Define a global extraCallback in the Sentry component to add context data to ALL events:

return [
    'components' => [
        'sentry' => [
            'class' => 'Nadar\Sentry\Sentry',
            'dsn' => 'YOUR_SENTRY_DSN',
            'extraCallback' => function () {
                return [
                    'server_id' => gethostname(),
                    'app_version' => '1.0.0',
                ];
            },
        ],
    ],
];

nadar / yii2-sentry

Maintainers

Details