OpenTelemetry MySQL Instrumentation
MySQL instrumentation supporting mysql-connector, it can be enabled by
using MySQLInstrumentor.
Usage
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()
Configuration
SQLCommenter
You can optionally enable sqlcommenter which enriches the query with contextual
information. Queries made after setting up trace integration with sqlcommenter
enabled will have configurable key-value pairs appended to them, e.g.
"select * from auth_users; /*traceparent=00-01234567-abcd-01*/". This
supports context propagation between database client and server when database log
records are enabled. For more information, see:
import mysql.connector
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
MySQLInstrumentor().instrument(enable_commenter=True)
cnx = mysql.connector.connect(database="MySQL_Database")
cursor = cnx.cursor()
cursor.execute("INSERT INTO test (testField) VALUES (123)")
cursor.close()
cnx.close()
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.
SQLCommenter with commenter_options
The key-value pairs appended to the query can be configured using
commenter_options. When sqlcommenter is enabled, all available KVs/tags
are calculated by default. commenter_options supports opting out
of specific KVs.
import mysql.connector
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
# Opts into sqlcomment for mysql-connector trace integration.
# Opts out of tags for mysql_client_version, db_driver.
MySQLInstrumentor().instrument(
enable_commenter=True,
commenter_options={
"mysql_client_version": False,
"db_driver": False,
}
)
Available commenter_options
The following sqlcomment key-values can be opted out of through commenter_options:
Commenter Option |
Description |
Example |
|---|---|---|
|
Database driver name with version (URL encoded). |
|
|
DB-API threadsafety value: 0-3 or unknown. |
|
|
DB-API API level: 1.0, 2.0, or unknown. |
|
|
DB-API paramstyle for SQL statement parameter. |
|
|
MySQL client version. |
|
|
OpenTelemetry context as traceparent at time of query. |
|
SQLComment in span attribute
If sqlcommenter is enabled, you can opt into the inclusion of sqlcomment in
the query span db.statement attribute for your needs. If commenter_options
have been set, the span attribute comment will also be configured by this
setting.
from opentelemetry.instrumentation.mysql import MySQLInstrumentor
# Opts into sqlcomment for mysql-connector trace integration.
# Opts into sqlcomment for `db.statement` span attribute.
MySQLInstrumentor().instrument(
enable_commenter=True,
enable_attribute_commenter=True,
)
Warning
Capture of sqlcomment in db.statement may have high cardinality without platform normalization. See Semantic Conventions for database spans for more information.
API
- class opentelemetry.instrumentation.mysql.MySQLInstrumentor(*args, **kwargs)[source]
Bases:
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 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.
- instrument_connection(connection, tracer_provider=None, enable_commenter=None, commenter_options=None, enable_attribute_commenter=None)[source]
Enable instrumentation in a MySQL connection.
- Parameters:
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.
- Returns:
An instrumented MySQL connection with OpenTelemetry tracing enabled.