feat: implement context handler to store HTTP request and tracing information #752
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
removing warnings related to serialVersionUID and unused objects
provide context abstraction to instantiate a context with info about HttpRequest and tracing (trace id and span id). provide handler that is able to store context per-thread to support Web servers that handle each request in a dedicated thread. provide support for ServletContainerInititializer by introducing request context scope that can be "entered" and "leaved".
the empty instance of HttpRequest is used as a reference for empty object.
refactor Context constructor to set null instead of empty HttpRequest. update traceparent context load method name and comments. fix string comparison bug in traceparent context load method.
google-cla
bot
added
the
cla: yes
product-auto-label
bot
added
the
api: logging
minherz
changed the title
|
Note that PR also includes pulled env-tests-logging submodule. |
daniel-sanche
added
the
kokoro:force-run
yoshi-kokoro
removed
kokoro:force-run
losalex
suggested changes
Nov 18, 2021
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/Context.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/RequestContextScope.java
Outdated
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/context/ContextHandler.java
Outdated
Show resolved
Hide resolved
replace String.length() > 0 with !String.isEmpty(). strict W3C trace parent format validation
RequestContextScope is removed to avoid ambiguous use
move Context and ContextHolder to the root library package. initialize ContextHolder to InheritableThreadLocal if configuration property is provided. Add support for additional configuration property into LoggingConfig.
losalex
reviewed
Nov 23, 2021
google-cloud-logging/src/main/java/com/google/cloud/logging/LoggingConfig.java
Show resolved
Hide resolved
google-cloud-logging/src/main/java/com/google/cloud/logging/TraceLoggingEnhancer.java
Show resolved
Hide resolved
| } | ||
| } | ||
|
|
||
| public Context getCurrentContext() { |
There was a problem hiding this comment.
I wonder if we should make it generic by turning this into template to be reused with other objects (not only Context). Seems that TraceLoggingEnhancer below also used ThreadLocal and might benefit from it as well
There was a problem hiding this comment.
I think we should focus on supporting "our" context since this is what this feature is designed to be. Providing template means we include a generic-purpose implementation into logging library code.
If there will be a need for additional information for the context, the Context class can be extended to include additional data fields.
losalex
approved these changes
Nov 23, 2021
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.
Implement support for setting current context to capture Http request and tracing information of the current context.
It provides per-thread context handling and supports enter/exit scope to avoid re-setting the context multiple time in event of re-entering the scope.
The context supports setting trace and span ids directly and parsing the ids from
X-CLOUD-TRACEandtraceparentHttp header values.Fixes #750