Browser Integration Guide

Typical installation time: 3 minutes

Hi there! You've found Honeybadger's guide to JavaScript error and exception tracking in browsers. Once installed, Honeybadger will automatically report errors from your client-side JavaScript application.

Installation

To use our hosted CDN, place the following code between the <head></head> tags of your page:

html

  

<script src="//js.honeybadger.io/v6.10/honeybadger.min.js" type="text/javascript"></script>

<script type="text/javascript">
  Honeybadger.configure({
    apiKey: 'Your project API key',
    environment: 'production',
    revision: 'git SHA/project version'
  });
</script>

Note: Errors that happen in development and test environments are not reported by default. To always report errors or to change the defaults, see Environments and Versions.

Here's a video walkthrough of a basic, global installation:

Installing via NPM/YARN

  
# npm
npm install @honeybadger-io/js --save

# yarn
yarn add @honeybadger-io/js

You can include honeybadger.js from the node_modules directory.

Bundling with ESM (esbuild), CommonJS (Browserify/Webpack), etc.

sh

  

// ES module
import Honeybadger from '@honeybadger-io/js';
// CommonJS
var Honeybadger = require("path/to/honeybadger");

Honeybadger.configure({
  apiKey: 'Your project API key',
  environment: 'production',
  revision: 'git SHA/project version'
});

See an example browserify + honeybadger.js project.
See an example webpack + honeybadger.js project.

RequireJS (AMD)

sh

  

requirejs(["path/to/honeybadger"], function(Honeybadger) {
  Honeybadger.configure({
    apiKey: 'Your project API key',
    environment: 'production',
    revision: 'git SHA/project version'
  });
});

See an example requirejs + honeybadger.js project.

Reporting Errors

By default Honeybadger will report all uncaught exceptions automatically using our window.onerror handler.

You can also manually notify Honeybadger of errors and other events in your application code:

javascript

  

try {
  // ...error producing code...
} catch(error) {
  Honeybadger.notify(error);
}

Identifying Users

Honeybadger can track what users have encountered each error. To identify the current user in error reports, add a user identifier and/or email address with Honeybadger.context:

javascript

  

Honeybadger.setContext({
  user_id: 123,
  user_email: 'user@example.com'
});

Tracking Deploys

Honeybadger can also keep track of application deployments, and link errors to the version which the error occurred in. Here's a simple curl script to record a deployment:

sh

  

HONEYBADGER_ENV="production" \
HONEYBADGER_REVISION="git SHA/project version" \
HONEYBADGER_API_KEY="Your project API key" \
  curl -g "https://api.honeybadger.io/v1/deploys?deploy[environment]=$HONEYBADGER_ENV&deploy[local_username]=$USER&deploy[revision]=$HONEYBADGER_REVISION&api_key=$HONEYBADGER_API_KEY"

Be sure that the same revision is also configured in the honeybadger.js library. Read more about deploy tracking in the API docs.

Tracking Deploys from Netlify

If you are deploying your site to Netlify, you can notify Honeybadger of deployments via Netlify's webhooks. Go to the Deploy notifications section of the Build & deploy tab for your site settings, and choose to add an Outgoing webhook notification. Choose Deploy succeeded as the event to listen for, and use this format for your URL:

https://api.honeybadger.io/v1/deploys/netlify?api_key=YOUR_HONEYBADGER_API_KEY_HERE

The environment that will be reported to Honeybadger defaults to the Netlify environment that was deployed, but you can override that with &environment=CUSTOM_ENV in the webhook URL, if you like.

Source Map Support

Honeybadger can automatically un-minify your code if you provide a source map along with your minified JavaScript files. See our Source Map Guide for details.

Collect User Feedback

When an error occurs, a form can be shown to gather feedback from your users. Read more about this feature here.

Package:
@honeybadger-io/js

Version:
6.10.1

Repository:
https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/js