Added enable commenter

CHANGELOG.md

@@ -1298,3 +1298,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `opentelemetry-ext-wsgi` Initial release
 - `opentelemetry-ext-http-requests` Initial release
+
+### Added
+
+- 'Added Enable_commenter for mysql
+  ([[#1387](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/1387)])

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

@@ -18,6 +18,47 @@
 
 .. _mysql-connector: https://pypi.org/project/mysql-connector/
 
+SQLCOMMENTER
+*****************************************
+You can optionally configure Psycopg2 instrumentation to enable sqlcommenter which enriches
+the query with contextual information.
+Usage
+-----
+.. code:: python
+    from opentelemetry.instrumentation.mysql import MySQLInstrumentor()
+    MySQLInstrumentor().instrument(enable_commenter=True, commenter_options={})
+For example,
+::
+   Invoking cursor.execute("select * from auth_users") will lead to sql query "select * from auth_users" but when SQLCommenter is enabled
+   the query will get appended with some configurable tags like "select * from auth_users /*tag=value*/;"
+SQLCommenter Configurations
+***************************
+We can configure the tags to be appended to the sqlquery log by adding configuration inside commenter_options(default:{}) keyword
+db_driver = True(Default) or False
+For example,
+::
+Enabling this flag will add mysql and its version.
+dbapi_threadsafety = True(Default) or False
+For example,
+::
+Enabling this flag will add threadsafety /*dbapi_threadsafety=2*/
+dbapi_level = True(Default) or False
+For example,
+::
+Enabling this flag will add dbapi_level /*dbapi_level='2.0'*/
+libpq_version = True(Default) or False
+For example,
+::
+Enabling this flag will add libpq_version /*libpq_version=140001*/
+driver_paramstyle = True(Default) or False
+For example,
+::
+Enabling this flag will add driver_paramstyle /*driver_paramstyle='pyformat'*/
+opentelemetry_values = True(Default) or False
+For example,
+::
+Enabling this flag will add traceparent values /*traceparent='00-03afa25236b8cd948fa853d67038ac79-405ff022e8247c46-01'*/
+
 Usage
 -----
 
@@ -66,6 +107,8 @@ def _instrument(self, **kwargs):
         https://dev.mysql.com/doc/connector-python/en/
         """
         tracer_provider = kwargs.get("tracer_provider")
+        enable_sqlcommenter = kwargs.get("enable_commenter", False)
+        commenter_options = kwargs.get("commenter_options", {})
 
         dbapi.wrap_connect(
             __name__,
@@ -75,6 +118,8 @@ def _instrument(self, **kwargs):
             self._CONNECTION_ATTRIBUTES,
             version=__version__,
             tracer_provider=tracer_provider,
+            enable_commenter=enable_sqlcommenter,
+            commenter_options=commenter_options,
         )
 
     def _uninstrument(self, **kwargs):

instrumentation/opentelemetry-instrumentation-mysql/tests/test_mysql_integration.py

@@ -117,3 +117,27 @@ def test_uninstrument_connection(self, mock_connect):
 
         spans_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans_list), 1)
+
+    @patch("mysql.connector.connect", new=mock_connect)
+    @patch("opentelemetry.instrumentation.dbapi.wrap_connect")
+    # pylint: disable=unused-argument
+    def test_sqlcommenter_enabled(self, event_mocked):
+        cnx = mysql.connector.connect(database="test")
+        MySQLInstrumentor().instrument(enable_commenter=True)
+        query = "SELECT * FROM test"
+        cursor = cnx.cursor()
+        cursor.execute(query)
+        kwargs = event_mocked.call_args[1]
+        self.assertEqual(kwargs["enable_commenter"], True)
+
+    @patch("mysql.connector.connect", new=mock_connect)
+    @patch("opentelemetry.instrumentation.dbapi.wrap_connect")
+    # pylint: disable=unused-argument
+    def test_sqlcommenter_disabled(self, event_mocked):
+        cnx = mysql.connector.connect(database="test")
+        MySQLInstrumentor().instrument(enable_commenter=False)
+        query = "SELECT * FROM test"
+        cursor = cnx.cursor()
+        cursor.execute(query)
+        kwargs = event_mocked.call_args[1]
+        self.assertEqual(kwargs["enable_commenter"], False)