Add warning about db.statement cardinality

tammy-baylis-swi · tammy-baylis-swi · commit 53fe6610d284 · 2025-10-17T19:57:06.000-07:00
diff --git a/instrumentation/opentelemetry-instrumentation-mysql/src/opentelemetry/instrumentation/mysql/__init__.py b/instrumentation/opentelemetry-instrumentation-mysql/src/opentelemetry/instrumentation/mysql/__init__.py
@@ -142,6 +142,9 @@
         enable_attribute_commenter=True,
     )
 
+Warning:
+    Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
+
 API
 ---
 """
diff --git a/instrumentation/opentelemetry-instrumentation-mysqlclient/src/opentelemetry/instrumentation/mysqlclient/__init__.py b/instrumentation/opentelemetry-instrumentation-mysqlclient/src/opentelemetry/instrumentation/mysqlclient/__init__.py
@@ -127,6 +127,9 @@
         enable_attribute_commenter=True,
     )
 
+Warning:
+    Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
+    
 API
 ---
 """
diff --git a/instrumentation/opentelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.py b/instrumentation/opentelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.py
@@ -150,6 +150,9 @@
         enable_attribute_commenter=True,
     )
 
+Warning:
+    Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
+
 API
 ---
 """

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,9 @@`
`142`	`142`	`enable_attribute_commenter=True,`
`143`	`143`	`)`
`144`	`144`
	`145`	`+Warning:`
	`146`	+ Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
	`147`	`+`
`145`	`148`	`API`
`146`	`149`	`---`
`147`	`150`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -127,6 +127,9 @@`
`127`	`127`	`enable_attribute_commenter=True,`
`128`	`128`	`)`
`129`	`129`
	`130`	`+Warning:`
	`131`	+ Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
	`132`	`+`
`130`	`133`	`API`
`131`	`134`	`---`
`132`	`135`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -150,6 +150,9 @@`
`150`	`150`	`enable_attribute_commenter=True,`
`151`	`151`	`)`
`152`	`152`
	`153`	`+Warning:`
	`154`	+ Capture of sqlcomment in ``db.statement`` may have high cardinality without platform normalization. See `Semantic Conventions for database spans <https://opentelemetry.io/docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-query-text>`_ for more information.
	`155`	`+`
`153`	`156`	`API`
`154`	`157`	`---`
`155`	`158`	`"""`