A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/dbapi/dbapi.html below:

Website Navigation


OpenTelemetry Database API Instrumentation — OpenTelemetry Python Contrib documentation

OpenTelemetry Database API Instrumentation

The trace integration with Database API supports libraries that follow the Python Database API Specification v2.0. https://www.python.org/dev/peps/pep-0249/

Usage 
import mysql.connector
import pyodbc

from opentelemetry.instrumentation.dbapi import trace_integration


# Ex: mysql.connector
trace_integration(mysql.connector, "connect", "mysql")
# Ex: pyodbc
trace_integration(pyodbc, "Connection", "odbc")
API
opentelemetry.instrumentation.dbapi.trace_integration(connect_module, connect_method_name, database_system, connection_attributes=None, tracer_provider=None, capture_parameters=False, enable_commenter=False, db_api_integration_factory=None, enable_attribute_commenter=False)[source]

Integrate with DB API library. https://www.python.org/dev/peps/pep-0249/

Parameters:

  • connect_module (Callable[..., Any]) – Module name where connect method is available.

  • connect_method_name (str) – The connect method name.

  • database_system (str) – An identifier for the database management system (DBMS) product being used.

  • connection_attributes (Optional[dict[str, Any]]) – Attribute names for database, port, host and user in Connection object.

  • tracer_provider (Optional[TracerProvider]) – The opentelemetry.trace.TracerProvider to use. If omitted the current configured one is used.

  • capture_parameters (bool) – Configure if db.statement.parameters should be captured.

  • enable_commenter (bool) – Flag to enable/disable sqlcommenter.

  • db_api_integration_factory (Optional[type[DatabaseApiIntegration]]) – The DatabaseApiIntegration to use. If none is passed the default one is used.

  • enable_attribute_commenter (bool) – Flag to enable/disable sqlcomment inclusion in db.statement span attribute. Only available if enable_commenter=True.

opentelemetry.instrumentation.dbapi.wrap_connect(name, connect_module, connect_method_name, database_system, connection_attributes=None, version='', tracer_provider=None, capture_parameters=False, enable_commenter=False, db_api_integration_factory=None, commenter_options=None, enable_attribute_commenter=False)[source]

Integrate with DB API library. https://www.python.org/dev/peps/pep-0249/

Parameters:

  • connect_module (Callable[..., Any]) – Module name where connect method is available.

  • connect_method_name (str) – The connect method name.

  • database_system (str) – An identifier for the database management system (DBMS) product being used.

  • connection_attributes (Optional[dict[str, Any]]) – Attribute names for database, port, host and user in Connection object.

  • tracer_provider (Optional[TracerProvider]) – The opentelemetry.trace.TracerProvider to use. If omitted the current configured one is used.

  • capture_parameters (bool) – Configure if db.statement.parameters should be captured.

  • enable_commenter (bool) – Flag to enable/disable sqlcommenter.

  • db_api_integration_factory (Optional[type[DatabaseApiIntegration]]) – The DatabaseApiIntegration to use. If none is passed the default one is used.

  • commenter_options (Optional[dict[str, Any]]) – Configurations for tags to be appended at the sql query.

  • enable_attribute_commenter (bool) – Flag to enable/disable sqlcomment inclusion in db.statement span attribute. Only available if enable_commenter=True.

opentelemetry.instrumentation.dbapi.unwrap_connect(connect_module, connect_method_name)[source]

Disable integration with DB API library. https://www.python.org/dev/peps/pep-0249/

Parameters:

  • connect_module (Callable[..., Any]) – Module name where the connect method is available.

  • connect_method_name (str) – The connect method name.

opentelemetry.instrumentation.dbapi.instrument_connection(name, connection, database_system, connection_attributes=None, version='', tracer_provider=None, capture_parameters=False, enable_commenter=False, commenter_options=None, connect_module=None, enable_attribute_commenter=False, db_api_integration_factory=None)[source]

Enable instrumentation in a database connection.

Parameters:

  • name (str) – The instrumentation module name.

  • connection (Union[TypeVar(ConnectionT), TracedConnectionProxy[TypeVar(ConnectionT)]]) – The connection to instrument.

  • database_system (str) – An identifier for the database management system (DBMS) product being used.

  • connection_attributes (Optional[dict[str, Any]]) – Attribute names for database, port, host and user in a connection object.

  • tracer_provider (Optional[TracerProvider]) – The opentelemetry.trace.TracerProvider to use. If omitted the current configured one is used.

  • capture_parameters (bool) – Configure if db.statement.parameters should be captured.

  • enable_commenter (bool) – Flag to enable/disable sqlcommenter.

  • commenter_options (Optional[dict[str, Any]]) – Configurations for tags to be appended at the sql query.

  • connect_module (Optional[Callable[..., Any]]) – Module name where connect method is available.

  • enable_attribute_commenter (bool) – Flag to enable/disable sqlcomment inclusion in db.statement span attribute. Only available if enable_commenter=True.

  • db_api_integration_factory (Optional[type[DatabaseApiIntegration]]) – A class or factory function to use as a replacement for DatabaseApiIntegration. Can be used to obtain connection attributes from the connect method instead of from the connection itself (as done by the pymssql intrumentor).

Return type:

TracedConnectionProxy[TypeVar(ConnectionT)]

Returns:

An instrumented connection.

opentelemetry.instrumentation.dbapi.uninstrument_connection(connection)[source]

Disable instrumentation in a database connection.

Parameters:

connection (Union[TypeVar(ConnectionT), TracedConnectionProxy[TypeVar(ConnectionT)]]) – The connection to uninstrument.

Return type:

TypeVar(ConnectionT)

Returns:

An uninstrumented connection.

class opentelemetry.instrumentation.dbapi.DatabaseApiIntegration(name, database_system, connection_attributes=None, version='', tracer_provider=None, capture_parameters=False, enable_commenter=False, commenter_options=None, connect_module=None, enable_attribute_commenter=False)[source]

Bases: object

Return type:

dict[str, Any]

wrapped_connection(connect_method, args, kwargs)[source]

Add object proxy to connection object.

Return type:

TracedConnectionProxy[TypeVar(ConnectionT)]

get_connection_attributes(connection)[source]
Return type:

None

class opentelemetry.instrumentation.dbapi.TracedConnectionProxy(connection, db_api_integration=None)[source]

Bases: ObjectProxy, Generic[ConnectionT]

cursor(*args, **kwargs)[source]
opentelemetry.instrumentation.dbapi.get_traced_connection_proxy(connection, db_api_integration, *args, **kwargs)[source]
Return type:

TracedConnectionProxy[TypeVar(ConnectionT)]

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

Bases: Generic[CursorT]

get_operation_name(cursor, args)[source]
Return type:

str

get_statement(cursor, args)[source]
traced_execution(cursor, query_method, *args, **kwargs)[source]
class opentelemetry.instrumentation.dbapi.TracedCursorProxy(cursor, db_api_integration)[source]

Bases: ObjectProxy, Generic[CursorT]

execute(*args, **kwargs)[source]
executemany(*args, **kwargs)[source]
callproc(*args, **kwargs)[source]
opentelemetry.instrumentation.dbapi.get_traced_cursor_proxy(cursor, db_api_integration, *args, **kwargs)[source]
Return type:

TracedCursorProxy[TypeVar(CursorT)]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4