OpenTelemetry Botocore Instrumentation

Instrument Botocore to trace service requests.

There are two options for instrumenting code. The first option is to use the opentelemetry-instrument executable which will automatically instrument your Botocore client. The second is to programmatically enable instrumentation via the following code:

Usage

from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
import botocore


# Instrument Botocore
BotocoreInstrumentor().instrument()

# This will create a span with Botocore-specific attributes
session = botocore.session.get_session()
session.set_credentials(
    access_key="access-key", secret_key="secret-key"
)
ec2 = self.session.create_client("ec2", region_name="us-west-2")
ec2.describe_instances()

API

The instrument method accepts the following keyword args:

tracer_provider (TracerProvider) - an optional tracer provider request_hook (Callable) - a function with extra user-defined logic to be performed before performing the request this function signature is: def request_hook(span: Span, service_name: str, operation_name: str, api_params: dict) -> None response_hook (Callable) - a function with extra user-defined logic to be performed after performing the request this function signature is: def response_hook(span: Span, service_name: str, operation_name: str, result: dict) -> None

for example:

class opentelemetry.instrumentation.botocore.BotocoreInstrumentor(*args, **kwargs)

Bases: BaseInstrumentor

An instrumentor for Botocore.

See BaseInstrumentor

instrumentation_dependencies()

Return a list of python packages with versions that the will be instrumented.

The format should be the same as used in requirements.txt or pyproject.toml.

For example, if an instrumentation instruments requests 1.x, this method should look like: :rtype: Collection[str]

def instrumentation_dependencies(self) -> Collection[str]:

return [‘requests ~= 1.0’]

This will ensure that the instrumentation will only be used when the specified library is present in the environment.