Skip to content

Latest commit

 

History

History
134 lines (95 loc) · 3.83 KB

README.md

File metadata and controls

134 lines (95 loc) · 3.83 KB
Raw

Ember CLI Raygun

Build Status Ember Observer Score

This addon will allow you to report errors to Raygun from your Ember CLI app using raygun4js.

❤️ Please open an issue if you run into any troubles!

CLI installation

$ ember install ember-cli-raygun --api_key='paste_your_api_key_here'

Alternatively, you can set your API key manually by starting with:

$ ember install ember-cli-raygun

Next, set your API key in config/environment.js:

var ENV = {
  // ...
  raygun: {
    apiKey:  "paste_your_api_key_here",
    enableCrashReporting: (environment === "production")
  }
  // ...

The default blueprint (which runs during ember install ember-cli-raygun) will add the above config in your app's config/environment.js file.

Release

Raygun will now track errors in your deployed application. By default, Ember CLI Raygun is disabled unless your environment is set to "production". You can configure this behavior in config/environment.js.

Additional Configruation

CORS

ember-cli-raygun will automatically inject the raygun4js bootstrap script into the head of your Ember app. This is the most reliable way to catch errors (even during app initialization).

If you’re using CORS without unsafe-inline, you’ll need to add the following directives to ensure rg4js and Raygun load correctly:

Accessing Raygun

Functions you might need on rg4js are exposed as an Ember Service, for instance tracking custom events:

import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class IndexRoute extends Route {
  @service raygun;

  beforeModel() {
    this.raygun.trackEvent({
      type: 'customTiming',
      name: 'IndexRouteBeforeModel',
      duration: 1200
    })
  }
}

User Tracking

Check out the Customers section in the raygun4js documentation for full details.

Add the following snippet into your application route in app/routes/application.js:

// ...
  @service user;
  @service raygun;

  beforeModel: () {
    this.setRaygunUser();
  },

  setRaygunUser: () {
    this.raygun.setUser({
      identifier: this.get("user.id"),
      isAnonymous: false,
      email: this.get("user.email"),
      firstName: this.get("user.firstName"),
      fullName: this.get("user.fullName")
    });    
  },
// ...

Thanks! ❤️

Thanks to:

For your contributions on the previous version of this addon :)

Contributing

Pull requests are welcome!

  • git clone this repository
  • npm install

Running tests

  • ember test OR
  • ember test --server

There’s a detailed test harness in the dummy app so please check that your changes work end-to-end by running that.