OpenTelemetry Psycopg Instrumentation

The integration with PostgreSQL supports the Psycopg library, it can be enabled by using Psycopg2Instrumentor.

Usage

import psycopg2
from opentelemetry.instrumentation.psycopg2 import Psycopg2Instrumentor


Psycopg2Instrumentor().instrument()

cnx = psycopg2.connect(database='Database')
cursor = cnx.cursor()
cursor.execute("INSERT INTO test (testField) VALUES (123)")
cursor.close()
cnx.close()

API

class opentelemetry.instrumentation.psycopg2.Psycopg2Instrumentor(*args, **kwargs)[source]

Bases: opentelemetry.instrumentation.instrumentor.BaseInstrumentor

instrumentation_dependencies()[source]

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 setup.py.

For example, if an instrumentation instruments requests 1.x, this method should look like:

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.

Return type

Collection[str]

static instrument_connection(connection, tracer_provider=None)[source]
static uninstrument_connection(connection)[source]
class opentelemetry.instrumentation.psycopg2.DatabaseApiIntegration(name, database_system, connection_attributes=None, version='', tracer_provider=None, capture_parameters=False)[source]

Bases: opentelemetry.instrumentation.dbapi.DatabaseApiIntegration

wrapped_connection(connect_method, args, kwargs)[source]

Add object proxy to connection object.

class opentelemetry.instrumentation.psycopg2.CursorTracer(db_api_integration)[source]

Bases: opentelemetry.instrumentation.dbapi.CursorTracer

get_operation_name(cursor, args)[source]
get_statement(cursor, args)[source]