mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-28 20:52:57 +08:00
cd6b024327
* Fix async redis clients tracing * Update changelog * Add functional integration tests and fix linting issues --------- Co-authored-by: Shalev Roda <65566801+shalevr@users.noreply.github.com>
246 lines
7.9 KiB
Python
246 lines
7.9 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 asyncio
|
|
from unittest import mock
|
|
|
|
import redis
|
|
import redis.asyncio
|
|
|
|
from opentelemetry import trace
|
|
from opentelemetry.instrumentation.redis import RedisInstrumentor
|
|
from opentelemetry.test.test_base import TestBase
|
|
from opentelemetry.trace import SpanKind
|
|
|
|
|
|
class AsyncMock:
|
|
"""A sufficient async mock implementation.
|
|
|
|
Python 3.7 doesn't have an inbuilt async mock class, so this is used.
|
|
"""
|
|
|
|
def __init__(self):
|
|
self.mock = mock.Mock()
|
|
|
|
async def __call__(self, *args, **kwargs):
|
|
future = asyncio.Future()
|
|
future.set_result("random")
|
|
return future
|
|
|
|
def __getattr__(self, item):
|
|
return AsyncMock()
|
|
|
|
|
|
class TestRedis(TestBase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
RedisInstrumentor().instrument(tracer_provider=self.tracer_provider)
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
RedisInstrumentor().uninstrument()
|
|
|
|
def test_span_properties(self):
|
|
redis_client = redis.Redis()
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
self.assertEqual(span.name, "GET")
|
|
self.assertEqual(span.kind, SpanKind.CLIENT)
|
|
|
|
def test_not_recording(self):
|
|
redis_client = redis.Redis()
|
|
|
|
mock_tracer = mock.Mock()
|
|
mock_span = mock.Mock()
|
|
mock_span.is_recording.return_value = False
|
|
mock_tracer.start_span.return_value = mock_span
|
|
with mock.patch("opentelemetry.trace.get_tracer") as tracer:
|
|
with mock.patch.object(redis_client, "connection"):
|
|
tracer.return_value = mock_tracer
|
|
redis_client.get("key")
|
|
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_instrument_uninstrument(self):
|
|
redis_client = redis.Redis()
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
self.memory_exporter.clear()
|
|
|
|
# Test uninstrument
|
|
RedisInstrumentor().uninstrument()
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 0)
|
|
self.memory_exporter.clear()
|
|
|
|
# Test instrument again
|
|
RedisInstrumentor().instrument()
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
def test_instrument_uninstrument_async_client_command(self):
|
|
redis_client = redis.asyncio.Redis()
|
|
|
|
with mock.patch.object(redis_client, "connection", AsyncMock()):
|
|
asyncio.run(redis_client.get("key"))
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
self.memory_exporter.clear()
|
|
|
|
# Test uninstrument
|
|
RedisInstrumentor().uninstrument()
|
|
|
|
with mock.patch.object(redis_client, "connection", AsyncMock()):
|
|
asyncio.run(redis_client.get("key"))
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 0)
|
|
self.memory_exporter.clear()
|
|
|
|
# Test instrument again
|
|
RedisInstrumentor().instrument()
|
|
|
|
with mock.patch.object(redis_client, "connection", AsyncMock()):
|
|
asyncio.run(redis_client.get("key"))
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
def test_response_hook(self):
|
|
redis_client = redis.Redis()
|
|
connection = redis.connection.Connection()
|
|
redis_client.connection = connection
|
|
|
|
response_attribute_name = "db.redis.response"
|
|
|
|
def response_hook(span, conn, response):
|
|
span.set_attribute(response_attribute_name, response)
|
|
|
|
RedisInstrumentor().uninstrument()
|
|
RedisInstrumentor().instrument(
|
|
tracer_provider=self.tracer_provider, response_hook=response_hook
|
|
)
|
|
|
|
test_value = "test_value"
|
|
|
|
with mock.patch.object(connection, "send_command"):
|
|
with mock.patch.object(
|
|
redis_client, "parse_response", return_value=test_value
|
|
):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
span = spans[0]
|
|
self.assertEqual(
|
|
span.attributes.get(response_attribute_name), test_value
|
|
)
|
|
|
|
def test_request_hook(self):
|
|
redis_client = redis.Redis()
|
|
connection = redis.connection.Connection()
|
|
redis_client.connection = connection
|
|
|
|
custom_attribute_name = "my.request.attribute"
|
|
|
|
def request_hook(span, conn, args, kwargs):
|
|
if span and span.is_recording():
|
|
span.set_attribute(custom_attribute_name, args[0])
|
|
|
|
RedisInstrumentor().uninstrument()
|
|
RedisInstrumentor().instrument(
|
|
tracer_provider=self.tracer_provider, request_hook=request_hook
|
|
)
|
|
|
|
test_value = "test_value"
|
|
|
|
with mock.patch.object(connection, "send_command"):
|
|
with mock.patch.object(
|
|
redis_client, "parse_response", return_value=test_value
|
|
):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
span = spans[0]
|
|
self.assertEqual(span.attributes.get(custom_attribute_name), "GET")
|
|
|
|
def test_query_sanitizer_enabled(self):
|
|
redis_client = redis.Redis()
|
|
connection = redis.connection.Connection()
|
|
redis_client.connection = connection
|
|
|
|
RedisInstrumentor().uninstrument()
|
|
RedisInstrumentor().instrument(
|
|
tracer_provider=self.tracer_provider,
|
|
sanitize_query=True,
|
|
)
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.set("key", "value")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
span = spans[0]
|
|
self.assertEqual(span.attributes.get("db.statement"), "SET ? ?")
|
|
|
|
def test_query_sanitizer(self):
|
|
redis_client = redis.Redis()
|
|
connection = redis.connection.Connection()
|
|
redis_client.connection = connection
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.set("key", "value")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
|
|
span = spans[0]
|
|
self.assertEqual(span.attributes.get("db.statement"), "SET ? ?")
|
|
|
|
def test_no_op_tracer_provider(self):
|
|
RedisInstrumentor().uninstrument()
|
|
tracer_provider = trace.NoOpTracerProvider()
|
|
RedisInstrumentor().instrument(tracer_provider=tracer_provider)
|
|
|
|
redis_client = redis.Redis()
|
|
|
|
with mock.patch.object(redis_client, "connection"):
|
|
redis_client.get("key")
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 0)
|