open-telemetry / open-telemetry/opentelemetry-python-contrib
Remove `packaging` as a runtime dependency of `opentelemetry-instrumentation-falcon`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Remove packaging as a runtime dependency of opentelemetry-instrumentation-falcon
Summary
opentelemetry-instrumentation-falcon declares packaging >= 20.0 as a runtime
dependency, used solely to compare the installed Falcon version.
Motivation: the auto-instrumentation injector
The auto-instrumentation injector (the Python auto-instrumentation shipped by the
OpenTelemetry Operator) bundles the instrumentation packages and all of their
runtime dependencies into an init container and prepends that directory to the
target application's PYTHONPATH. Every runtime dependency is therefore injected
into the user's application process, where a common library like packaging
risks version shadowing/conflicts and adds to the injected payload. Removing it
shrinks that footprint. See #4882 for the full rationale.
Where it is used
pyproject.toml:packaging >= 20.0independencies.src/opentelemetry/instrumentation/falcon/__init__.py:229:
package_version.parse(falcon.__version__)compared against2.0.0/3.0.0
to select the correct request/response attribute handling.
Purpose: spec-compliant PEP 440 ordering of falcon.__version__ to branch
behavior by installed Falcon version.
Proposed resolution
Import the PEP 440 Version from the internal implementation added in #4882
(opentelemetry.instrumentation._packaging.version) instead of packaging, and
remove packaging from this package's dependencies.
Depends on #4882, which introduces opentelemetry.instrumentation._packaging
in opentelemetry-instrumentation (a dependency of this package).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read #4882 and the internal implementation under opentelemetry.instrumentation._packaging first. Update pyproject.toml and the version comparison at src/opentelemetry/instrumentation/falcon/init.py:229, then verify Falcon instrumentation behavior across the documented Falcon versions without the packaging runtime dependency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- observability-sre
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100