feat(tortoiseorm): replace db.statement.parameters with db.query.parameter.<key>

Replace db.statement.parameters with individual db.query.parameter.<key>
attributes. Tortoise parameters are always positional (tuple from
args[1:]), so a simple indexed loop is used.

Author: Lotram

instrumentation/opentelemetry-instrumentation-tortoiseorm/src/opentelemetry/instrumentation/tortoiseorm/__init__.py

@@ -54,6 +54,7 @@
 )
 from opentelemetry.semconv._incubating.attributes.db_attributes import (
     DB_NAME,
+    DB_QUERY_PARAMETER_TEMPLATE,
     DB_STATEMENT,
     DB_SYSTEM,
     DB_USER,
@@ -237,7 +238,9 @@ def _uninstrument(self, **kwargs):
             tortoise.contrib.pydantic.base.PydanticListModel, "from_queryset"
         )
 
-    def _hydrate_span_from_args(self, connection, query, parameters) -> dict:
+    def _hydrate_span_from_args(  # pylint: disable=too-many-branches
+        self, connection, query, parameters
+    ) -> dict:
         """Get network and database attributes from connection."""
         span_attributes = {}
         capabilities = getattr(connection, "capabilities", None)
@@ -268,7 +271,10 @@ def _hydrate_span_from_args(self, connection, query, parameters) -> dict:
 
         if self.capture_parameters:
             if parameters is not None and len(parameters) > 0:
-                span_attributes["db.statement.parameters"] = str(parameters)
+                for idx, value in enumerate(parameters):
+                    span_attributes[f"{DB_QUERY_PARAMETER_TEMPLATE}.{idx}"] = (
+                        repr(value)
+                    )
 
         return span_attributes
 

instrumentation/opentelemetry-instrumentation-tortoiseorm/tests/test_tortoiseorm_instrumentation.py

@@ -21,6 +21,7 @@
 from opentelemetry.instrumentation.utils import suppress_instrumentation
 from opentelemetry.semconv._incubating.attributes.db_attributes import (
     DB_NAME,
+    DB_QUERY_PARAMETER_TEMPLATE,
     DB_STATEMENT,
     DB_SYSTEM,
 )
@@ -30,6 +31,7 @@
 class MockModel(models.Model):
     id = fields.IntField(pk=True)
     name = fields.TextField()
+    description = fields.TextField(default="")
 
     def __str__(self):
         return self.name
@@ -87,15 +89,31 @@ def test_capture_parameters(self):
 
         async def run():
             await self._init_tortoise()
-            await MockModel.create(name="Test Parameterized")
+            await MockModel.create(
+                name="Test Capture Params", description="Multiple Params"
+            )
 
         self._async_call(run())
         spans = self.memory_exporter.get_finished_spans()
         insert_span = next(s for s in spans if s.name == "INSERT")
-        self.assertIn("db.statement.parameters", insert_span.attributes)
-        self.assertIn(
-            "Test Parameterized",
-            insert_span.attributes["db.statement.parameters"],
+        self.assertEqual(
+            insert_span.attributes[f"{DB_QUERY_PARAMETER_TEMPLATE}.0"],
+            "['Test Capture Params', 'Multiple Params']",
+        )
+
+    def test_capture_no_parameters(self):
+        TortoiseORMInstrumentor().uninstrument()
+        TortoiseORMInstrumentor().instrument(capture_parameters=True)
+
+        async def run():
+            await self._init_tortoise()
+            await MockModel.all()
+
+        self._async_call(run())
+        spans = self.memory_exporter.get_finished_spans()
+        select_span = next(s for s in spans if s.name == "SELECT")
+        self.assertNotIn(
+            f"{DB_QUERY_PARAMETER_TEMPLATE}.0", select_span.attributes
         )
 
     def test_uninstrument(self):