botocore: document threading instrumentation for S3 multipart operations #3999
+22
−6
Conversation
This file contains hidden or 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
Document that users need to enable ThreadingInstrumentor alongside BotocoreInstrumentor for proper trace context propagation with S3 upload_file and download_file methods.
xrmx
reviewed
Dec 4, 2025
instrumentation/opentelemetry-instrumentation-botocore/README.rst
Outdated
Show resolved
Hide resolved
README.rst is not built into the documentation, so keep the threading context propagation docs only in __init__.py where autodoc will pick them up.
xrmx
approved these changes
Dec 5, 2025
github-project-automation
bot
moved this from Easy to review / merge / close
to Done
in @xrmx's Python PR digest
RKest
pushed a commit
to RKest/opentelemetry-python-contrib
that referenced
this pull request
Dec 5, 2025
…ons (open-telemetry#3999) * botocore: document threading instrumentation for S3 multipart operations Document that users need to enable ThreadingInstrumentor alongside BotocoreInstrumentor for proper trace context propagation with S3 upload_file and download_file methods. * botocore: move thread context docs to module docstring only README.rst is not built into the documentation, so keep the threading context propagation docs only in __init__.py where autodoc will pick them up. * Update __init__.py * Update __init__.py --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
RKest
pushed a commit
to RKest/opentelemetry-python-contrib
that referenced
this pull request
Dec 5, 2025
…ons (open-telemetry#3999) * botocore: document threading instrumentation for S3 multipart operations Document that users need to enable ThreadingInstrumentor alongside BotocoreInstrumentor for proper trace context propagation with S3 upload_file and download_file methods. * botocore: move thread context docs to module docstring only README.rst is not built into the documentation, so keep the threading context propagation docs only in __init__.py where autodoc will pick them up. * Update __init__.py * Update __init__.py --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Documents that users need to enable
ThreadingInstrumentoralongsideBotocoreInstrumentorfor proper trace context propagation with S3upload_fileanddownload_filemethods.Issue
boto3's S3 multipart operations (
upload_file,download_file) spawn background threads viaThreadPoolExecutor. WithoutThreadingInstrumentor, the OpenTelemetry context is not propagated to these threads, resulting in broken traces where child spans appear as separate traces instead of being linked to their parent.The
opentelemetry-instrumentation-threadingmodule already wrapsThreadPoolExecutor.submit()to propagate context:context.get_current()whensubmit()is calledChanges
References
Closes #298