open-telemetry / open-telemetry/opentelemetry-python-contrib
Boto3's StreamingBody.read is not instrumented
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 16
Description
Problem
When an S3 get_object call is made to retrieve a big file, only the first request is instrumented. Subsequent StreamingBody are not, which makes a majority of the timeline without a span coverage.
Describe the solution you'd like
Another span that covers reading the body.
Describe alternatives you've considered
I've considered implementing it myself before this library covers it.
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 tracing the S3 get_object instrumentation and the botocore StreamingBody behavior described in the issue. Determine where reads can be covered by an additional span, then verify that the full body-reading timeline is instrumented. The issue does not name a file or test, so repository-wide search for get_object and StreamingBody is needed first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, python
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100