Fix using version 3.7.100 of AWS SDK causing exception not finding EndpointResolver #726
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
|
|
boblodgett
reviewed
Oct 21, 2022
| @@ -44,6 +44,6 @@ public void Customize(Type serviceClientType, RuntimePipeline pipeline) | |||
| return; | |||
| } | |||
|
|
|||
| pipeline.AddHandlerAfter<EndpointResolver>(new AWSTracingPipelineHandler(this.options)); | |||
| pipeline.AddHandlerAfter<RetryHandler>(new AWSTracingPipelineHandler(this.options)); | |||
There was a problem hiding this comment.
"The fix is for OpenTelemetry to inject itself before the RetryHandler"
But this is injecting AFTER. Which is correct? The summary or the code in this case?
boblodgett
approved these changes
Oct 21, 2022
|
@normj Thanks for sending this PR! Could you please sign the CLA? |
klementi
reviewed
Oct 21, 2022
|
|
||
| ## 1.0.2 | ||
|
|
||
| * Fixed issue when using version 3.7.100 of the AWS SDK for .NET triggering an EndpointResolver not found exception. |
There was a problem hiding this comment.
Where is corresponding AssemblyVersion change?
Thanks and done |
utpilla
added
the
comp:instrumentation.aws
srprash
reviewed
Oct 21, 2022
| @@ -1,5 +1,12 @@ | |||
| # Changelog - OpenTelemetry.Contrib.Instrumentation.AWS | |||
|
|
|||
| ## 1.0.2 | |||
|
|
|||
| Released 2022-Oct-21 | |||
There was a problem hiding this comment.
We don't yet know when this will be released. Let's just put this change under an Unreleased heading.
…EndpointResolver in AWS SDK instrumentation package
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #726 +/- ##
=======================================
Coverage 77.55% 77.55%
=======================================
Files 176 176
Lines 5298 5298
=======================================
Hits 4109 4109
Misses 1189 1189
|
srprash
approved these changes
Oct 24, 2022
Kielek
approved these changes
Oct 25, 2022
Co-authored-by: Piotr Kiełkowicz <pkiekowicz@splunk.com>
2 tasks
2 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.
Changes
Starting with version 3.7.100 of the AWS .NET SDK the EndpointResolver is replaced with a service specific version of the handler. This breaks the OpenTelemetry integration because OpenTelemetry was inserting itself just after EndpointResolver in the SDK's request pipeline.
The fix is for OpenTelemetry to inject itself before the RetryHandler which happens after endpoint resolutions. So the position will be the same in the request pipeline.
This fix will is compatible with both version 3.7.100 and versions before 3.7.100 so it will not break users that haven't upgrade their SDK version.
This change is very similar to the AWS X-Ray change which this code is based off: aws/aws-xray-sdk-dotnet#268
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes