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.

Sign up for GitHub

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

Jump to bottom

Add notes about logging exception in RESTEasy Reactive #27612

Merged
merged 1 commit into from
Aug 31, 2022
+24 −0
Merged

Add notes about logging exception in RESTEasy Reactive #27612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions docs/src/main/asciidoc/resteasy-reactive.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,18 @@ but they require you to specify the parameter name.

See <<parameter-mapping>> for more advanced use-cases.

[NOTE]
====
When an exception occurs in RESTEasy Reactive request parameter handling code, the exception is not printed by default to the log (for security reasons).
This can sometimes make it hard to understand why certain HTTP status codes are returned (as the JAX-RS mandates the use of non-intuitive error codes in various cases).
In such cases, users are encouraged to set the logging level for the `org.jboss.resteasy.reactive.server.handlers.ParameterHandler` category to `DEBUG` like so:

[source, properties]
----
quarkus.log.category."org.jboss.resteasy.reactive.server.handlers.ParameterHandler".level=DEBUG
----
====

=== Declaring URI parameters

[[uri-parameters]]
Expand Down Expand Up @@ -1731,6 +1743,18 @@ It may declare any of the following return types:

|===

[NOTE]
====
When an exception occurs, RESTEasy Reactive does not log it by default (for security reasons).
This can sometimes make it hard to understand why certain exception handling code was invoked (or not invoked).
To make RESTEasy Reactive log the actual exception before an exception mapping code is run the `org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext` log category can be set to `DEBUG` like so:

[source, properties]
----
quarkus.log.category."org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext".level=DEBUG
----
====

=== Request or response filters

==== Via annotations
Expand Down