Skip to content

botocore: document threading instrumentation for S3 multipart operations #3999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xrmx merged 4 commits into from
Dec 5, 2025
+22 −6
Merged

botocore: document threading instrumentation for S3 multipart operations #3999

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0ee2bb
botocore: document threading instrumentation for S3 multipart operations
bendrucker Dec 3, 2025
eb10429
botocore: move thread context docs to module docstring only
bendrucker Dec 4, 2025
f510b86
Update __init__.py
xrmx Dec 5, 2025
8a7e49b
Update __init__.py
xrmx Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions instrumentation/opentelemetry-instrumentation-botocore/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,22 @@ Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported

If you don't have an application using Bedrock APIs yet, try our `zero-code examples <examples/bedrock-runtime/zero-code>`_.

Thread Context Propagation
--------------------------

boto3's S3 ``upload_file`` and ``download_file`` methods use background threads
for multipart transfers. To ensure trace context is propagated to these threads,
also enable the threading instrumentation::

from opentelemetry.instrumentation.threading import ThreadingInstrumentor
from opentelemetry.instrumentation.botocore import BotocoreInstrumentor

ThreadingInstrumentor().instrument()
BotocoreInstrumentor().instrument()

When using auto-instrumentation (``opentelemetry-instrument``), both instrumentors
are enabled automatically if their packages are installed.

Installation
------------

Expand Down
18 changes: 18 additions & 0 deletions ...telemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,24 @@ def response_hook(span, service_name, operation_name, result):
)
ec2 = session.create_client("ec2", region_name="us-west-2")
ec2.describe_instances()

Thread Context Propagation
--------------------------

boto3's S3 ``upload_file`` and ``download_file`` methods use background threads
for multipart transfers. To ensure trace context is propagated to these threads,
also enable the threading instrumentation:

.. code:: python

from opentelemetry.instrumentation.threading import ThreadingInstrumentor
from opentelemetry.instrumentation.botocore import BotocoreInstrumentor

ThreadingInstrumentor().instrument()
BotocoreInstrumentor().instrument()

When using auto-instrumentation (``opentelemetry-instrument``), both instrumentors
are enabled automatically if their packages are installed.
"""

import logging
Expand Down