Troubleshooting Opbeat for Node.js

No data being logged to opbeat.com

If neither errors, releases or performance metrics are being tracked on opbeat.com, it’s a good idea to first check your log file and look for output just as the app starts.

Message: "Opbeat agent is inactive due to configuration"

You’ve most likely set the active option or the OPBEAT_ACTIVE environment variable to false. Ensure that it’s set to true and try again.

See the API documentation about active for details.

Message: "Opbeat isn't correctly configured: Missing organizationId, appId or secretToken"

The Opbeat agent couldn’t find your Opbeat credentials. Ensure that it’s correctly configured either by passing options to the .start() function or by using environment variables.

See the API documentation on appId, organizationId and secretToken for details.

No performance metrics on opbeat.com

Errors or releases gets tracked just fine, but you don’t see any performance metrics.

First make sure you have the latest version of the Opbeat agent. We fix issues and add support for new metrics all the time, so make sure you keep your dependency up to date.

If you are using the latest version but still don’t see any performance metrics, make sure that the agent is both required and started at the very top of your main app file (usually the index.js, server.js or app.js file). It’s important that the agent is started before any other modules are required. If not, the Opbeat agent will not be able to hook into any modules and will not be able to measure the performance of your application.

If this is not the issue, your app dependencies might be incompatible with the Opbeat agent. We’ll gladly take a look but you can help us a lot if you can send us the following information:

  • Your package.json file
  • If possible, your apps main js file (usually the index.js, server.js or app.js file)
  • Your server logs with Opbeat debugging enabled (see below for details)

Debug mode

To enable agent debugging and capture enough information, perform these steps:

  1. Start your app with the environment variable DEBUG=opbeat
  2. Send a few HTTP requests to some of the app endpoints
  3. Wait at least one minute to allow the agent to try and connect to opbeat.com

Send all of the above to Support and be sure to mention the app id of your application.