Remove pkg_resource and replace for importlib.metadata in autoinstrumentation

[Rodrigo-Novas]

Description

Pkgresource dependency is deprecated, on this pr i replaced pkg_resource for importlib.metadata.

Fixes #2180

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

• Run with tox the unit tests

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

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: Rodrigo-Novas (070d566, 9cae805, 99502c9, 86f56ef, 1358c12, bf10494, 9750c8b, 11926df, bf44915, 780bcd5, 2364780)
• ✅ login: ocelotl / name: Diego Hurtado (8dc274f)

[ocelotl]

@Rodrigo-Novas please sign the CLA ✌️

[andre-meneses-fivestars]

Is there an expected ETA on this?

[WillDaSilva]

I believe this would also fix:

• Opentelemetry instrumentation uses deprecated pkg_resources. #1970

[psi29a]

Hope this gets picked back up! Great work so far!

[mlasch]

You are adding importlib-metadata to the dependencies, but this import is from the Python standard library. There is a discussion here: open-telemetry/opentelemetry-python#3234 about using importlib-metadata and its implications. Note my comment at the end.

[Rodrigo-Novas]

Hello, sorry for the delay.
If I understand correctly, you mean having a standard library with its own constraint within Opentelemetry would be wrong. I think that the change of importlib-metadata version could be made later if an error is reported.

#2181 (comment)

#2181 (comment)

[theunkn0wn1]

IMHO its fine to depend on importlib-metadata, as its the python-version independent backport of the stdlib feature.
it will be easier to develop against.

[pablo-sumup]

Hey there! Could you prioritize the code review for this PR? It's for migrating to Python 3.12. Thanks a bunch! :D

[theunkn0wn1]

Any ETA on this?
the package is broken in modern python versions due to undeclared pkg_resources usage.

[lzchen]

@Rodrigo-Novas

Are you still working on this? If so we can prioritize getting this reviewed and merged. It is difficult to know what the current status is so please close the conversations that you think have been resolved and note down the open topics that still need to be discussed. Feel free to also join the Python SIG if you want to bring this issue up to the community specifically.

[michaelgmiller1]

We are also getting hit with this on every unit test run. It would be great to get a fix in.

[Rodrigo-Novas]

@Rodrigo-Novas

Are you still working on this? If so we can prioritize getting this reviewed and merged. It is difficult to know what the current status is so please close the conversations that you think have been resolved and note down the open topics that still need to be discussed. Feel free to also join the Python SIG if you want to bring this issue up to the community specifically.

@lzchen

Its ok for me, you can review it!

[Rodrigo-Novas]

We are also getting hit with this on every unit test run. It would be great to get a fix in.

i will try to fix it

[Arnatious]

importlib-metadata is already aliased in opentelemetry-api (https://github.com/open-telemetry/opentelemetry-python/blob/main/opentelemetry-api/src/opentelemetry/util/_importlib_metadata.py) - should we reuse this rather than re-introduce the dependency?

[xrmx]

There is at:

    "importlib-metadata >= 6.0, <= 8.4.0",

[Rodrigo-Novas]

#2181 (comment)

[serkan-ozal]

Switching from pkg_resource to importlib.metadata also helps us to reduce OTEL Python layer Lambda coldstart.

[bhaskarbanerjee]

When is this PR expected to be approved and merged?

[xrmx]

When is this PR expected to be approved and merged?

When it's ready

[ocelotl]

When is this PR expected to be approved and merged?

We are trying to get more eyes on this PR, we realize it is important for many people. The issue at hand here is not particularly easy to solve (kudos to @Rodrigo-Novas for the work so far!) since it deals with replacing an old library with a new one where there is not necessarily a 1:1 relationship between old library and new library components. To make matters even more complicated, the new library has been implemented very inconsistently, so its behavior for Python 3.x is not the same as for Python 3.y.

We are working on this and we'll merge as soon as we can 🙂

[Arnatious]

For anyone following - this is currently blocked by (at minimum) open-telemetry/opentelemetry-python#4177, as well as a new release needed for open-telemetry/opentelemetry-python#4181 . Some of our assumptions in the previous discussions mentioned need to be re-addressed if we swap to relying on the stdlib in python <= 3.11, which will delay this a bit further.

[xrmx]

For anyone following - this is currently blocked by (at minimum) open-telemetry/opentelemetry-python#4177, as well as a new release needed for open-telemetry/opentelemetry-python#4181 . Some of our assumptions in the previous discussions mentioned need to be re-addressed if we swap to relying on the stdlib in python <= 3.11, which will delay this a bit further.

We're keeping importlib_metadata as dependency and PRs run against main of branch of core repo so no need for releases. The current blocker for me is this #2181 (comment)

[multani]

@xrmx I think this should have been closed by #2871, right?

[xrmx]

Closing, since this has been included in #2871. Thanks everyone!