Add BugSnag to your Koa projects to automatically capture and report errors in production.
New to BugSnag? Create an account
Looking for performance monitoring? See our performance guide
Install BugSnag and the BugSnag / Koa integration from the npm registry using npm or yarn:
npm install --save @bugsnag/js @bugsnag/plugin-koa
# or
yarn add @bugsnag/js @bugsnag/plugin-koa
The latest available version of @bugsnag/js is v8.1.3.
This documentation is for version 7+ of the BugSnag JavaScript notifier. If you are using older versions, we recommend upgrading to the latest release using our Upgrade guide. Documentation for the previous release can be found on our legacy pages.
Depending on which module system you are using, you’ll need to include BugSnag in one of the following ways:
// commonjs/node-style require
const Bugsnag = require('@bugsnag/js')
const BugsnagPluginKoa = require('@bugsnag/plugin-koa')
// ES module-style import
import Bugsnag from '@bugsnag/js'
import BugsnagPluginKoa from '@bugsnag/plugin-koa'
To start BugSnag with the Koa integration, import it and pass it along with your API key to Bugsnag.start as configuration:
Bugsnag.start({
apiKey: 'YOUR_API_KEY',
plugins: [BugsnagPluginKoa],
otherOptions: value
})
You can find your API key in Project Settings from your BugSnag dashboard.
Finally, in the part of your application where the Koa server is configured, obtain and use the Koa middleware:
const app = new Koa()
const middleware = Bugsnag.getPlugin('koa')
// This must be the first piece of middleware in the stack.
// It can only capture errors in downstream middleware
app.use(middleware.requestHandler)
/* all other middleware and application routes go here */
// This handles any errors that Koa catches
app.on('error', middleware.errorHandler)
For information on values that can be set in the configuration object, see configuration options.
Type definitions are provided and will be picked up automatically by the TypeScript compiler when you import any of the top-level @bugsnag/* packages.
Our package uses some TypeScript features that are only available in TypeScript 4.5 and above. If you are using an older version of TypeScript, you may need to disable type-checking for the @bugsnag/* packages. To do so, please follow this guide.
@bugsnag/js can be used in AWS Lambda functions using the @bugsnag/plugin-aws-lambda package.
See AWS Lambda for integration instructions.
Source maps enable BugSnag to show you the original file, line, method and surrounding code in your stacktraces.
See the build integrations guide to find out how to upload source maps to BugSnag.
After completing installation and basic configuration, unhandled exceptions and unhandled promise rejections will be reported and automatically appear on your BugSnag dashboard.
Unhandled errors in Koa routes will be reported with information about the request.
Sometimes it is useful to manually notify BugSnag of a problem. To do this, call Bugsnag.notify(). For example:
try {
something.risky()
} catch (e) {
Bugsnag.notify(e)
}
When reporting handled errors, it’s often helpful to send custom diagnostic data or to adjust the severity of particular errors. For more information, see reporting handled errors.
As well as capturing and reporting unhandled errors, the requestHandler middleware enables subsequent middleware to execute with a request-scoped BugSnag client. This means that if you encounter an error in route or piece of middleware, you can call Bugsnag.notify(err) which will include information about the request in the error report. For example:
app.use(async (ctx, next) => {
const product = await db.products.find(ctx.request.query.productId)
if (product.discontinued) {
// This report will include detail about the request, plus anything we attach here
Bugsnag.notify(
new Error('Attempted to purchase discontinued product'),
function (event) {
event.addMetadata('product', product)
}
)
ctx.body = renderPurchaseError(product)
} else {
ctx.body = renderInvoice(product)
}
})
For more information on using the BugSnag SDK asynchronously, see our Node.js asynchronous error handling guide.
BugSnag will automatically capture the following data for every exception:
It can often be helpful to attach application-specific diagnostic data to error reports. This can be accomplished by setting a callback which will be invoked before any reports are sent to BugSnag.
The following adds a map of data to the “company” tab on the BugSnag dashboard for all captured events:
Bugsnag.start({
onError: function (event) {
event.addMetadata('company', {
name: "Acme Co.",
country: "uk"
})
}
})
For more information, see Customizing error reports.
In order to correlate errors with customer reports, or to see a list of users who experienced each error, it is helpful to capture and display user information on your BugSnag dashboard.
You can set the user information of an error report using the user configuration property when BugSnag starts or via an onError callback.
Bugsnag.start({
onError: function (event) {
event.setUser('3', 'bugs.nag@bugsnag.com', 'Bugs Nag')
}
})
For information on doing so, see Adding user data.
In order to understand what happened in your application before each error, it can be helpful to leave short log statements that we call breadcrumbs. A configurable number of breadcrumbs are attached to each error report to help diagnose what events led to the error.
By default, BugSnag captures the following events as breadcrumbs.
HTTP requests
Errors
Console logs, warnings, and errors
You can use the leaveBreadcrumb method to log potentially useful events in your own applications:
Bugsnag.leaveBreadcrumb('Button clicked')
BugSnag will keep track of the time and order of the breadcrumbs and show them on your dashboard. Additional data can also be attached to breadcrumbs by providing the optional metadata parameter.
For more information and examples for how custom breadcrumbs can be integrated, see Customizing breadcrumbs.
BugSnag tracks the number of “sessions” that happen within your application. This allows you to compare stability scores between releases and helps you to understand the quality of your releases.
Sessions are captured and reported by default. This behavior can be disabled using the autoTrackSessions configuration option.
Sessions are reported in Node.js every time a request is served if you are using one of the server integrations:
@bugsnag/plugin-express@bugsnag/plugin-restify@bugsnag/plugin-koaA summary of sessions recorded will be periodically sent to BugSnag.
For more information about manually controlling session tracking, see Capturing sessions.
Monitor errors as you roll out features or run experiments and A/B tests by declaring your feature flag and experiment usage in the BugSnag client. You can use the Features dashboard to identify whether these features have introduced errors into your app.
Bugsnag.addFeatureFlag('Checkout button color', 'Blue')
Bugsnag.addFeatureFlag('New checkout flow')
For more information, see Feature flags & experiments.
Configure your app version to see the release that each error was introduced in.
Bugsnag.start({ appVersion: '4.10.0' })
Then set up a build tool integration to enable linking to code in your source control provider from the releases dashboard, timeline annotations, and stack traces.
@bugsnag/js, the library powering BugSnag for Node.js, on GitHub