This repository was archived by the owner on Jul 1, 2022. It is now read-only.
Document MDC log correlation support #724
Merged
Conversation
This file contains hidden or 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
Signed-off-by: avim <avi.maslati@forescout.com>
avimas
force-pushed
the
mdc-support-documentation
branch
from
4d594f9 to
4971e72
Compare
Codecov Report
@@ Coverage Diff @@
## master #724 +/- ##
============================================
+ Coverage 88.76% 88.98% +0.22%
- Complexity 596 598 +2
============================================
Files 73 73
Lines 2242 2242
Branches 289 289
============================================
+ Hits 1990 1995 +5
+ Misses 159 155 -4
+ Partials 93 92 -1
Continue to review full report at Codecov.
|
yurishkuro
reviewed
Jun 28, 2020
Member
yurishkuro
left a comment
yurishkuro
left a comment
There was a problem hiding this comment.
Thanks! A few minor suggestions.
jaeger-core/README.md
Outdated
Comment on lines
145
to
150
| The Jaeger Java Client also provides log correlation support by configuring the logging context (MDC) | ||
| with the following variables: | ||
|
|
||
| trace id - %{traceId} | ||
| span id - %{spanId} | ||
| sampled - %{sampled} |
Member
There was a problem hiding this comment.
Suggested change
| The Jaeger Java Client also provides log correlation support by configuring the logging context (MDC) | |
| with the following variables: | |
| trace id - %{traceId} | |
| span id - %{spanId} | |
| sampled - %{sampled} | |
| The Jaeger Java Client supports log correlation by updating the logging context (MDC) with three variables: `traceId`, `spanId`, `sampled`. |
jaeger-core/README.md
Outdated
|
|
||
| To accomplish that Jaegar Tracer should be created with the following two steps: | ||
|
|
||
| 1. Create the MDCScopeManager using either default names: |
Member
There was a problem hiding this comment.
Suggested change
| 1. Create the MDCScopeManager using either default names: | |
| 1. Create the MDCScopeManager using either default MDC field names: |
| 2. Create the Jaegar Tracer by supplying the MDCScopeManager created step 1: | ||
| ```java | ||
| JaegerTracer.Builder("serviceName").withScopeManager(scopeManager).build(); | ||
| ``` |
Member
There was a problem hiding this comment.
I would also add that the log formatter must be configured to include MDC fields in the output. Show example of the formatter for, say, log4j, and include a sample output log line.
Contributor
Author
There was a problem hiding this comment.
Thanks for the feedback!
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Which problem is this PR solving?
documentation for #718
Short description of the changes
add documentation for log correlation