Skip to content

Remove pkg resources #2871

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 38 commits into from
Oct 19, 2024
Merged

Remove pkg resources #2871

merged 38 commits into from
Oct 19, 2024

Conversation

xrmx
Copy link
Contributor

@xrmx xrmx commented Sep 13, 2024 •
edited by emdneto
Loading

Description

This incorporates all previous work from @Rodrigo-Novas and @ocelotl and makes ci happy.

Fixes #2180
Fixes #1970
Fixes #2843

Closes #1973 #2124 #2181 #2854

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@xrmx xrmx requested a review from a team September 13, 2024 15:35
@xrmx xrmx marked this pull request as draft September 13, 2024 15:47
@xrmx xrmx force-pushed the remove-pkg-resources branch from 103df57 to 3f339c3 Compare September 13, 2024 15:54
@xrmx xrmx force-pushed the remove-pkg-resources branch from 854b02a to 4a8055f Compare October 17, 2024 08:43
@xrmx xrmx marked this pull request as ready for review October 17, 2024 08:55
@xrmx xrmx requested a review from a team as a code owner October 17, 2024 08:55
@xrmx xrmx changed the title WIP Remove pkg resources Remove pkg resources Oct 17, 2024
@mlavin
Copy link

mlavin commented Oct 17, 2024

Tested out locally and it works for me. My benchmarks show a ~100-200ms improvement in the import/start time when manually configuring and ~400-500ms when using the auto-instrumentation. Thank you to everyone who contributed towards this change and I can't wait to see this land 🙌

emdneto
emdneto reviewed Oct 17, 2024
View reviewed changes
@xrmx @emdneto
Update CHANGELOG.md
af504e1 
Co-authored-by: Emídio Neto <[email protected]>
@lzchen lzchen merged commit e4ece57 into open-telemetry:main Oct 19, 2024
528 checks passed
This was referenced Oct 20, 2024
Closed
Closed
Closed
@moserke
Copy link

moserke commented Nov 4, 2024

Do we know when this will make it into a release? Looks like there has not been a release since August, will one be coming soon? I see this in the CHANGELOG.md. It's blocking us from being able to go to python 3.12, so mostly just curious on timing.

@tammy-baylis-swi
Copy link
Contributor

Do we know when this will make it into a release? Looks like there has not been a release since August, will one be coming soon?

Yes, this is now available as part of 1.28.1/0.49b1.

