This package has been deprecated
Opbeat has joined forces with Elastic and this agent is now deprecated. We recommend that you use Elastic APM instead: https://www.elastic.co/solutions/apm
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.
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 scriptvar opbeat = startappId: '...'organizationId: '...'secretToken: '...'
If you want to manually send an error to Opbeat, use the
- Documentation overview
- Get started with Express
- Get started with hapi
- Get started with Koa
- Agent API
- Troubleshooting guide
- Compatibility with other modules
- Upgrading to v4
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.
Made with ♥️ and ☕️ by Opbeat and our community.