Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] #1232

Merged
merged 8 commits into from
Jul 27, 2023

Conversation

rypdal
Copy link
Contributor

@rypdal rypdal commented Jun 9, 2023

Name of the package OpenTelemetry.Contrib.Extensions.AWSXRay is not consistent with current naming conventions.

  1. Contrib suffix should be removed
  2. AWSXRay should be replaced by AWS (see discussion Add ECS and Logs attributes based on Metadata v4 endpoint #875 (comment))

Package has been renamed to OpenTelemetry.Extensions.AWS. Namespaces, etc have been aligned accordingly.

This PR is result of discussions in the other PR: #1224 (comment)

EDIT: Fixes: #1066

@rypdal rypdal requested a review from a team June 9, 2023 14:00
@rypdal
Copy link
Contributor Author

rypdal commented Jun 9, 2023

@srprash, @atshaw43, @Kielek and @Oberon00: I would be very thankful for your review and comments.
This PR is the pre-requisite for releasing of the new OpenTelemetry.Extensions.AWS package, which is used by OpenTelemetry.Contrib.Instrumentation.AWS and OpenTelemetry.Instrumentation.AWSLambda packages.

@rypdal rypdal changed the title Rename package: OpenTelemetry.Contrib.Extensions.AWSXRay to OpenTelemetry.Extensions.AWS Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] Jun 9, 2023
@codecov
Copy link

codecov bot commented Jun 12, 2023

Codecov Report

Merging #1232 (7ee9719) into main (68e60db) will increase coverage by 0.65%.
Report is 24 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head 7ee9719 differs from pull request most recent head b5ee9f7. Consider uploading reports for the commit b5ee9f7 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1232      +/-   ##
==========================================
+ Coverage   72.96%   73.61%   +0.65%     
==========================================
  Files         265      265              
  Lines        9309     9346      +37     
==========================================
+ Hits         6792     6880      +88     
+ Misses       2517     2466      -51     
Files Changed Coverage Δ
...OpenTelemetry.Extensions.AWS/AWSXRayEventSource.cs 12.50% <ø> (ø)
...elemetry.Extensions.AWS/Trace/AWSXRayPropagator.cs 79.50% <ø> (ø)
....Extensions.AWS/TracerProviderBuilderExtensions.cs 100.00% <ø> (ø)
...OpenTelemetry.Extensions.AWS/AWSXRayIdGenerator.cs 61.64% <100.00%> (ø)

... and 6 files with indirect coverage changes

Copy link
Contributor

@Kielek Kielek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have pushed some minor changes directly to your branch.

LGTM.

@Kielek Kielek added the comp:extensions.aws Things related to OpenTelemetry.Extensions.AWS label Jun 12, 2023
Copy link
Member

@Oberon00 Oberon00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be reviewed by the package owners @srprash @atshaw43.

LGTM, but:

After this is released we probably need to update all the pseudo-internal dependencies as well, e.g. https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AWSLambda-1.1.0-beta.2/src/OpenTelemetry.Instrumentation.AWSLambda/OpenTelemetry.Instrumentation.AWSLambda.csproj#L15, otherwise anybody using a package depending on the old package cannot use the new package. In general renaming a package that has quite a few dependents seems to be asking for trouble. I wonder if this is worth it, but this should be decided by maintainers or package owners. I have no strong opinion.

labels: comp:contrib.extensions.awsxray
name: OpenTelemetry.Extensions.AWS
about: Issue with OpenTelemetry.Extensions.AWS
labels: comp:extensions.aws
Copy link
Member

@Oberon00 Oberon00 Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is merged, don't forget to rename the label on GitHub as well, @open-telemetry/dotnet-contrib-maintainers

@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jun 21, 2023
@Kielek Kielek removed the Stale label Jun 21, 2023
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jun 29, 2023
@Kielek Kielek removed the Stale label Jun 29, 2023
@rypdal rypdal changed the title Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] Jul 5, 2023
Copy link
Member

@Oberon00 Oberon00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure not to merge, there is a mistake here: The goal was to remove the "Contrib" part from the name, but this renames AWSXray to AWS which would then ultimately lead to conflicts.

@rypdal rypdal changed the title Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] Jul 5, 2023
@rypdal rypdal marked this pull request as draft July 5, 2023 07:38
@rypdal rypdal changed the title WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay or AWS] Jul 5, 2023
@rypdal rypdal changed the title WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay or AWS] WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] Jul 5, 2023
@rypdal rypdal changed the title WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWSXRay] WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] Jul 5, 2023
@Oberon00
Copy link
Member

Oberon00 commented Jul 5, 2023

Or maybe it's not a mistake, I'm a bit confused now. I'm pretty sure we want to remove "contrib" but why do we want to remove "xray"? Will this then not be easy to confuse with the other "AWS" package (Extensions vs Instrumentation)?

@rypdal
Copy link
Contributor Author

rypdal commented Jul 5, 2023

@Oberon00: I think renaming to OpenTelemetry.Extensions.AWS should be fine as it will no conflict with OpenTelemetry.Instrumentation.AWS. Also it more or less reflects what is this package for.

@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jul 13, 2023
@github-actions
Copy link
Contributor

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Jul 21, 2023
@Kielek Kielek reopened this Jul 21, 2023
@github-actions github-actions bot removed the Stale label Jul 22, 2023
@Kielek Kielek marked this pull request as ready for review July 27, 2023 10:25
@rypdal rypdal changed the title WIP: Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] Rename package: [OpenTelemetry.Contrib.Extensions.AWSXRay] to [OpenTelemetry.Extensions.AWS] Jul 27, 2023
@Kielek Kielek requested a review from Oberon00 July 27, 2023 10:28
@Kielek Kielek merged commit aac6b67 into open-telemetry:main Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp:extensions.aws Things related to OpenTelemetry.Extensions.AWS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Extensions.AWSXRay before release
4 participants