NH-2313 adjust CompositePropagator config with OTEL_PROPAGATORS#15
Merged
tammy-baylis-swi merged 1 commit intoNH-12018-distro-and-configurator-setupfrom May 2, 2022
Conversation
This was referenced Apr 28, 2022
cheempz
approved these changes
May 2, 2022
Contributor
cheempz
left a comment
There was a problem hiding this comment.
LGTM, thanks for the writeup and testing @tammy-baylis-swi!
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
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 adjusts how customers can specify
OTEL_PROPAGATORSwhile using NH Python. This PR is pointed at the NH-12018 branch where distro setup is split between Distro and new Configurator.Manual test results on the lower half of the table in this doc: https://swicloud.atlassian.net/wiki/spaces/NIT/pages/2909569037/2022-04-27+to+28+propagators+combinations+testing
The below info is also on the customer documentation draft: https://swicloud.atlassian.net/wiki/spaces/NIT/pages/2867726621/NH+Python+Troubleshooting#Customizing-OTel-Propagators
The custom-distro uses
tracecontext,baggage,solarwinds_propagatorpropagators by default in composite for regular OTel headers and custom SolarWinds headers.Or, the customer can specify the exact propagators they want for extract/inject behaviour in trace context propagation while using our custom-distro. This is done on customer service side as follows:
pip install opentelemetry-propagator-jaegerjaeger,tracecontext,solarwinds_propagator,dummy_external_propagatorOTEL_PROPAGATORSmust be a comma-delimited string of valid propagator entry point names, which is sort-of checked by opentelemetry-python at propagator init: opentelemetry-python/init.py at main · open-telemetry/opentelemetry-python Additionally, for our custom-distro:tracecontextandsolarwinds_propagatormust be includedtracecontextmust be beforesolarwinds_propagatorThis is because
solarwinds_propagatordepends ontracecontext(TraceContextTextMapPropagator) injecting tracestate header into the carrier for update before re-injection. Meanwhile the other propagators can be in any order so a customer can specify their own to run extract/inject before or after ours.