Skip to content

IcarusWorks/ember-cli-bugsnag

 
 

Repository files navigation

Ember-cli-bugsnag

Build Status

Installation

Install the addon:

ember install ember-cli-bugsnag

Configuration

There are two ways to configure ember-cli-bugsnag:

  • Add POJO to config/environment:
{
  bugsnag: {
    apiKey: '',
    notifyReleaseStages: ['development', 'production']
  }
}

The releaseStage defaults to the current application environment, if you need to set a different releaseStage that diverges from the environment, you can pass and additional attribute to the bugsnag configuration called releaseStage. It would look like this:

{
  bugsnag: {
    apiKey: '',
    notifyReleaseStages: ['development', 'production', 'staging'],
    releaseStage: 'staging'
  }
}
  • Specify environment variables:
export BUGSNAG_API_KEY=''
export BUGSNAG_NOTIFY_RELEASE='development,production'

Configuration options:

  • config.bugsnag.apiKey / BUGSNAG_API_KEY -- required
  • config.bugsnag.notifyReleaseStages / BUGSNAG_NOTIFY_RELEASE -- optional, defaults to [] (never notify)
  • config.bugsnag.releaseStage / BUGSNAG_RELEASE_STAGE -- optional, defaults to config.environment
  • config.bugsnag.endpoint / BUGSNAG_ENDPOINT -- optional, defaults to what the libraryUrl uses
  • config.currentRevision -- any string representing the current version of the app, e.g. "1b8ef2c7" or "v1.2.4", optional. ember-git-version provides this automatically.

Customization

In order to add custom meta data to errors reported to Bugsnag, define a helper method in app/utils/bugsnag.js that takes the error and the container as arguments, e.g.:

export function getMetaData(error, container) {
  return {
    // …some meta data
  };
}

ember-cli-bugsnag calls this method for every error and resports any data returned by it to Bugsnag as meta data for the respective error. The returned metaData should be formatted to correspond with tabs in your interface. E.g. for an account tab

return {
  account: {
    name: "Bugsnag",
    plan: "premium",
    beta_access: true
  }
};

See the Bugsnag docs for more information.

About

Integrates Bugsnag reporting service into your Ember CLI app.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.0%
  • HTML 11.0%