Opbeat for Node.js

This is the official Node.js agent for Opbeat.

Opbeat provides instant performance insights, built for Node.js developers.

If you are looking for a module for your frontend JS applications, please see Opbeat for JS on GitHub.

Troubleshooting: If you encounter any problems setting up the Opbeat agent, please see our troubleshooting guide.

Quick start

Install the module:

npm install opbeat --save

To get started just require and start the Opbeat agent at the very top of your app's startup script. The Opbeat agent will be returned. The agent will now instrument your Node.js application and track unhandled exceptions automatically.

// Add this snippet to the VERY top of your app's startup script
var opbeat = require('opbeat').start({
  appId: '...',
  organizationId: '...',
  secretToken: '...'
})

If you want to manually send an error to Opbeat, use the captureError() function:

opbeat.captureError(new Error('Ups, something broke'))

Documentation

Testing

The test suite expects the databases PostgreSQL, MySQL, MongoDB and Redis to be present. The npm test command will try and start them all automatically before running the tests. This should work on OS X if the databases are all installed using Homebrew.

To run the linter without running any tests, run npm run lint. To automatically fix linting errors run npm run lint-fix.

License

BSD-2-Clause

Made with ♥️ and ☕️ by Opbeat and our community.

Current Tags