Skip to content

Commit 38c6408

Browse files
committed
Refactor TracedConnectionProxy
Fixes #1077
1 parent 10659f8 commit 38c6408

File tree

3 files changed

+56
-33
lines changed

3 files changed

+56
-33
lines changed

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

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ def uninstrument_connection(connection):
214214
Returns:
215215
An uninstrumented connection.
216216
"""
217-
if isinstance(connection, wrapt.ObjectProxy):
218-
return connection.__wrapped__
217+
if isinstance(connection, _TracedConnectionProxy):
218+
return connection._connection
219219

220220
_logger.warning("Connection is not instrumented")
221221
return connection
@@ -300,28 +300,36 @@ def get_connection_attributes(self, connection):
300300
self.span_attributes[SpanAttributes.NET_PEER_PORT] = port
301301

302302

303+
class _TracedConnectionProxy:
304+
pass
305+
306+
303307
def get_traced_connection_proxy(
304308
connection, db_api_integration, *args, **kwargs
305309
):
306310
# pylint: disable=abstract-method
307-
class TracedConnectionProxy(wrapt.ObjectProxy):
308-
# pylint: disable=unused-argument
309-
def __init__(self, connection, *args, **kwargs):
310-
wrapt.ObjectProxy.__init__(self, connection)
311+
class TracedConnectionProxy(type(connection), _TracedConnectionProxy):
312+
def __init__(self, connection):
313+
self._connection = connection
311314

312-
def cursor(self, *args, **kwargs):
313-
return get_traced_cursor_proxy(
314-
self.__wrapped__.cursor(*args, **kwargs), db_api_integration
315+
def __getattr__(self, name):
316+
return object.__getattribute__(
317+
object.__getattribute__(self, "_connection"), name
315318
)
316319

317320
def __enter__(self):
318-
self.__wrapped__.__enter__()
319-
return self
321+
self._connection.__enter__()
322+
return self._connection
320323

321-
def __exit__(self, *args, **kwargs):
322-
self.__wrapped__.__exit__(*args, **kwargs)
324+
def __exit__(self, exc_type, exc_value, traceback):
325+
self._connection.__exit__(exc_type, exc_value, traceback)
326+
327+
def cursor(self, *args, **kwargs):
328+
return get_traced_cursor_proxy(
329+
self._connection.cursor(*args, **kwargs), db_api_integration
330+
)
323331

324-
return TracedConnectionProxy(connection, *args, **kwargs)
332+
return TracedConnectionProxy(connection)
325333

326334

327335
class CursorTracer:

instrumentation/opentelemetry-instrumentation-dbapi/tests/test_dbapi_integration.py

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -262,14 +262,14 @@ def test_callproc(self):
262262

263263
@mock.patch("opentelemetry.instrumentation.dbapi")
264264
def test_wrap_connect(self, mock_dbapi):
265-
dbapi.wrap_connect(self.tracer, mock_dbapi, "connect", "-")
265+
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
266266
connection = mock_dbapi.connect()
267267
self.assertEqual(mock_dbapi.connect.call_count, 1)
268-
self.assertIsInstance(connection.__wrapped__, mock.Mock)
268+
self.assertIsInstance(connection._connection, mock.Mock)
269269

270270
@mock.patch("opentelemetry.instrumentation.dbapi")
271271
def test_unwrap_connect(self, mock_dbapi):
272-
dbapi.wrap_connect(self.tracer, mock_dbapi, "connect", "-")
272+
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
273273
connection = mock_dbapi.connect()
274274
self.assertEqual(mock_dbapi.connect.call_count, 1)
275275

@@ -279,19 +279,21 @@ def test_unwrap_connect(self, mock_dbapi):
279279
self.assertIsInstance(connection, mock.Mock)
280280

281281
def test_instrument_connection(self):
282-
connection = mock.Mock()
282+
connection = MockConnectionEmpty()
283283
# Avoid get_attributes failing because can't concatenate mock
284+
# pylint: disable=attribute-defined-outside-init
284285
connection.database = "-"
285286
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
286-
self.assertIs(connection2.__wrapped__, connection)
287+
self.assertIs(connection2._connection, connection)
287288

288289
def test_uninstrument_connection(self):
289-
connection = mock.Mock()
290+
connection = MockConnectionEmpty()
290291
# Set connection.database to avoid a failure because mock can't
291292
# be concatenated
293+
# pylint: disable=attribute-defined-outside-init
292294
connection.database = "-"
293295
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
294-
self.assertIs(connection2.__wrapped__, connection)
296+
self.assertIs(connection2._connection, connection)
295297

296298
connection3 = dbapi.uninstrument_connection(connection2)
297299
self.assertIs(connection3, connection)
@@ -307,10 +309,12 @@ def mock_connect(*args, **kwargs):
307309
server_host = kwargs.get("server_host")
308310
server_port = kwargs.get("server_port")
309311
user = kwargs.get("user")
310-
return MockConnection(database, server_port, server_host, user)
312+
return MockConnectionWithAttributes(
313+
database, server_port, server_host, user
314+
)
311315

312316

313-
class MockConnection:
317+
class MockConnectionWithAttributes:
314318
def __init__(self, database, server_port, server_host, user):
315319
self.database = database
316320
self.server_port = server_port
@@ -343,3 +347,7 @@ def executemany(self, query, params=None, throw_exception=False):
343347
def callproc(self, query, params=None, throw_exception=False):
344348
if throw_exception:
345349
raise Exception("Test Exception")
350+
351+
352+
class MockConnectionEmpty:
353+
pass

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

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
from unittest import mock
15+
from unittest.mock import Mock, patch
1616

1717
import mysql.connector
1818

@@ -22,15 +22,23 @@
2222
from opentelemetry.test.test_base import TestBase
2323

2424

25+
def mock_connect(*args, **kwargs):
26+
class MockConnection:
27+
def cursor(self):
28+
return Mock()
29+
30+
return MockConnection()
31+
32+
2533
class TestMysqlIntegration(TestBase):
2634
def tearDown(self):
2735
super().tearDown()
2836
with self.disable_logging():
2937
MySQLInstrumentor().uninstrument()
3038

31-
@mock.patch("mysql.connector.connect")
39+
@patch("mysql.connector.connect", new=mock_connect)
3240
# pylint: disable=unused-argument
33-
def test_instrumentor(self, mock_connect):
41+
def test_instrumentor(self):
3442
MySQLInstrumentor().instrument()
3543

3644
cnx = mysql.connector.connect(database="test")
@@ -58,9 +66,8 @@ def test_instrumentor(self, mock_connect):
5866
spans_list = self.memory_exporter.get_finished_spans()
5967
self.assertEqual(len(spans_list), 1)
6068

61-
@mock.patch("mysql.connector.connect")
62-
# pylint: disable=unused-argument
63-
def test_custom_tracer_provider(self, mock_connect):
69+
@patch("mysql.connector.connect", new=mock_connect)
70+
def test_custom_tracer_provider(self):
6471
resource = resources.Resource.create({})
6572
result = self.create_tracer_provider(resource=resource)
6673
tracer_provider, exporter = result
@@ -77,9 +84,9 @@ def test_custom_tracer_provider(self, mock_connect):
7784

7885
self.assertIs(span.resource, resource)
7986

80-
@mock.patch("mysql.connector.connect")
87+
@patch("mysql.connector.connect", new=mock_connect)
8188
# pylint: disable=unused-argument
82-
def test_instrument_connection(self, mock_connect):
89+
def test_instrument_connection(self):
8390
cnx = mysql.connector.connect(database="test")
8491
query = "SELECT * FROM test"
8592
cursor = cnx.cursor()
@@ -95,9 +102,9 @@ def test_instrument_connection(self, mock_connect):
95102
spans_list = self.memory_exporter.get_finished_spans()
96103
self.assertEqual(len(spans_list), 1)
97104

98-
@mock.patch("mysql.connector.connect")
105+
@patch("mysql.connector.connect", new=mock_connect)
99106
# pylint: disable=unused-argument
100-
def test_uninstrument_connection(self, mock_connect):
107+
def test_uninstrument_connection(self):
101108
MySQLInstrumentor().instrument()
102109
cnx = mysql.connector.connect(database="test")
103110
query = "SELECT * FROM test"

0 commit comments

Comments
 (0)