Add setuptools instrumentation install requirement #781
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattoberle
force-pushed
the
778/instrumentation-setuptools-requirement
branch
from
3d55697 to
c09090d
Compare
mattoberle
changed the title
The `setuptools` package is not part of the stdlib, but often available in the system environment (it is a buildtime requirement). `pkg_resources` (a package provided by `setuptools`) is used as a runtime requirement in `opentelemetry-instrumentation`. Explicitly listing `setuptools` as a requirement protects instrumentation from breaking with import errors in cases where `setuptools` is not available system-wide. For example: * A multi-stage Docker build where the final image does not contain buildtime requirements. * A build system that packages the runtime dependencies into a single binary. This commit pins `setuptools >= 16.0` because that is the first release that included all 5 imports instrumentation currently relies on.
mattoberle
force-pushed
the
778/instrumentation-setuptools-requirement
branch
from
c09090d to
39ae6e2
Compare
owais
approved these changes
Oct 26, 2021
|
@open-telemetry/python-approvers please take a look |
srikanthccv
approved these changes
Oct 27, 2021
NathanielRN
approved these changes
Oct 27, 2021
codeboten
approved these changes
Oct 27, 2021
5 tasks
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The
setuptoolspackage is not part of the stdlib, but often available in the system environment (it is a buildtime requirement).pkg_resources(a package provided bysetuptools) is used as a runtime requirement inopentelemetry-instrumentation. Explicitly listingsetuptoolsas a requirement protects instrumentation from breaking with import errors in cases wheresetuptoolsis not available system-wide.For example:
This commit pins
setuptools >= 16.0because that is the first release that included all 5 imports instrumentation currently relies on.Fixes #778
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
To verify the correct pin for
setuptoolsI usedgit bisect, checking for the first version that included all imports used byopentelemetry-instrumentation. Further details can be found in the linked issue.Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.