OpenTelemetry SQLAlchemy Instrumentation¶

Instrument sqlalchemy to report SQL queries.

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

Usage¶

from sqlalchemy import create_engine

from opentelemetry import trace
from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
from opentelemetry.sdk.trace import TracerProvider
import sqlalchemy

trace.set_tracer_provider(TracerProvider())
engine = create_engine("sqlite:///:memory:")
SQLAlchemyInstrumentor().instrument(
    engine=engine,
    service="service-A",
)

API¶

class opentelemetry.instrumentation.sqlalchemy.SQLAlchemyInstrumentor[source]¶

Bases: opentelemetry.instrumentation.instrumentor.BaseInstrumentor

An instrumentor for SQLAlchemy See BaseInstrumentor