Add delegating global propagator #1258
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
MrAlias
added
bug
MrAlias
requested review from
Aneurysm9,
evantorrie,
jmacd,
lizthegrey and
XSAM
as code owners
Codecov Report
@@ Coverage Diff @@
## master #1258 +/- ##
========================================
- Coverage 76.7% 76.4% -0.3%
========================================
Files 131 132 +1
Lines 5903 5926 +23
========================================
+ Hits 4531 4532 +1
- Misses 1120 1142 +22
Partials 252 252
|
Aneurysm9
approved these changes
Oct 15, 2020
XSAM
approved these changes
Oct 15, 2020
|
Blipping to see if the CLA bot is working now. |
|
With #1259 merged I was able to just add the tests here. |
This reverts commit af7ae17.
|
Pulled the addition of tests out so they can more easily be reviewed in their own PR. |
seh
reviewed
Oct 15, 2020
| return p.noop.Extract(ctx, carrier) | ||
| } | ||
|
|
||
| // Fields returns the keys who's values are set with Inject. |
seh
reviewed
Oct 15, 2020
|
|
||
| // Inject set cross-cutting concerns from the Context into the carrier. | ||
| func (p *textMapPropagator) Inject(ctx context.Context, carrier otel.TextMapCarrier) { | ||
| if p.HasDelegate() { |
There was a problem hiding this comment.
Both here and in (*textMapPropagator).Fields, it would be safer to use the value read while holding the mutex. Sketching:
p.mtx.Lock()
delegate := p.delegate
p.mtx.Unlock()
if delegate == nil {
delegate = p.noop
}
delegate.Inject(ctx, carrier)You could introduce a helper method to make that more concise:
func (p *textMapPropagator) currentDelegate() otel.TextMapPropagator {
p.mtx.Lock()
defer p.mtx.Unlock()
return p.delegate
}
func (p *textMapPropagator) HasDelegate() bool {
return p.currentDelegate() != nil
}There was a problem hiding this comment.
This seems good. I was basing this off the fact that the delegate only ever changes from nil to not nil, and it only does this once, but I think you're approach doesn't add overhead and guards against future changes invalidating these assumptions. I'll open a PR to address your feedback. Thanks.
MrAlias
added a commit
to MrAlias/opentelemetry-go
that referenced
this pull request
Oct 15, 2020
Include feedback from a post-merge review of open-telemetry#1258
MrAlias
added a commit
that referenced
this pull request
Oct 17, 2020
* Update the internal global TextMapPropagator Include feedback from a post-merge review of #1258 * Apply feedback * Update api/global/internal/propagator.go Co-authored-by: Steven E. Harris <seh@panix.com> Co-authored-by: Steven E. Harris <seh@panix.com>
Merged
AzfaarQureshi
pushed a commit
to open-o11y/opentelemetry-go
that referenced
this pull request
Dec 3, 2020
* Add delegating global propagator * Add Changes to CHANGELOG * Add PR number to CHANGELOG * Add tests using new test framework * Revert "Add tests using new test framework" This reverts commit af7ae17.
AzfaarQureshi
pushed a commit
to open-o11y/opentelemetry-go
that referenced
this pull request
Dec 3, 2020
* Update the internal global TextMapPropagator Include feedback from a post-merge review of open-telemetry#1258 * Apply feedback * Update api/global/internal/propagator.go Co-authored-by: Steven E. Harris <seh@panix.com> Co-authored-by: Steven E. Harris <seh@panix.com>
6 tasks
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.
The
api/globalTextMapPropagator now delegates functionality to a globally set delegate for all previously returned propagators.This does not include tests. I have them lined up but they use new propagator testing utils in the
oteltestpackage that are going to be in a PR shortly following this being opened. Once that is merged I can submit the tests for this.Resolves #1257