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

refactor: split resource_detectors into their own gems. #639

Conversation

scbjans
Copy link
Contributor

@scbjans scbjans commented Sep 1, 2023

This refactoring results in the current resource detectors split into their own separate gems (as is already the case for the Container Resource Detector).

The current all-encompassing gem will still be available for now. When someone still uses it; a WARN log message will be shown stating that the new gems should be used onwards.

In a subsequent PR the all-encompassing gem (opentelemetry-resource_detectors) will be removed.

Copy link
Collaborator

@arielvalentin arielvalentin left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!

Consider using post_install_message and let folks know about this change when they are installing gems: https://guides.rubygems.org/specification-reference/#post_install_message

May I also confirm that we are keeping the all-in-one resources detectors gem or are we going to phase out the all-in-one?

If we are keeping the all-in-one gem, will that reference the other gems once they are published?

If so then these should appear ahead of the all-in-one gem in the releases.yml

@scbjans
Copy link
Contributor Author

scbjans commented Sep 4, 2023

Thanks for pointing me to post_install_message; I've added it in 5b8a377

From my perspective we'll completely remove the opentelemetry-resource_detectors gem. The current resource detectors in that gem are already mutually exclusive; hence I don't think it'll make sense to have an all-in-one gem for resource detectors.

We'll first need a new release of the opentelemetry-resource_detectors gem, which contains the deprecation warnings. I'll create a follow-up PR after that to completely remove the all-in-one gem, if agreed.

@arielvalentin
Copy link
Collaborator

Let's leave the source in place all in one gem in place for now so folks can find it when they navigate to this repo.

Once this PR is merged and gems are released, then the follow up will be to remove the all-in-one from CI and the release process.

@arielvalentin
Copy link
Collaborator

@scbjans Mind taking a look at the merge conflicts? Once you have those resolved I will merge.

@arielvalentin
Copy link
Collaborator

@scbjans It looks like the merge commit did not work as I expected.

Would you mind rebasing upstream main onto your branch?

@scbjans scbjans force-pushed the split-off-resource-detector-in-own-gems branch from a5ba5c3 to 916ee68 Compare September 5, 2023 21:02
@arielvalentin arielvalentin merged commit d1ad4a7 into open-telemetry:main Sep 7, 2023
@scbjans scbjans deleted the split-off-resource-detector-in-own-gems branch September 7, 2023 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants