Update doc

tammy-baylis-swi · Nov 28, 2024 · da13a71 · da13a71
1 parent 762eea9
commit da13a71
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/...n/opentelemetry-instrumentation-mysql/src/opentelemetry/instrumentation/mysql/__init__.py b/...n/opentelemetry-instrumentation-mysql/src/opentelemetry/instrumentation/mysql/__init__.py
@@ -63,6 +63,9 @@
    the query will get appended with some configurable tags like "INSERT INTO test (testField) VALUES (123) /*tag=value*/;"
 
 
+Note that sqlcommenter for mysql-connector is not supported if cursor is initialized with `prepared=True`, which would natively prepare and execute MySQL statements. Adding sqlcommenting would introduce a severe performance penalty by repeating `Prepare` of statements by mysql-connector that are made unique by traceparent in sqlcomment. Therefore, sqlcommenter is not supported for this use case.
+
+
 SQLCommenter Configurations
 ***************************
 We can configure the tags to be appended to the sqlquery log by adding configuration inside commenter_options(default:{}) keyword