Node.js

Configuration

To add the bugsplat package to your application, run the following shell command at the root of your project’s directory:

npm i bugsplat-node --save

Require bugsplat at the entry point of your application (usually main.js) by adding the following code snippet:

const { BugSplatNode } = require('bugsplat-node');

Create a new instance of the BugSplat class being sure to replace the database, application, and version with the correct values for your application:

const bugsplat = new BugSplatNode(database, application, version);

Set the bugsplat.post function as an event handler for uncaught exceptions:

process.on('uncaughtException', async (error) => await bugsplat.postAndExit(error));

You will also want to listen for unhandled promise rejections. Please note that this will only work for native promises:

process.on('unhandledRejection', async (error) => await bugsplat.postAndExit(error))

Throw an exception after the event handler has been added:

throw new Error('BugSplat!');

You can also use bugsplat-node to post errors from non-fatal promise rejections and errors that originate inside of try-catch blocks:

Promise.reject(new Error('BugSplat!')).catch(async (error) => await bugsplat.post(error, options));

try {
  throw new Error('BugSplat!');
} catch (error) {
  await bugsplat.post(error, options));
}

After posting an error with bugsplat-node, navigate to the Crashes page in BugSplat and you should see a new crash report for the application you just configured. Click the link in the ID column to see details about your crash on the Crash page:

Node.js Crashes

Node.js Crash

That’s it! Your application is now configured to post crash reports to BugSplat.

Source Maps

BugSplat has the ability to map uglified and minified JavaScript function names, file names, and line numbers back to their original values via source maps. For information on how to configure your application to upload source maps to BugSplat, please see the link below.

pageSource Maps

API

In addition to the configuration demonstrated above, there are a few public methods that can be used to customize your BugSplat integration:

bugsplat.setDefaultAppKey(appKey); // Additional metadata that can be queried via BugSplat's web application
bugsplat.setDefaultUser(user); // The name or id of your user
bugsplat.setDefaultEmail(email); // The email of your user 
bugsplat.setDefaultDescription(description); // A description placeholder that can be overridden at crash time
bugsplat.setDefaultAdditionalFilePaths([paths]); // Paths to files to be sent to BugSplat at post time (limit 1MB) 
bugsplat.postAndExit(error, options); // Wrapper for post that calls process.exit(1) after posting error to BugSplat
bugsplat.post(error, options); // Aysnc function that posts an arbitrary Error object to BugSplat
// If the values options.appKey, options.user, options.email, options.description, options.additionalFilePaths are set the corresponding default values will be overwritten
// Returns a promise that resolves with properties: error (if there was an error posting to BugSplat), response (the response from the BugSplat crash post API), and original (the error passed by bugsplat.post)
view rawbugsplat-node-api.js hosted with ❤ by GitHub

Additional Considerations

It is recommended that you exit and restart your application after an uncaughtException or unhandledRejection occurs. Packages such as pm2 and forever can be configured to restart your application.

Additionally you can use domains to handle errors differently across various parts of your application. Domains are pending deprecation according the the Node.js documentation, however a suitable replacement has not been added yet.

More information regarding domain deprecation can be found here.

Contributing

BugSplat loves open source software! Please check out our project on GitHub and send us a pull request.