Skip to content

html5.md

Latest commit

 

History

History
119 lines (92 loc) · 3.48 KB

html5.md

File metadata and controls

119 lines (92 loc) · 3.48 KB

HTML5

Using the Javascript library

Download the bugsense-.js (Release Notes) file (or download one of our builds) and store in it along with your other Javascript files.

You can also use Bower to install BugSense in your project.

bower install bugsense

or add it in your bower.json file

{
  "name": "my-project",
  "version": "1.0.0",
  "main": "path/to/main.css",
  "ignore": [
    ".jshintrc",
    "**/*.txt"
  ],
  "dependencies": {
    "bugsense": "2.0.1",
  }
}

Alternatively you can use the BugSense hosted version (see the following Gist).

Include the script in your HTML page and initialize it.

<script src="/path/to/bugsense.js" type='text/javascript'></script>
<script type="text/javascript">
  Bugsense.initAndStartSession({ apiKey: 'YOUR_API_KEY' });
</script>

Downloads

Standard Builds

AMD/RequireJS Builds

For more initialization options, read our API docs.

Older mobile browsers do not support the window.onerror callback and therefore the plugin will not receive any uncaught exception.

When there's only the Error object caught, error.stack will be parsed to get the url and line number.

Deobfuscation or retracing for minified and/or obfuscated Javascript files is not supported yet.

Bugsense.js uses CORS to send crash reports.

Registering handled exceptions

Bugsense.js allows you to register handled exception as well and append metadata to the crash report.

try {
   rotateScreen();
} catch ( error ) {
   Bugsense.notify( error, { rotation: 'not supported' } );
};

ExtraData & Breadcrumbs

You can add extraData to the BugSense crash reports as well as breacrumbs to help you debug your app faster!

Managing extraData

In order to add extra data in your instace, you can use the Bugsense.addExtraData function.

/* add metadata */
Bugsense.addExtraData( 'user_level', 'paid' );
Bugsense.addExtraData( 'account', 'CEO' );

If you want to remove extra data, you can use the Bugsense.removeExtraData and passing the key as a parameter.

/* Removing metadata by key */
Bugsense.removeExtraData('user_level');

Or you can clear all metadata by using Bugsense.clearExtraData.

/* Clear all metadata */
Bugsense.clearExtraData();

Managing Breadcrumbs

By adding breadcrumbs to your code you can easily see the trail the user followed before getting the crash. Just leave a breadcrumb by using Bugsense.leaveBreadcrumb.

/* leave breadcrumb */
Bugsense.leaveBreadcrumb( 'Fetch Friendlist' );

Also, you can also clear all breadcrumbs

/* clear breadcrumbs */
Bugsense.clearBreadcrumbs();

Registering events

Bugsense.js provides an easy way for developers to use events in order to handle crashes more effectively.

function ooops() {
  alert('Ooops! Our app just crashed. Please send us an email at support@example.com');
}
Bugsense.on("crash", ooops);

When this is done, you can unregister the event to avoid spamming your users with countless alerts of notifications.

Bugsense.off("crash", ooops);