Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
BugSense client for HTML5, PhoneGap and Windows 8 Javascript apps
JavaScript
branch: master
Failed to load latest commit information.
lib Merge with upstream
specs
src
.gitignore
.travis.yml
README.md
bower.json
gruntfile.js
package.json

README.md

BugSense JavaScript SDK Build Status

BugSense is the leading crash/quality reporting solution for Mobile developers. The bugsense.js libs brings this functionality to mobile web developers that develop mobile web apps, Phonegap apps and even Windows 8 Javascript apps.

Installation

Store the bugsense.js file along with you other Javascript files. Alternatively you can use the BugSense hosted version (see the following snippet). Then, instanciate the plugin with the API key from your project:

 <script src="http://www.bugsense.com/static/js/global/bugsense.js" type='text/javascript'></script>
 <script type="text/javascript">
    // You will find the API KEY in your BugSense Dashboard
    Bugsense.initAndStartSession({ apiKey: 'YOUR_API_KEY' });
 </script>

Downloads

Standard Builds

AMD/RequireJS Builds

Options

apiKey - API key for your BugSense project

default: {String} F00BAR

appVersion - This is the current version code of your application.

default: {String} null

appname - This is the name of your application.

default: {String} null

userIdentifier - This is a identifier for each user, eg. "example@gmail.com" or a username

default: {String} null

disableOnError - Disables the global error handler, in order to use bugsense only for handle exceptions with try {...} catch

default: {Boolean} false

silent - Disables logging any kind of information to browser's console, in order to behave better in production environments

default: {Boolean} false


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 breadcrumbs 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);

Run SDK specs

Terminal

In order the specs suites for bugsense.js, you should have node and npm install correctly. Then install dependencies, running the following command in the parent folder of this repo:

npm install

Also, you should have installed Grunt.js and PhantomJS.

In order to install globally Grunt.js run:

npm install -g grunt-cli

If you have problem installing PhantomsJS with npm install, visit their website and find the right package for you. If you're using Mac OS X, it's recommender to use Homebrew for installation: brew install phantomjs

When all dependencies are installed, run grunt specs in order to run the whole suite. If you're developing you can watch your file changes with grunt watch, which will then automatically run your specs.

Browser

You can also run the specs in your browser. Open the _SpecRunner.html in your favorite browser or run open _SpecRunner.html in your terminal.

Notes:

  • Older browser do not support the window.onerror callback and thefore 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, but it's heavily considered. If you have any ideas about this feature open issue or a pull request.
  • Bugsense.js uses CORS to send crash reports.
Something went wrong with that request. Please try again.