xrmx added a commit to xrmx/opentelemetry-python-contrib that referenced this pull request Jan 24, 2025
@xrmx
Remove pkg resources (open-telemetry#2871)
8b81f6a
@yiyuan-he yiyuan-he mentioned this pull request Jun 15, 2025
Merged
yiyuan-he added a commit to aws-observability/aws-otel-python-instrumentation that referenced this pull request Jun 16, 2025
@yiyuan-he
Add Explicit Distro and Configurator Env Var Config to Contract Test …
671f5e2 
…Setup (#398)

## What does this pull request do?
Fixes an issue where
[upgrading](#388)
our OTel dependency version from 1.27.0 caused all of our contract tests
to start
[failing](https://github.com/aws-observability/aws-otel-python-instrumentation/actions/runs/15640951584/job/44067918087)
in the main build.

The root cause was that in version
[1.28.0](https://github.com/open-telemetry/opentelemetry-python-contrib/releases/tag/v0.49b0)
OpenTelemetry Python SDK migrated from `pkg_resources` to
`importlib_metadata` for entry point discovery. This was a [breaking
change](open-telemetry/opentelemetry-python-contrib#2871)
that had significant behavioral implications:
- **Before (pkg_resources):** Entry points were discovered in `sys.path`
order, meaing packages installed in the local test environment (e.g.
venv) were always prioritized. This made ADOT discovery predictable and
consistent even without explicitly specifying `OTEL_PYTHON_DISTRO` and
`OTEL_PYTHON_CONFIGURATOR` in the contract test set up.
- **After (importlib_metadata):** Entry points are discovered using an
implementation ordering that doesn't guarantee `sys.path` precedence. In
short, the discovery order depends on factors like filesystem iteration
order, installation timestamps, etc. - things that can vary between
environments. This is why our contract tests were able to pass in
original PR build to bump the OTel dependencies, but then started
failing in our main build.

Due to this unpredicatable ordering, our ADOT SDK was not able to
instrument the sample apps in our contract tests correctly which then
resulted in all the test assertions failing.

The solution is to explicitly configure the OpenTelemetry distro and
configurator in our contract test set up. This approach follows
OpenTelemetry's [official
recommendations](https://pypi.org/project/opentelemetry-instrumentation/)
when multiple distros are present.
> If you have entry points for multiple distros or configurators present
in your environment, you should specify the entry point name of the
distro and configurator you want to be used via the OTEL_PYTHON_DISTRO
and OTEL_PYTHON_CONFIGURATOR environment variables.

**This fix will enable us to safely upgrade our OTel dependency version
from 1.27.0 which unblocks the Caton project.**


By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.
yiyuan-he added a commit to yiyuan-he/aws-otel-python-instrumentation that referenced this pull request Jun 16, 2025
@yiyuan-he
Add Explicit Distro and Configurator Env Var Config to Contract Test …
4f345e7 
…Setup (aws-observability#398)

## What does this pull request do?
Fixes an issue where
[upgrading](aws-observability#388)
our OTel dependency version from 1.27.0 caused all of our contract tests
to start
[failing](https://github.com/aws-observability/aws-otel-python-instrumentation/actions/runs/15640951584/job/44067918087)
in the main build.

The root cause was that in version
[1.28.0](https://github.com/open-telemetry/opentelemetry-python-contrib/releases/tag/v0.49b0)
OpenTelemetry Python SDK migrated from `pkg_resources` to
`importlib_metadata` for entry point discovery. This was a [breaking
change](open-telemetry/opentelemetry-python-contrib#2871)
that had significant behavioral implications:
- **Before (pkg_resources):** Entry points were discovered in `sys.path`
order, meaing packages installed in the local test environment (e.g.
venv) were always prioritized. This made ADOT discovery predictable and
consistent even without explicitly specifying `OTEL_PYTHON_DISTRO` and
`OTEL_PYTHON_CONFIGURATOR` in the contract test set up.
- **After (importlib_metadata):** Entry points are discovered using an
implementation ordering that doesn't guarantee `sys.path` precedence. In
short, the discovery order depends on factors like filesystem iteration
order, installation timestamps, etc. - things that can vary between
environments. This is why our contract tests were able to pass in
original PR build to bump the OTel dependencies, but then started
failing in our main build.

Due to this unpredicatable ordering, our ADOT SDK was not able to
instrument the sample apps in our contract tests correctly which then
resulted in all the test assertions failing.

The solution is to explicitly configure the OpenTelemetry distro and
configurator in our contract test set up. This approach follows
OpenTelemetry's [official
recommendations](https://pypi.org/project/opentelemetry-instrumentation/)
when multiple distros are present.
> If you have entry points for multiple distros or configurators present
in your environment, you should specify the entry point name of the
distro and configurator you want to be used via the OTEL_PYTHON_DISTRO
and OTEL_PYTHON_CONFIGURATOR environment variables.

**This fix will enable us to safely upgrade our OTel dependency version
from 1.27.0 which unblocks the Caton project.**


By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.
@eliteprox eliteprox mentioned this pull request Oct 9, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emdneto emdneto emdneto approved these changes

@lzchen lzchen lzchen approved these changes

@tammy-baylis-swi tammy-baylis-swi tammy-baylis-swi approved these changes

Assignees

@federicobond federicobond

@NathanielRN NathanielRN

@srprash srprash

@shalevr shalevr

@nikosokolik nikosokolik

@oxeye-nikolay oxeye-nikolay

Labels

None yet

Projects

None yet

Milestone

No milestone