Manage errors in APM: Collect, ignore, or mark as expected

New Relic APM agents automatically report error data for supported frameworks. To optimize error reporting and alerting, you can further manage errors in order to:

  • Catch errors that New Relic does not instrument by default.
  • Ignore errors that you don't want reported at all.
  • Filter out noise from expected errors so you can focus on the errors that are affecting performance. (Java and Ruby agents only)

Collect errors not instrumented by default

New Relic APM agents include API calls to report (or "notice") errors. These are useful when New Relic does not instrument your framework automatically or when there are particular errors that New Relic is not catching for your supported framework.

To learn how to get an APM agent to report an error, see the agent-specific API documentation:

Ignore errors

Sometimes the APM agent instruments an error that you don't want reported, such as errors that contain sensitive information like user login errors. If you don't want an error to report to the New Relic collector, you can ignore the error, and the APM agent discards the error entirely.

For Java and Ruby only: If you want to report errors to APM but don't want those errors to affect your Apdex or error rate, mark them as expected instead.

There are two ways to ignore errors: through the agent configuration or through server-side configuration in the UI:

Ignore errors using server-side configuration in the UI
  1. If it is not already enabled, enable server-side configuration.
  2. Go to the Server-side configuration menu for the application that has errors that you want to ignore.
  3. Under Error collection, look for Ignore from error collection. Add the HTTP code or the Error class for the errors that you want to ignore.
  4. Select Save server-side configuration.
Ignore errors using agent configuration

To ignore an error using the agent configuration, see the configuration documentation for your agent:

Expected errors: configure and view

Available only for the Ruby and Java agents.

For the Ruby and Java agents, you can mark errors as "expected." These errors will be reported to APM and available for viewing, but they won't affect the Apdex or error rate (or alert conditions based on error rate).

For how to set up expected error configuration, see the agent-specific documentation:

If expected errors are enabled, APM's Error analytics page will, by default, have a filter applied with the error.expected attribute set to false, meaning expected errors will not be displayed. To view expected errors, turn off the error.expected filter.

To view expected errors via New Relic Insights:

View errors in the UI

Among other places, error data appears in these parts of the New Relic UI:

For more help

Recommendations for learning more: