feat: add support for capture_parameters to Psycopg2Instrumentor (#4212)

* feat: add support for capture_parameters to Psycopg2Instrumentor

* Update CHANGELOG.md

---------

Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com>

Author: gregoiredx

CHANGELOG.md

@@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4289](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4289))
 - `opentelemetry-instrumentation`: Add support for wrapt 2.x
   ([#4203](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4203))
+- `opentelemetry-instrumentation-psycopg2`: Add parameter `capture_parameters` to instrumentor.
+  ([#4212](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4212))
 
 ### Fixed
 

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

@@ -136,6 +136,19 @@
 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.
 
+Capture parameters
+******************
+By default, only statements are captured, without the associated query parameters.
+To capture query parameters in the span attribute `db.statement.parameters`, enable `capture_parameters`.
+
+.. code:: python
+
+    from opentelemetry.instrumentation.psycopg2 import Psycopg2Instrumentor
+
+    Psycopg2Instrumentor().instrument(
+        capture_parameters=True,
+    )
+
 API
 ---
 """
@@ -213,6 +226,7 @@ def _instrument(self, **kwargs):
         enable_attribute_commenter = kwargs.get(
             "enable_attribute_commenter", False
         )
+        capture_parameters = kwargs.get("capture_parameters", False)
         dbapi.wrap_connect(
             __name__,
             psycopg2,
@@ -225,6 +239,7 @@ def _instrument(self, **kwargs):
             enable_commenter=enable_sqlcommenter,
             commenter_options=commenter_options,
             enable_attribute_commenter=enable_attribute_commenter,
+            capture_parameters=capture_parameters,
         )
 
     def _uninstrument(self, **kwargs):

instrumentation/opentelemetry-instrumentation-psycopg2/tests/test_psycopg2_instrumentation.py

@@ -15,14 +15,21 @@
 from unittest import TestCase
 from unittest.mock import Mock, call, patch
 
+import psycopg2
+
 from opentelemetry.instrumentation.auto_instrumentation._load import (
     _load_instrumentors,
 )
-from opentelemetry.instrumentation.psycopg2 import Psycopg2Instrumentor
+from opentelemetry.instrumentation.psycopg2 import (
+    DatabaseApiIntegration,
+    Psycopg2Instrumentor,
+)
 from opentelemetry.instrumentation.psycopg2.package import (
     _instruments_psycopg2,
     _instruments_psycopg2_binary,
 )
+from opentelemetry.instrumentation.psycopg2.version import __version__
+from opentelemetry.test.test_base import TestBase
 
 
 class TestPsycopg2InstrumentationDependencies(TestCase):
@@ -160,3 +167,41 @@ def _instrumentation_loaded_successfully_call():
         mock_logger.debug.assert_has_calls(
             [_instrumentation_loaded_successfully_call()]
         )
+
+
+@patch("opentelemetry.instrumentation.psycopg2.dbapi")
+class TestPsycopg2InstrumentorParameters(TestBase):
+    def tearDown(self):
+        super().tearDown()
+        with self.disable_logging():
+            Psycopg2Instrumentor().uninstrument()
+
+    def test_instrument_defaults(self, mock_dbapi):  # pylint: disable=no-self-use
+        Psycopg2Instrumentor().instrument()
+
+        mock_dbapi.wrap_connect.assert_called_once_with(
+            "opentelemetry.instrumentation.psycopg2",
+            psycopg2,
+            "connect",
+            "postgresql",
+            {
+                "database": "info.dbname",
+                "port": "info.port",
+                "host": "info.host",
+                "user": "info.user",
+            },
+            version=__version__,
+            tracer_provider=None,
+            db_api_integration_factory=DatabaseApiIntegration,
+            enable_commenter=False,
+            commenter_options={},
+            enable_attribute_commenter=False,
+            capture_parameters=False,
+        )
+
+    def test_instrument_capture_parameters(self, mock_dbapi):
+        Psycopg2Instrumentor().instrument(capture_parameters=True)
+
+        self.assertTrue(
+            mock_dbapi.wrap_connect.call_args.kwargs["capture_parameters"]
+        )

instrumentation/opentelemetry-instrumentation-psycopg2/tests/test_psycopg2_integration.py

@@ -371,3 +371,24 @@ def test_no_op_tracer_provider(self):
         cursor.execute(query)
         spans_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans_list), 0)
+
+    def test_span_capture_params_deactivated_by_default(self):
+        Psycopg2Instrumentor().instrument()
+        cnx = psycopg2.connect(database="test")
+        cursor = cnx.cursor()
+        query = "SELECT * FROM test WHERE id = %s AND name = %s"
+        cursor.execute(query, (42, "John Doe"))
+        spans_list = self.memory_exporter.get_finished_spans()
+        self.assertNotIn("db.statement.parameters", spans_list[0].attributes)
+
+    def test_span_capture_params_activated(self):
+        Psycopg2Instrumentor().instrument(capture_parameters=True)
+        cnx = psycopg2.connect(database="test")
+        cursor = cnx.cursor()
+        query = "SELECT * FROM test WHERE id = %s AND name = %s"
+        cursor.execute(query, (42, "John Doe"))
+        spans_list = self.memory_exporter.get_finished_spans()
+        self.assertEqual(
+            spans_list[0].attributes["db.statement.parameters"],
+            "(42, 'John Doe')",
+        )