ext/pymysql: Implement instrumentor interface

- Implement instrumentor interface to be usable by autoinstrumentation
- Provide mechanishm to uninstrument

Author: mauriciovasquezbernal

ext/opentelemetry-ext-docker-tests/tests/pymysql/test_pymysql_functional.py

@@ -17,7 +17,7 @@
 import pymysql as pymy
 
 from opentelemetry import trace as trace_api
-from opentelemetry.ext.pymysql import trace_integration
+from opentelemetry.ext.pymysql import PymysqlInstrumentor
 from opentelemetry.test.test_base import TestBase
 
 MYSQL_USER = os.getenv("MYSQL_USER ", "testuser")
@@ -34,7 +34,7 @@ def setUpClass(cls):
         cls._connection = None
         cls._cursor = None
         cls._tracer = cls.tracer_provider.get_tracer(__name__)
-        trace_integration()
+        PymysqlInstrumentor().instrument()
         cls._connection = pymy.connect(
             user=MYSQL_USER,
             password=MYSQL_PASSWORD,

ext/opentelemetry-ext-pymysql/setup.cfg

@@ -42,6 +42,7 @@ packages=find_namespace:
 install_requires =
     opentelemetry-api == 0.7.dev0
     opentelemetry-ext-dbapi == 0.7.dev0
+    opentelemetry-auto-instrumentation == 0.7.dev0
     PyMySQL ~=  0.9.3
 
 [options.extras_require]
@@ -50,3 +51,7 @@ test =
 
 [options.packages.find]
 where = src
+
+[options.entry_points]
+opentelemetry_instrumentor =
+    pymysql = opentelemetry.ext.pymysql:PymysqlInstrumentor

ext/opentelemetry-ext-pymysql/src/opentelemetry/ext/pymysql/__init__.py

@@ -45,24 +45,30 @@
 
 import pymysql
 
-from opentelemetry.ext.dbapi import wrap_connect
+from opentelemetry.auto_instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.ext.dbapi import unwrap_connect, wrap_connect
 from opentelemetry.ext.pymysql.version import __version__
 from opentelemetry.trace import TracerProvider, get_tracer
 
 
-def trace_integration(tracer_provider: typing.Optional[TracerProvider] = None):
-    """Integrate with the PyMySQL library.
-       https://github.com/PyMySQL/PyMySQL/
-    """
+class PymysqlInstrumentor(BaseInstrumentor):
+    def _instrument(self, **kwargs):
+        """Integrate with the PyMySQL library.
+        https://github.com/PyMySQL/PyMySQL/
+        """
+        tracer_provider = kwargs.get("tracer_provider")
 
-    tracer = get_tracer(__name__, __version__, tracer_provider)
+        tracer = get_tracer(__name__, __version__, tracer_provider)
 
-    connection_attributes = {
-        "database": "db",
-        "port": "port",
-        "host": "host",
-        "user": "user",
-    }
-    wrap_connect(
-        tracer, pymysql, "connect", "mysql", "sql", connection_attributes
-    )
+        connection_attributes = {
+            "database": "db",
+            "port": "port",
+            "host": "host",
+            "user": "user",
+        }
+        wrap_connect(
+            tracer, pymysql, "connect", "mysql", "sql", connection_attributes
+        )
+
+    def _uninstrument(self, **kwargs):
+        unwrap_connect(pymysql, "connect")

ext/opentelemetry-ext-pymysql/tests/test_pymysql_integration.py

@@ -17,22 +17,35 @@
 import pymysql
 
 import opentelemetry.ext.pymysql
-from opentelemetry.ext.pymysql import trace_integration
+from opentelemetry.ext.pymysql import PymysqlInstrumentor
 from opentelemetry.test.test_base import TestBase
 
 
 class TestPyMysqlIntegration(TestBase):
-    def test_trace_integration(self):
-        with mock.patch("pymysql.connect"):
-            trace_integration()
-            cnx = pymysql.connect(database="test")
-            cursor = cnx.cursor()
-            query = "SELECT * FROM test"
-            cursor.execute(query)
+    @mock.patch("pymysql.connect")
+    # pylint: disable=unused-argument
+    def test_instrumentor(self, mock_connect):
+        PymysqlInstrumentor().instrument()
+
+        cnx = pymysql.connect(database="test")
+        cursor = cnx.cursor()
+        query = "SELECT * FROM test"
+        cursor.execute(query)
 
         spans_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(spans_list), 1)
         span = spans_list[0]
 
         # Check version and name in span's instrumentation info
         self.check_span_instrumentation_info(span, opentelemetry.ext.pymysql)
+
+        # check that no spans are generated ater uninstrument
+        PymysqlInstrumentor().uninstrument()
+
+        cnx = pymysql.connect(database="test")
+        cursor = cnx.cursor()
+        query = "SELECT * FROM test"
+        cursor.execute(query)
+
+        spans_list = self.memory_exporter.get_finished_spans()
+        self.assertEqual(len(spans_list), 1)

tox.ini

@@ -176,6 +176,7 @@ commands_pre =
   psycopg2: pip install {toxinidir}/ext/opentelemetry-ext-dbapi
   psycopg2: pip install {toxinidir}/ext/opentelemetry-ext-psycopg2
 
+  pymysql: pip install {toxinidir}/opentelemetry-auto-instrumentation
   pymysql: pip install {toxinidir}/ext/opentelemetry-ext-dbapi
   pymysql: pip install {toxinidir}/ext/opentelemetry-ext-pymysql[test]
 
@@ -286,6 +287,7 @@ changedir =
 commands_pre =
   pip install -e {toxinidir}/opentelemetry-api \
               -e {toxinidir}/opentelemetry-sdk \
+              -e {toxinidir}/opentelemetry-auto-instrumentation \
               -e {toxinidir}/tests/util \
               -e {toxinidir}/ext/opentelemetry-ext-dbapi \
               -e {toxinidir}/ext/opentelemetry-ext-mysql \