mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-29 13:12:39 +08:00
417 lines
15 KiB
Python
417 lines
15 KiB
Python
# Copyright The OpenTelemetry Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
|
|
import logging
|
|
from unittest import mock
|
|
|
|
from opentelemetry import context
|
|
from opentelemetry import trace as trace_api
|
|
from opentelemetry.instrumentation import dbapi
|
|
from opentelemetry.sdk import resources
|
|
from opentelemetry.semconv.trace import SpanAttributes
|
|
from opentelemetry.test.test_base import TestBase
|
|
|
|
|
|
class TestDBApiIntegration(TestBase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.tracer = self.tracer_provider.get_tracer(__name__)
|
|
|
|
def test_span_succeeded(self):
|
|
connection_props = {
|
|
"database": "testdatabase",
|
|
"server_host": "testhost",
|
|
"server_port": 123,
|
|
"user": "testuser",
|
|
}
|
|
connection_attributes = {
|
|
"database": "database",
|
|
"port": "server_port",
|
|
"host": "server_host",
|
|
"user": "user",
|
|
}
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname", "testcomponent", connection_attributes
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, connection_props
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.execute("Test query", ("param1Value", False))
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(span.name, "Test")
|
|
self.assertIs(span.kind, trace_api.SpanKind.CLIENT)
|
|
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_SYSTEM], "testcomponent"
|
|
)
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_NAME], "testdatabase"
|
|
)
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_STATEMENT], "Test query"
|
|
)
|
|
self.assertFalse("db.statement.parameters" in span.attributes)
|
|
self.assertEqual(span.attributes[SpanAttributes.DB_USER], "testuser")
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.NET_PEER_NAME], "testhost"
|
|
)
|
|
self.assertEqual(span.attributes[SpanAttributes.NET_PEER_PORT], 123)
|
|
self.assertIs(span.status.status_code, trace_api.StatusCode.UNSET)
|
|
|
|
def test_span_name(self):
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname", "testcomponent", {}
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.execute("Test query", ("param1Value", False))
|
|
cursor.execute(
|
|
"""multi
|
|
line
|
|
query"""
|
|
)
|
|
cursor.execute("tab\tseparated query")
|
|
cursor.execute("/* leading comment */ query")
|
|
cursor.execute("/* leading comment */ query /* trailing comment */")
|
|
cursor.execute("query /* trailing comment */")
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 6)
|
|
self.assertEqual(spans_list[0].name, "Test")
|
|
self.assertEqual(spans_list[1].name, "multi")
|
|
self.assertEqual(spans_list[2].name, "tab")
|
|
self.assertEqual(spans_list[3].name, "query")
|
|
self.assertEqual(spans_list[4].name, "query")
|
|
self.assertEqual(spans_list[5].name, "query")
|
|
|
|
def test_span_succeeded_with_capture_of_statement_parameters(self):
|
|
connection_props = {
|
|
"database": "testdatabase",
|
|
"server_host": "testhost",
|
|
"server_port": 123,
|
|
"user": "testuser",
|
|
}
|
|
connection_attributes = {
|
|
"database": "database",
|
|
"port": "server_port",
|
|
"host": "server_host",
|
|
"user": "user",
|
|
}
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname",
|
|
"testcomponent",
|
|
connection_attributes,
|
|
capture_parameters=True,
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, connection_props
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.execute("Test query", ("param1Value", False))
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(span.name, "Test")
|
|
self.assertIs(span.kind, trace_api.SpanKind.CLIENT)
|
|
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_SYSTEM], "testcomponent"
|
|
)
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_NAME], "testdatabase"
|
|
)
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_STATEMENT], "Test query"
|
|
)
|
|
self.assertEqual(
|
|
span.attributes["db.statement.parameters"],
|
|
"('param1Value', False)",
|
|
)
|
|
self.assertEqual(span.attributes[SpanAttributes.DB_USER], "testuser")
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.NET_PEER_NAME], "testhost"
|
|
)
|
|
self.assertEqual(span.attributes[SpanAttributes.NET_PEER_PORT], 123)
|
|
self.assertIs(span.status.status_code, trace_api.StatusCode.UNSET)
|
|
|
|
def test_span_not_recording(self):
|
|
connection_props = {
|
|
"database": "testdatabase",
|
|
"server_host": "testhost",
|
|
"server_port": 123,
|
|
"user": "testuser",
|
|
}
|
|
connection_attributes = {
|
|
"database": "database",
|
|
"port": "server_port",
|
|
"host": "server_host",
|
|
"user": "user",
|
|
}
|
|
mock_span = mock.Mock()
|
|
mock_span.is_recording.return_value = False
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname", "testcomponent", connection_attributes
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, connection_props
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.execute("Test query", ("param1Value", False))
|
|
self.assertFalse(mock_span.is_recording())
|
|
self.assertTrue(mock_span.is_recording.called)
|
|
self.assertFalse(mock_span.set_attribute.called)
|
|
self.assertFalse(mock_span.set_status.called)
|
|
|
|
def test_span_failed(self):
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
self.tracer, "testcomponent"
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
with self.assertRaises(Exception):
|
|
cursor.execute("Test query", throw_exception=True)
|
|
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_STATEMENT], "Test query"
|
|
)
|
|
self.assertIs(span.status.status_code, trace_api.StatusCode.ERROR)
|
|
self.assertEqual(span.status.description, "Exception: Test Exception")
|
|
|
|
def test_custom_tracer_provider_dbapi(self):
|
|
resource = resources.Resource.create({"db-resource-key": "value"})
|
|
result = self.create_tracer_provider(resource=resource)
|
|
tracer_provider, exporter = result
|
|
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
self.tracer, "testcomponent", tracer_provider=tracer_provider
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
with self.assertRaises(Exception):
|
|
cursor.execute("Test query", throw_exception=True)
|
|
|
|
spans_list = exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(span.resource.attributes["db-resource-key"], "value")
|
|
self.assertIs(span.status.status_code, trace_api.StatusCode.ERROR)
|
|
|
|
def test_no_op_tracer_provider(self):
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
self.tracer,
|
|
"testcomponent",
|
|
tracer_provider=trace_api.NoOpTracerProvider(),
|
|
)
|
|
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.executemany("Test query")
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 0)
|
|
|
|
def test_executemany(self):
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname", "testcomponent"
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.executemany("Test query")
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_STATEMENT], "Test query"
|
|
)
|
|
|
|
def test_executemany_comment(self):
|
|
connect_module = mock.MagicMock()
|
|
connect_module.__version__ = mock.MagicMock()
|
|
connect_module.__libpq_version__ = 123
|
|
connect_module.apilevel = 123
|
|
connect_module.threadsafety = 123
|
|
connect_module.paramstyle = "test"
|
|
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname",
|
|
"testcomponent",
|
|
enable_commenter=True,
|
|
commenter_options={"db_driver": False, "dbapi_level": False},
|
|
connect_module=connect_module,
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.executemany("Select 1;")
|
|
self.assertRegex(
|
|
cursor.query,
|
|
r"Select 1 /\*dbapi_threadsafety=123,driver_paramstyle='test',libpq_version=123,traceparent='\d{1,2}-[a-zA-Z0-9_]{32}-[a-zA-Z0-9_]{16}-\d{1,2}'\*/;",
|
|
)
|
|
|
|
def test_executemany_flask_integration_comment(self):
|
|
connect_module = mock.MagicMock()
|
|
connect_module.__version__ = mock.MagicMock()
|
|
connect_module.__libpq_version__ = 123
|
|
connect_module.apilevel = 123
|
|
connect_module.threadsafety = 123
|
|
connect_module.paramstyle = "test"
|
|
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname",
|
|
"testcomponent",
|
|
enable_commenter=True,
|
|
commenter_options={"db_driver": False, "dbapi_level": False},
|
|
connect_module=connect_module,
|
|
)
|
|
current_context = context.get_current()
|
|
sqlcommenter_context = context.set_value(
|
|
"SQLCOMMENTER_ORM_TAGS_AND_VALUES", {"flask": 1}, current_context
|
|
)
|
|
context.attach(sqlcommenter_context)
|
|
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.executemany("Select 1;")
|
|
self.assertRegex(
|
|
cursor.query,
|
|
r"Select 1 /\*dbapi_threadsafety=123,driver_paramstyle='test',flask=1,libpq_version=123,traceparent='\d{1,2}-[a-zA-Z0-9_]{32}-[a-zA-Z0-9_]{16}-\d{1,2}'\*/;",
|
|
)
|
|
|
|
def test_callproc(self):
|
|
db_integration = dbapi.DatabaseApiIntegration(
|
|
"testname", "testcomponent"
|
|
)
|
|
mock_connection = db_integration.wrapped_connection(
|
|
mock_connect, {}, {}
|
|
)
|
|
cursor = mock_connection.cursor()
|
|
cursor.callproc("Test stored procedure")
|
|
spans_list = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans_list), 1)
|
|
span = spans_list[0]
|
|
self.assertEqual(
|
|
span.attributes[SpanAttributes.DB_STATEMENT],
|
|
"Test stored procedure",
|
|
)
|
|
|
|
@mock.patch("opentelemetry.instrumentation.dbapi")
|
|
def test_wrap_connect(self, mock_dbapi):
|
|
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
|
|
connection = mock_dbapi.connect()
|
|
self.assertEqual(mock_dbapi.connect.call_count, 1)
|
|
self.assertIsInstance(connection._connection, mock.Mock)
|
|
|
|
@mock.patch("opentelemetry.instrumentation.dbapi")
|
|
def test_unwrap_connect(self, mock_dbapi):
|
|
dbapi.wrap_connect(self.tracer, MockConnectionEmpty(), "connect", "-")
|
|
connection = mock_dbapi.connect()
|
|
self.assertEqual(mock_dbapi.connect.call_count, 1)
|
|
|
|
dbapi.unwrap_connect(mock_dbapi, "connect")
|
|
connection = mock_dbapi.connect()
|
|
self.assertEqual(mock_dbapi.connect.call_count, 2)
|
|
self.assertIsInstance(connection, mock.Mock)
|
|
|
|
def test_instrument_connection(self):
|
|
connection = MockConnectionEmpty()
|
|
# Avoid get_attributes failing because can't concatenate mock
|
|
# pylint: disable=attribute-defined-outside-init
|
|
connection.database = "-"
|
|
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
|
|
self.assertIs(connection2._connection, connection)
|
|
|
|
def test_uninstrument_connection(self):
|
|
connection = MockConnectionEmpty()
|
|
# Set connection.database to avoid a failure because mock can't
|
|
# be concatenated
|
|
# pylint: disable=attribute-defined-outside-init
|
|
connection.database = "-"
|
|
connection2 = dbapi.instrument_connection(self.tracer, connection, "-")
|
|
self.assertIs(connection2._connection, connection)
|
|
|
|
connection3 = dbapi.uninstrument_connection(connection2)
|
|
self.assertIs(connection3, connection)
|
|
|
|
with self.assertLogs(level=logging.WARNING):
|
|
connection4 = dbapi.uninstrument_connection(connection)
|
|
self.assertIs(connection4, connection)
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def mock_connect(*args, **kwargs):
|
|
database = kwargs.get("database")
|
|
server_host = kwargs.get("server_host")
|
|
server_port = kwargs.get("server_port")
|
|
user = kwargs.get("user")
|
|
return MockConnectionWithAttributes(
|
|
database, server_port, server_host, user
|
|
)
|
|
|
|
|
|
class MockConnectionWithAttributes:
|
|
def __init__(self, database, server_port, server_host, user):
|
|
self.database = database
|
|
self.server_port = server_port
|
|
self.server_host = server_host
|
|
self.user = user
|
|
|
|
# pylint: disable=no-self-use
|
|
def cursor(self):
|
|
return MockCursor()
|
|
|
|
|
|
class MockCursor:
|
|
def __init__(self) -> None:
|
|
self.query = ""
|
|
self.params = None
|
|
|
|
# pylint: disable=unused-argument, no-self-use
|
|
def execute(self, query, params=None, throw_exception=False):
|
|
if throw_exception:
|
|
raise Exception("Test Exception")
|
|
|
|
# pylint: disable=unused-argument, no-self-use
|
|
def executemany(self, query, params=None, throw_exception=False):
|
|
if throw_exception:
|
|
raise Exception("Test Exception")
|
|
self.query = query
|
|
self.params = params
|
|
|
|
# pylint: disable=unused-argument, no-self-use
|
|
def callproc(self, query, params=None, throw_exception=False):
|
|
if throw_exception:
|
|
raise Exception("Test Exception")
|
|
|
|
|
|
class MockConnectionEmpty:
|
|
pass
|