Jetty 12.0.x 12191 alt debug listener #12254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…x.adoc Co-authored-by: Greg Wilkins <[email protected]>
…x.adoc Co-authored-by: Greg Wilkins <[email protected]>
…x.adoc Co-authored-by: Greg Wilkins <[email protected]>
gregw
requested changes
Sep 15, 2024
Comment on lines
102
to
104
| [[eeN-debug]] | ||
| == Module `{ee-all}-debug` | ||
| include::{jetty-home}/modules/ee10-debug.mod[tags=description] |
There was a problem hiding this comment.
There is N, all and 10 in this paragraph
| @@ -76,17 +95,44 @@ public boolean handle(Request request, Response response, Callback callback) thr | |||
| finally | |||
| { | |||
| // TODO this should be done in a completion event | |||
| print(name, "RESPONSE " + response.getStatus() + (ex == null ? "" : ("/" + ex)) + " " + response.getHeaders().get(HttpHeader.CONTENT_TYPE)); | |||
| log("<< r=%s async=false %d%n%s", rname, response.getStatus(), response.getHeaders()); | |||
There was a problem hiding this comment.
We have to fix the TODO. At the time this finally block is called, the response status and headers may not be set, or we may be in a race with them being set.
Also async= doesn't mean much anymore.
So we need to wrap the callback and look at the return of the handle call to log all the possible outcomes:
- handle == false then
log("XX r=%s") - handle == true, callback complete then
log("<< r=%s async=false ... - handle == true, callback not complete then
log("|| r=%s async=true ...
In the callback, it should also check if handling has exited and if so it would need to log("<< r=%s ...
gregw
previously approved these changes
Sep 24, 2024
Comment on lines
65
to
75
| private boolean handlingCompleted() | ||
| { | ||
| //test if the request is still being handled or not | ||
| return !_handling.compareAndSet(true, false); | ||
| } | ||
|
|
||
| private void callbackCompleted(Throwable throwable) | ||
| { | ||
| if (_handling.compareAndSet(true, false)) | ||
| log("<< r=%s async=false %d %s%n%s", findRequestName(_request), _response.getStatus(), (throwable == null ? "" : throwable.toString()), _response.getHeaders()); | ||
| } |
There was a problem hiding this comment.
javadoc on these methods would be helpful
There was a problem hiding this comment.
I've changed the implementation to a) be more correct b) clearer and c) added more javadoc.
gregw
approved these changes
Sep 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an alternate solution to debug logging using the
DebugHandlerclass instead of theeeXDebugListenerclasses (as per PR #12231).The problem with #12231 is that all
DebugListenerswill share the same log file, which will lead to contention and sequencing problems. The solution would be to ensure that each context uses its own log, however, at the point in time at which the debug log is configured, nothing reasonably identifying is known about the context to which it is being applied. This is because theeeX-debugmodules are applied before a context xml file that would configure identifying info about that context, such as the context path or the location of the war being deployed.This PR takes a different approach, and uses a single
DebugHandlerinserted into the handler list instead. This guarantees proper locking of debug log file entries. I've enhanced the output of it so it more closely resembles the output of theDebugListener. One notable omission in the logging is the identity of the context of the request being logged. This is because at the point in time that the DebugHandler executes we have not yet picked which context the request will be routed to.Fixes: #12191