open-telemetry / open-telemetry/opentelemetry-python-contrib
Documenting about warnings reported on multiple middleware stack builds in fastapi
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Documenting this behavior would be ideal for this issue. We don't want to introduce additional things to API interface unless necessary.
Originally posted by @srikanthccv in https://github.com/open-telemetry/opentelemetry-python-contrib/issues/1335#issuecomment-1255003367
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
Start by reading the referenced discussion in issue 1335 and locate the FastAPI instrumentation documentation that covers middleware stack builds. Document the warning behavior described there without adding API changes; done means the relevant behavior and its implications are explained clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fastapi, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100