instrument: moving auto-instrumentation to a submodule #873
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
The opentelemetry.instrumentation namespace will be used by several packages as they become compliant to the opentelemetry specification. As a result, top-level instrumentations who have a name identical to their instrumented library (e.g. opentelemetry.instrumentation.requests or opentelemetry.instrumentation.starlette) will have a cyclic import error due to opentelemetry-instrument's injection of the opentelemetry.instrument folder in the path. Moving auto-instrumentation to a submodule solves this problem, as the only files in the opentelemetry.instrumentation.auto_instrument folder is the sitecustomize and the __init__.py itself.
lzchen
approved these changes
Jun 30, 2020
majorgreys
approved these changes
Jul 2, 2020
codeboten
pushed a commit
that referenced
this pull request
Jul 7, 2020
srikanthccv
pushed a commit
to srikanthccv/opentelemetry-python
that referenced
this pull request
Nov 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The opentelemetry.instrumentation namespace will be used by
several packages as they become compliant to the opentelemetry specification.
As a result, top-level instrumentations who have a name identical to their
instrumented library (e.g. opentelemetry.instrumentation.requests or
opentelemetry.instrumentation.starlette) will have a cyclic import
error due to opentelemetry-instrument's injection of the
opentelemetry.instrument folder in the path.
Moving auto-instrumentation to a submodule solves this problem, as
the only files in the opentelemetry.instrumentation.auto_instrument
folder is the sitecustomize and the init.py itself.
I ran into this when trying to auto-instrument starlette (imports from module starlette, and Python discovers opentelemetry.instrumentation.starlette.