honeybadger-js
Advanced tools
A JavaScript library for integrating apps with the Honeybadger Rails Error Notifier.
A client-side JavaScript library for integrating apps with the :zap: Honeybadger Error Notifier. For server-side javascript, check out our NodeJS library.
Place the following code between the <head></head> tags of your page:
<script src="//js.honeybadger.io/v0.4/honeybadger.min.js" type="text/javascript" data-apiKey="project api key" data-environment="production"></script>
Honeybadger may also be configured via JavaScript:
<script type="text/javascript">
Honeybadger.configure({
apiKey: 'project api key',
environment: 'production'
});
</script>
Here's a video walkthrough of a basic, global installation:
npm install honeybadger-js --save
bower install honeybadger --save
var Honeybadger = require("path/to/honeybadger");
Honeybadger.configure({
apiKey: 'project api key',
environment: 'production'
});
requirejs(["path/to/honeybadger"], function(Honeybadger) {
Honeybadger.configure({
apiKey: 'project api key',
environment: 'production'
});
});
Note: First, make sure you use bundler >= 1.8.4.
Add the following to your Gemfile:
source 'https://rails-assets.org' do
gem 'rails-assets-honeybadger'
end
Add the following to application.js:
//= require honeybadger
Honeybadger.configure({
apiKey: 'project api key',
environment: 'production'
});
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:
try {
// ...error producing code...
} catch(error) {
Honeybadger.notify(error);
}
See the full documentation for the notify method for more examples.
You can set configuration options by using the Honeybadger.configure function. All of the available options are shown below:
Honeybadger.configure({
// Output Honeybadger debug messages to the console
debug: false,
// Honeybadger API key (required)
apiKey: '',
// Collector Host
host: 'api.honeybadger.io',
// Use SSL?
ssl: true,
// Project root
projectRoot: 'http://my-app.com',
// Environment
environment: 'production',
// Component (optional)
component: '',
// Action (optional)
action: '',
// Should unhandled (window.onerror) notifications be sent?
onerror: true,
// Disable notifications?
disabled: false,
// Send notifications asynchronously
async: true
});
You can call Honeybadger.configure as many times as you like. The existing configuration data will be merged with any new data you provide. This is especially useful for changing the action and component values inside of single-page apps.
The global Honeybadger instance may also be configured via data attributes on the script tag which loads honeybadger.js:
<script src="honeybadger.js" type="text/javascript" data-component="pages" data-action="index" ...></script>
Honeybadger.notify(): Send an exception to HoneybadgerIf you've caught an exception and want to send it to Honeybadger, this is the method for you.
try {
// ...error producing code...
} catch(error) {
Honeybadger.notify(error);
}
JavaScript often uses generic class names -- such as Error -- which are uninformative and also cause unrelated errors to be grouped together. To get around this issue it's a good practice to send a custom error class when notifying Honeybadger:
Honeybadger.notify(error, 'DescriptiveClass');
You can also set or override other optional data which is reported with the error:
Honeybadger.notify(error, {
message: 'My custom message',
name: 'DescriptiveClass',
component: 'badgers',
action: 'show',
context: { badgerId: 1 },
fingerprint: 'This unique string will group similar errors together',
environment: 'production',
projectRoot: 'https://www.example.com/',
params: { key: 'value' },
cookies: { key: 'value' } // May also be sent as a string in the document.cookie "foo=bar;bar=baz" format.
});
Finally, you can notify Honeybadger of anything, even if you don't have an error object:
Honeybadger.notify('Badgers!');
Honeybadger.notify('Badgers!', { ... });
Honeybadger.notify('Badgers!', 'CustomClass');
Honeybadger.notify('Badgers!', 'CustomClass', { ... });
Honeybadger.notify({
message: 'Badgers!',
name: 'CustomClass',
...
});
A stacktrace will be generated for you (when possible) if you do not provide an error object.
Honeybadger.wrap(): Wrap the given function in try/catch and report any exceptionsIt can be a pain to include try/catch blocks everywhere in your app. A slightly nicer option is to use Honeybadger.wrap. You pass it a function. It returns a new function which wraps your existing function in a try/catch block.
Honeybadger.wrap(function(){
throw "oops";
})();
Note that wrap returns a function. This makes it easy to use with event handlers, as in the example below:
$(document).on("click", "#myElement", Honeybadger.wrap(function(){ throw "oops"; }));
Honeybadger.setContext(): Set metadata to be sent if an exception occursJavascript exceptions are pretty bare-bones. You probably have some additional data that could make them a lot easier to understand - perhaps the name of the current Angular view, or the id of the current user. This function lets you set context data that will be sent if an error should occur.
You can call setContext as many times as you like. New context data will be merged with the existing data.
// On load
Honeybadger.setContext({
user_id: 123
});
// Later
Honeybadger.setContext({
backbone_view: 'tracks'
});
// The context now contains { user_id: 123, backbone_view: 'tracks' }
Honeybadger.resetContext(): Clear context metadataIf you've used Honeybadger.setContext to store context data, you can clear it with Honeybadger.resetContext.
// Set the context to {}
Honeybadger.resetContext();
// Clear the context, then set it to `{ user_id: 123 }`
Honeybadger.resetContext({
user_id: 123
});
Honeybadger.beforeNotify(): Add a callback to be run before an exception is reportedPassing a function to Honeybadger.beforeNotify will add the function
to a list of before notify handlers. If the function includes a
parameter, the Notice object will be passed as an argument. Multiple
handlers may be added in this fashion:
Honeybadger.beforeNotify(function(notice) {
notice.message = 'My custom message';
});
// To halt notification, return false from any `beforeNotify` handler:
Honeybadger.beforeNotify(function(notice) {
if (notice.class == 'MyCustomError') return false;
});
The following notice attributes may be modified by your notification handlers:
Honeybadger.configure(): Set configuration valuesThe configure method takes an object containing config values. Its return value is unspecified.
Honeybadger.configure({apiKey: "adlkjfljk"});
Honeybadger.factory(): create a new client instance.The factory method returns a new instance of Honeybadger which can be configured differently than the global/singleton instance.
var other_hb = Honeybadger.factory({apiKey: "zxcvbnm"});
other_hb.notify("This will go to an alternate project.");
Honeybadger can automatically un-minify your code if you provide a sourcemap along with your minified JavaScript files.
To do this, you'll add a special comment at the bottom of your minified JS. It tells us where to find your sourcemap. For example:
// ...minified code...
//# sourceMappingURL=application.min.js.map
The sourcemap URL needs to be a valid URL accessible to the public.
For more information on sourcemaps, check out the Source Map Revision 3 Proposal.
If you'd like to be able to jump from the Honeybadger backtrace to your unminified source file, just tell us where to find your unminified files using the sourceRoot option.
sourceRoot is the root URL for your unminified source files. To set it, you can use another magic comment:
// ...minified code...
//# sourceRoot=https://sources.my-domain.com/src
This option may also be specified as a top-level key in the JSON sourcemap file itself:
{
"sourceRoot" : "https://sources.my-domain.com/src",
// ...sourcemap...
}
If providing the sourceRoot option fouls up other tools in your toolchain, you can alternatively use honeybadgerSourceRoot.
If you're using Honeybadger's GitHub integration, you can link to source files on GitHub by substituting a special [PROJECT_ROOT] token for the root of your GitHub repository:
// ...minified code...
//# sourceMappingURL=honeybadger.min.js.map
//# honeybadgerSourceRoot=[PROJECT_ROOT]/src
This is the only situation in which the source root is not required to be a valid URL.
Requests sent from Honeybadger servers to download sourcemaps and related-files include a secret token in the Honeybadger-Token header, which may be used to authenticate requests from Honeybadger.
To find your Honeybadger-Token token, visit your project settings page in Honeybadger and click on the "Sourcemaps" tab.
One exception is direct links from the Honeybadger UI (such as when displaying links in backtraces); these cannot be authenticated.
To automatically send cookies with all error reports, use the following ::beforeNotify handler:
Honeybadger.beforeNotify(function(err){
err.cookies = document.cookie;
return true;
})
Honeybadger.js automatically reports uncaught exceptions from window.onerror. To
disable notifications for uncaught exceptions, set the onerror option to
false.
Honeybadger.configure({
apiKey: 'project api key',
onerror: false
});
git checkout -b my_branchgit commit -am "Boom"git push origin my_branchTo run the test suite, enter make test into the console.
The Honeybadger gem is MIT licensed. See the MIT-LICENSE file in this repository for details.
FAQs
A JavaScript library for integrating apps with the Honeybadger Rails Error Notifier.
The npm package honeybadger-js receives a total of 15,262 weekly downloads. As such, honeybadger-js popularity was classified as popular.
We found that honeybadger-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.