README

Honeybadger integration for Yii2, Honeybadger Error Logger.

Installation

composer require xinningsu/yii2-honeybadger

Usage

Once you have finished the Honeybadger installation, set up Honeybadger component and Honeybadger log target in Yii common config file, e.g., config/web.php:

[
    // ...
    'components' => [
        // ...
        // Honeybadger component
        'honeybadger' => [
            'class'  => \Sulao\YiiHoneybadger\Component::class,
            'config' => [
                'api_key'     => 'your_honeybadger_api_key', // Update with your Honeybadger API key
                'report_data' => true,
                // ...
                // For more configuration options, please refer to 
                // https://github.com/xinningsu/yii2-honeybadger/blob/master/config/honeybadger.php
                // https://docs.honeybadger.io/lib/php/reference/configuration/#default-configuration
            ],
        ],
        'log' => [
            // ...
            // Honeybadger log target
            'targets' => [
                // ...
                [
                    'class'  => \Sulao\YiiHoneybadger\Target::class,
                    'levels' => ['error', 'warning'],
                ],
            ],
        ],
        // ...
    ],
    // ...
],

Testing

In the controller file, add the code below

\Yii::error('test error');

Or trigger an exception In the controller

throw new \Exception('test exception');

To manually send reports, you can refer to the code below:

\Yii::$app->honeybadger->notify(new \Exception('test exception'));
\Yii::$app->honeybadger->customNotification([
    'title'   => 'Special Error',
    'message' => 'Special Error: a special error has occurred',
]);

Then, check if the report is available in the Honeybadger.

License

MIT