README

Enables errors to be sent to Bugsnag

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

   cd /path/to/project

2. Then tell Composer to load the plugin:

   composer require pinfirestudios/craft3-bugsnag

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for craft3-bugsnag.

4. If you want to be able to capture early initialization errors, you need to add this plugin to your project's bootstrap configuration. To do this, in config/app.php, add:

   'bootstrap' => [
       '\pinfirestudios\craft3bugsnag\Bootstrap'
   ]
   

This will load the Bugsnag component and logging portion early in the project initialization, giving you the greatest visibility into errors. If you don't enable this, Bugsnag will be initialized when plugins are set up, later in the loading process.

Configuring craft3-bugsnag

You will need to provide your API key and optionally the release stage via the settings page or via config/env files. The recommended way however is to copy src/config.php to /APP_ROOT/config/craft3-bugsnag.php, then either edit it directly, or add BUGSNAG_API_KEY to your .env file. For the release stage, if not set directly, it will default to the CRAFT_ENVIRONMENT variable.

Using craft3-bugsnag

If things crash and this is enabled, visit your Bugsnag dashboard to see why.

Getting JavaScript errors

If you would like to use Bugsnag's JavaScript on your site, you'll need to install bower-asset/bugsnag:

1. Add the following to your project's composer.json

   "repositories": [
       {
           "type": "composer",
           "url": "https://asset-packagist.org"
       }
   ]
   

2. Require bower-asset/bugsnag

   composer require bower-asset/bugsnag

3. Once you have it installed, add BugsnagAsset to your TWIG file (or controller if working inside a plugin)

In TWIG:

{% do view.registerAssetBundle("\\pinfirestudios\\yii2bugsnag\\BugsnagAsset") %}

In a plugin asset:

class AppAsset extends AssetBundle
{
    public $depends = [
        'pinfirestudios\yii2bugsnag\BugsnagAsset',
    ];
}

If you need to use version 2 of Bugsnag's JavaScript, you can specify the version in your configuration. See Customizing Asset Bundles.