Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add section about unhandled rejections in config docs #3323

Merged
merged 2 commits into from
May 8, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,11 @@ Another side-effect is that the APM agent does not log the uncaught exception
to stderr by default. Use <<log-uncaught-exceptions, `logUncaughtExceptions: true`>>
to have the agent print the exception to stderr before exiting.

Unhandled rejections (https://nodejs.org/api/process.html#event-unhandledrejection[`unhandledRejection`])
will also be captured if your node process starts with `--unhandled-rejections` mode set to
`strict` or `throw`. If your application run on Node.js 15+ you don't need to explitcitly set the mode
david-luna marked this conversation as resolved.
Show resolved Hide resolved
since `throw` is the default (https://nodejs.org/api/cli.html#--unhandled-rejectionsmode[reference]).

[[log-uncaught-exceptions]]
==== `logUncaughtExceptions`

Expand Down