Chrome Extension Integration Guide

Typical installation time: 3 minutes

Hi there! You've found Honeybadger's guide to JavaScript error and exception tracking for your chrome extensions. Once installed, Honeybadger will automatically report errors from your chrome extension.

Installation

Download the minified version of honeybadger.js to your source code from Honeybadger's CDN (i.e. https://js.honeybadger.io/v5.1/honeybadger.min.js) and include it in your html files. Place the following code between the <head></head> tags of your page:

html

  

<!-- src should point to the honeybadger.min.js you downloaded -->
<script src="vendor/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.

See an example chrome extension + 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.

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:
5.1.7

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