Skip to content

[Instrumentation.AWS] Update AWS SDK references#1454

Merged
Kielek merged 3 commits intoopen-telemetry:mainfrom
normj:normj/update-aws-dependency
Dec 1, 2023
Merged

[Instrumentation.AWS] Update AWS SDK references#1454
Kielek merged 3 commits intoopen-telemetry:mainfrom
normj:normj/update-aws-dependency

Conversation

@normj
Copy link
Copy Markdown
Contributor

@normj normj commented Nov 30, 2023

Changes

Update the AWS .NET SDK dependencies for the OpenTelemetry.Instrumentation.AWS package. This is needed because the version that was previously had a max range cap of 3.6 but the SDK has been on version 3.7 since 2021. Without this change users are getting restore warnings whenever they are using an SDK versions released in the last 2 years.

For background purposes I'm a developer of the AWS .NET SDK.

For significant contributions please make sure you have completed the following items:

  • Appropriate CHANGELOG.md updated for non-trivial changes
  • Design discussion issue #
  • Changes in public API reviewed

@normj normj requested a review from a team November 30, 2023 08:48
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 30, 2023

Codecov Report

Merging #1454 (7bdd7df) into main (71655ce) will increase coverage by 7.14%.
Report is 62 commits behind head on main.
The diff coverage is 76.78%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1454      +/-   ##
==========================================
+ Coverage   73.91%   81.05%   +7.14%     
==========================================
  Files         267      124     -143     
  Lines        9615     3442    -6173     
==========================================
- Hits         7107     2790    -4317     
+ Misses       2508      652    -1856     
Flag Coverage Δ
unittests-Solution 81.05% <76.78%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...ry.Exporter.InfluxDB/InfluxDBExporterExtensions.cs 100.00% <100.00%> (ø)
...ions.Enrichment/Internal/TraceEnrichmentActions.cs 100.00% <100.00%> (ø)
...ns.Enrichment/Internal/TraceEnrichmentProcessor.cs 100.00% <100.00%> (ø)
...metry.Extensions.Enrichment/Trace/TraceEnricher.cs 100.00% <100.00%> (ø)
....Extensions.Enrichment/Trace/TraceEnrichmentBag.cs 100.00% <100.00%> (ø)
...chment/TraceEnrichmentProviderBuilderExtensions.cs 100.00% <ø> (ø)
...ment/TraceEnrichmentServiceCollectionExtensions.cs 100.00% <100.00%> (ø)
...ion.AWSLambda/Implementation/AWSLambdaHttpUtils.cs 100.00% <ø> (ø)
...searchClient/ElasticsearchClientInstrumentation.cs 100.00% <100.00%> (ø)
.../ElasticsearchRequestPipelineDiagnosticListener.cs 82.35% <100.00%> (+0.14%) ⬆️
... and 13 more

... and 146 files with indirect coverage changes

@Kielek Kielek added the comp:instrumentation.aws Things related to OpenTelemetry.Instrumentation.AWS label Nov 30, 2023
@Kielek
Copy link
Copy Markdown
Member

Kielek commented Nov 30, 2023

@srprash, @rypdal, @Oberon00, @atshaw43, please review

@Kielek Kielek changed the title Update SDK references [Instrumentation.AWS] Update AWS SDK references Nov 30, 2023
@Kielek
Copy link
Copy Markdown
Member

Kielek commented Nov 30, 2023

@normj, please add entry to the changelog.

@Oberon00
Copy link
Copy Markdown
Member

Oberon00 commented Nov 30, 2023

had a max range cap of 3.6

Where does this max range cap come from? The reference here should be only a lower bound, see https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges

<!-- Accepts any version 6.1 and above.
     Will resolve to the smallest acceptable stable version.-->
<PackageReference Include="ExamplePackage" Version="6.1" />

@normj
Copy link
Copy Markdown
Contributor Author

normj commented Nov 30, 2023

had a max range cap of 3.6

Where does this max range cap come from? The reference here should be only a lower bound, see https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges

<!-- Accepts any version 6.1 and above.
     Will resolve to the smallest acceptable stable version.-->
<PackageReference Include="ExamplePackage" Version="6.1" />

The library is currently referencing version 3.5.0.26 of AWSSDK.SQS. If you look at the dependencies for that version it has a dependency on AWSSDK.Core set to >= 3.5.1.24 && < 3.6.0. In more recent versions the service packages like AWSSDK.SQS have a much wider range set for the dependency on AWSSDK.Core. >= 3.7.300 && < 4.0.0.

https://www.nuget.org/packages/AWSSDK.SQS/3.5.0.26#dependencies-body-tab

@normj
Copy link
Copy Markdown
Contributor Author

normj commented Nov 30, 2023

@normj, please add entry to the changelog.

What should I set the release date to for the changeling?

@Kielek
Copy link
Copy Markdown
Member

Kielek commented Nov 30, 2023

@normj, please add entry to the changelog.

What should I set the release date to for the changeling?

Release process is independent of merging this PR. Keep it just under Unreleased sections. See example: https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/f97fbe621ea561d8b7ea3f928de1cd13c1e49abc/src/OpenTelemetry.Instrumentation.Process/CHANGELOG.md#unreleased

@normj normj force-pushed the normj/update-aws-dependency branch from 4960158 to c8bcef3 Compare November 30, 2023 19:56
@normj
Copy link
Copy Markdown
Contributor Author

normj commented Nov 30, 2023

@Kielek change log has been updated.

@Kielek Kielek merged commit c6c2f23 into open-telemetry:main Dec 1, 2023
@normj normj deleted the normj/update-aws-dependency branch December 2, 2023 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp:instrumentation.aws Things related to OpenTelemetry.Instrumentation.AWS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants