https://github.com/kredde/ember-error-tracker
Custom error and event tracking for Ember.js apps
https://github.com/kredde/ember-error-tracker
ember ember-addon ember-cli-addon error error-logging exception logging
Last synced: 5 months ago
JSON representation
Custom error and event tracking for Ember.js apps
- Host: GitHub
- URL: https://github.com/kredde/ember-error-tracker
- Owner: kredde
- License: mit
- Created: 2019-04-01T11:22:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T12:22:11.000Z (9 months ago)
- Last Synced: 2025-05-06T13:33:24.079Z (9 months ago)
- Topics: ember, ember-addon, ember-cli-addon, error, error-logging, exception, logging
- Language: JavaScript
- Homepage:
- Size: 8.06 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ember Error Tracker
[](https://nodei.co/npm/ember-error-tracker/)
[](https://travis-ci.org/kredde/ember-error-tracker)
[](https://codeclimate.com/github/kredde/ember-error-tracker/maintainability)
ember-error-tracker enables the handling and logging of uncaught errors. The error is logged along with a specified number of events that led to it and can be consumed either by the console or a custom api endpoint.
Compatibility
------------------------------------------------------------------------------
* Ember.js v2.18 or above
* Ember CLI v2.13 or above
Installation
------------------------------------------------------------------------------
```
ember install ember-error-tracker
```
Getting started
------------------------------------------------------------------------------
Add the configuration to your `config/environment.js`.
Example:
```javascript
'ember-error-tracker': {
maxLogStackSize: 10, // the number of events to track
listeners: {
ember: {
rsvp: true,
ember: true,
actions: true,
},
window: true,
},
events: ['click', 'input', 'scroll'], // you can add any js events
consumers: {
console: true,
api: { // set to false if you just want to use it locally
endPoint: 'http://your.api/log'
key: 'SUPERSECRETKEY'
},
}
}
```
Enable babel source-maps in your `ember-cli-build.js` if you want to find out the original position of the
error.
You might only want to enable this in production since it affects building time and can slow down your
hot reload times.
```javascript
'use strict';
const EmberApp = require('ember-cli/lib/broccoli/ember-app');
module.exports = function (defaults) {
let app = new EmberApp(defaults, {
babel: {
sourceMaps: 'inline'
},
sourcemaps: {
enabled: true,
extensions: ['js']
}
});
}
```
API endpoint payload
------------------------------------------------------------------------------
The payload that is sent to your custom API endpoint will look like this (depending on your configuration).
```javascript
const payload =
{
error: {
source: String, // error source e.g.: 'ember', 'window' etc.
timestamp: Number,
error: {
message: String,
stack: String // stracktrace that can be parsed (https://www.npmjs.com/package/stacktrace-parser)
}
},
events: [{
type: String,
timestamp: Number,
location: String, // the path on which the error occured e.g.: '/'
target: {
selector: String,
text: String // the text inside the selector
}
}],
userAgent: String, // can be parsed (https://www.npmjs.com/package/bowser)
screen: {
resolution: {
width: Number,
height: Number
},
viewPort: {
width: Number,
height: Number.
}
}
}
```
Source maps to find original error position
------------------------------------------------------------------------------
To get the original position of the error in the source code you can use
[mozilla/source-maps](https://github.com/mozilla/source-map). The location
of the source map in a production build can be found at the end of the minified
js file.
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.
License
------------------------------------------------------------------------------
This project is licensed under the [MIT License](LICENSE.md).