121 lines
4.3 KiB
Python
121 lines
4.3 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 redis
|
|
|
|
from opentelemetry import trace
|
|
from opentelemetry.instrumentation.redis import RedisInstrumentor
|
|
from opentelemetry.test.test_base import TestBase
|
|
|
|
|
|
class TestRedisInstrument(TestBase):
|
|
|
|
test_service = "redis"
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.redis_client = redis.Redis(port=6379)
|
|
self.redis_client.flushall()
|
|
RedisInstrumentor().instrument(tracer_provider=self.tracer_provider)
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
RedisInstrumentor().uninstrument()
|
|
|
|
def _check_span(self, span):
|
|
self.assertEqual(span.attributes["service"], self.test_service)
|
|
self.assertEqual(span.name, "redis.command")
|
|
self.assertIs(
|
|
span.status.canonical_code, trace.status.StatusCanonicalCode.OK
|
|
)
|
|
self.assertEqual(span.attributes.get("db.instance"), 0)
|
|
self.assertEqual(
|
|
span.attributes.get("db.url"), "redis://localhost:6379"
|
|
)
|
|
|
|
def test_long_command(self):
|
|
self.redis_client.mget(*range(1000))
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
self._check_span(span)
|
|
self.assertTrue(
|
|
span.attributes.get("db.statement").startswith("MGET 0 1 2 3")
|
|
)
|
|
self.assertTrue(span.attributes.get("db.statement").endswith("..."))
|
|
|
|
def test_basics(self):
|
|
self.assertIsNone(self.redis_client.get("cheese"))
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
self._check_span(span)
|
|
self.assertEqual(span.attributes.get("db.statement"), "GET cheese")
|
|
self.assertEqual(span.attributes.get("redis.args_length"), 2)
|
|
|
|
def test_pipeline_traced(self):
|
|
with self.redis_client.pipeline(transaction=False) as pipeline:
|
|
pipeline.set("blah", 32)
|
|
pipeline.rpush("foo", "éé")
|
|
pipeline.hgetall("xxx")
|
|
pipeline.execute()
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 1)
|
|
span = spans[0]
|
|
self._check_span(span)
|
|
self.assertEqual(
|
|
span.attributes.get("db.statement"),
|
|
"SET blah 32\nRPUSH foo éé\nHGETALL xxx",
|
|
)
|
|
self.assertEqual(span.attributes.get("redis.pipeline_length"), 3)
|
|
|
|
def test_pipeline_immediate(self):
|
|
with self.redis_client.pipeline() as pipeline:
|
|
pipeline.set("a", 1)
|
|
pipeline.immediate_execute_command("SET", "b", 2)
|
|
pipeline.execute()
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
# expecting two separate spans here, rather than a
|
|
# single span for the whole pipeline
|
|
self.assertEqual(len(spans), 2)
|
|
span = spans[0]
|
|
self._check_span(span)
|
|
self.assertEqual(span.attributes.get("db.statement"), "SET b 2")
|
|
|
|
def test_parent(self):
|
|
"""Ensure OpenTelemetry works with redis."""
|
|
ot_tracer = trace.get_tracer("redis_svc")
|
|
|
|
with ot_tracer.start_as_current_span("redis_get"):
|
|
self.assertIsNone(self.redis_client.get("cheese"))
|
|
|
|
spans = self.memory_exporter.get_finished_spans()
|
|
self.assertEqual(len(spans), 2)
|
|
child_span, parent_span = spans[0], spans[1]
|
|
|
|
# confirm the parenting
|
|
self.assertIsNone(parent_span.parent)
|
|
self.assertIs(child_span.parent, parent_span.get_span_context())
|
|
|
|
self.assertEqual(parent_span.name, "redis_get")
|
|
self.assertEqual(parent_span.instrumentation_info.name, "redis_svc")
|
|
|
|
self.assertEqual(
|
|
child_span.attributes.get("service"), self.test_service
|
|
)
|
|
self.assertEqual(child_span.name, "redis.command")
|