MySQL instrumentation supporting mysql-connector, it can be enabled by using MySQLInstrumentor.
import mysql.connector
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
# Call instrument() to wrap all database connections
MySQLInstrumentor().instrument()
cnx = mysql.connector.connect(database="MySQL_Database")
cursor = cnx.cursor()
cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
cursor.execute("INSERT INTO test (testField) VALUES (123)")
cursor.close()
cnx.close()
import mysql.connector
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
# Alternatively, use instrument_connection for an individual connection
cnx = mysql.connector.connect(database="MySQL_Database")
instrumented_cnx = MySQLInstrumentor().instrument_connection(cnx)
cursor = instrumented_cnx.cursor()
cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
cursor.execute("INSERT INTO test (testField) VALUES (123)")
cursor.close()
instrumented_cnx.close()
Usage
import mysql.connector
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
MySQLInstrumentor().instrument(enable_commenter=True, commenter_options={})
cnx = mysql.connector.connect(database="MySQL_Database")
cursor = cnx.cursor()
cursor.execute("INSERT INTO test (testField) VALUES (123)")
cursor.close()
cnx.close()
For example,
Invoking cursor.execute("INSERT INTO test (testField) VALUES (123)") will lead to sql query "INSERT INTO test (testField) VALUES (123)" but when SQLCommenter is enabled
the query will get appended with some configurable tags like "INSERT INTO test (testField) VALUES (123) /*tag=value*/;"
WARNING: sqlcommenter for mysql-connector instrumentation should NOT be used if your application initializes cursors with prepared=True, which will natively prepare and execute MySQL statements. Adding sqlcommenting will introduce a severe performance penalty by repeating Prepare of statements by mysql-connector that are made unique by traceparent in sqlcomment. The penalty does not happen if cursor prepared=False (default) and instrumentor enable_commenter=True.
Bases: BaseInstrumentor
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.
Enable instrumentation in a MySQL connection.
connection – The existing MySQL connection instance to instrument. This connection is typically obtained through mysql.connector.connect() and is instrumented to collect telemetry data about database interactions.
tracer_provider – An optional TracerProvider instance to use for tracing. If not provided, the globally configured tracer provider will be automatically used.
enable_commenter – Optional flag to enable/disable sqlcommenter (default False).
commenter_options – Optional configurations for tags to be appended at the sql query.
enable_attribute_commenter – Optional flag to enable/disable addition of sqlcomment to span attribute (default False). Requires enable_commenter=True.
An instrumented MySQL connection with OpenTelemetry tracing enabled.
Disable instrumentation in a MySQL connection.
connection – The connection to uninstrument.
An uninstrumented connection.
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