mito/yii2-sentry

Yii 2 extension for Sentry

Installs: 80 582

Dependents: 8

Suggesters: 0

Stars: 73

Watchers: 12

Forks: 24

Open Issues: 7

Type:yii2-extension

1.0.4 2017-11-28 16:52 UTC

README

Sentry provides real-time crash reporting for web apps, both server and client side. This is a Yii 2 extension which lets you integrate your projects to Sentry and log PHP and JavaScript errors.

Brought to you by Mito.

Latest Stable Version Total Downloads License

Build Status Coverage Status

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist mito/yii2-sentry "~1.0.0"

or add the following line to the require section of your composer.json file:

"mito/yii2-sentry": "~1.0.0"

Requirements

Yii 2 and above. Sentry 8 and above.

You can use this extension with both the hosted and on-premise version of Sentry.

Usage

Once the extension is installed, set your configuration in common config file:

    'components' => [

        'sentry' => [
            'class' => 'mito\sentry\Component',
            'dsn' => 'YOUR-PRIVATE-DSN', // private DSN
            'environment' => 'staging', // if not set, the default is `production`
            'jsNotifier' => true, // to collect JS errors. Default value is `false`
            'jsOptions' => [ // raven-js config parameter
                'whitelistUrls' => [ // collect JS errors from these urls
                    'http://staging.my-product.com',
                    'https://my-product.com',
                ],
            ],
        ],
        'log' => [
            'targets' => [
                [
                    'class' => 'mito\sentry\Target',
                    'levels' => ['error', 'warning'],
                    'except' => [
                        'yii\web\HttpException:404',
                    ],
                ],
            ],
        ],

    ],

To skip collecting errors in the development environment, disable the component with this parameter:

    'components' => [
        'sentry' => [
            'enabled' => false,
        ],
    ],

License

Code released under MIT License.

Contact

Should you have any comments or questions, please contact us at info@mito.hu.