Skip to content

Refactor redis instrumentation to use semconv incubating attributes #3534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 23, 2025
Merged

Refactor redis instrumentation to use semconv incubating attributes #3534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fbb2763
Replaced usage of opentelemetry.semconv.trace with opentelemetry.semc…
hegerchr May 22, 2025
7fc07d4
Fixed ruff failure
hegerchr May 22, 2025
caf65ec
Merge branch 'main' into fixRedis
xrmx May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions ...n/opentelemetry-instrumentation-redis/src/opentelemetry/instrumentation/redis/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,9 @@ def response_hook(span, instance, response):
)
from opentelemetry.instrumentation.redis.version import __version__
from opentelemetry.instrumentation.utils import unwrap
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.semconv._incubating.attributes.db_attributes import (
DB_STATEMENT,
)
from opentelemetry.trace import (
StatusCode,
Tracer,
Expand Down Expand Up @@ -200,7 +202,7 @@ def _traced_execute_command(
name, kind=trace.SpanKind.CLIENT
) as span:
if span.is_recording():
span.set_attribute(SpanAttributes.DB_STATEMENT, query)
span.set_attribute(DB_STATEMENT, query)
_set_connection_attributes(span, instance)
span.set_attribute("db.redis.args_length", len(args))
if span.name == "redis.create_index":
Expand Down Expand Up @@ -239,7 +241,7 @@ def _traced_execute_pipeline(
span_name, kind=trace.SpanKind.CLIENT
) as span:
if span.is_recording():
span.set_attribute(SpanAttributes.DB_STATEMENT, resource)
span.set_attribute(DB_STATEMENT, resource)
_set_connection_attributes(span, instance)
span.set_attribute(
"db.redis.pipeline_length", len(command_stack)
Expand Down Expand Up @@ -281,7 +283,7 @@ async def _async_traced_execute_command(
name, kind=trace.SpanKind.CLIENT
) as span:
if span.is_recording():
span.set_attribute(SpanAttributes.DB_STATEMENT, query)
span.set_attribute(DB_STATEMENT, query)
_set_connection_attributes(span, instance)
span.set_attribute("db.redis.args_length", len(args))
if callable(request_hook):
Expand Down Expand Up @@ -317,7 +319,7 @@ async def _async_traced_execute_pipeline(
span_name, kind=trace.SpanKind.CLIENT
) as span:
if span.is_recording():
span.set_attribute(SpanAttributes.DB_STATEMENT, resource)
span.set_attribute(DB_STATEMENT, resource)
_set_connection_attributes(span, instance)
span.set_attribute(
"db.redis.pipeline_length", len(command_stack)
Expand Down
48 changes: 22 additions & 26 deletions instrumentation/opentelemetry-instrumentation-redis/tests/test_redis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@

from opentelemetry import trace
from opentelemetry.instrumentation.redis import RedisInstrumentor
from opentelemetry.semconv.trace import (
from opentelemetry.semconv._incubating.attributes.db_attributes import (
DB_REDIS_DATABASE_INDEX,
DB_SYSTEM,
DbSystemValues,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
NET_TRANSPORT,
NetTransportValues,
SpanAttributes,
)
from opentelemetry.test.test_base import TestBase
from opentelemetry.trace import SpanKind
Expand Down Expand Up @@ -257,18 +263,14 @@ def test_attributes_default(self):

span = spans[0]
self.assertEqual(
span.attributes[SpanAttributes.DB_SYSTEM],
span.attributes[DB_SYSTEM],
DbSystemValues.REDIS.value,
)
self.assertEqual(span.attributes[DB_REDIS_DATABASE_INDEX], 0)
self.assertEqual(span.attributes[NET_PEER_NAME], "localhost")
self.assertEqual(span.attributes[NET_PEER_PORT], 6379)
self.assertEqual(
span.attributes[SpanAttributes.DB_REDIS_DATABASE_INDEX], 0
)
self.assertEqual(
span.attributes[SpanAttributes.NET_PEER_NAME], "localhost"
)
self.assertEqual(span.attributes[SpanAttributes.NET_PEER_PORT], 6379)
self.assertEqual(
span.attributes[SpanAttributes.NET_TRANSPORT],
span.attributes[NET_TRANSPORT],
NetTransportValues.IP_TCP.value,
)

Expand All @@ -283,18 +285,14 @@ def test_attributes_tcp(self):

span = spans[0]
self.assertEqual(
span.attributes[SpanAttributes.DB_SYSTEM],
span.attributes[DB_SYSTEM],
DbSystemValues.REDIS.value,
)
self.assertEqual(span.attributes[DB_REDIS_DATABASE_INDEX], 1)
self.assertEqual(span.attributes[NET_PEER_NAME], "1.1.1.1")
self.assertEqual(span.attributes[NET_PEER_PORT], 6380)
self.assertEqual(
span.attributes[SpanAttributes.DB_REDIS_DATABASE_INDEX], 1
)
self.assertEqual(
span.attributes[SpanAttributes.NET_PEER_NAME], "1.1.1.1"
)
self.assertEqual(span.attributes[SpanAttributes.NET_PEER_PORT], 6380)
self.assertEqual(
span.attributes[SpanAttributes.NET_TRANSPORT],
span.attributes[NET_TRANSPORT],
NetTransportValues.IP_TCP.value,
)

Expand All @@ -311,18 +309,16 @@ def test_attributes_unix_socket(self):

span = spans[0]
self.assertEqual(
span.attributes[SpanAttributes.DB_SYSTEM],
span.attributes[DB_SYSTEM],
DbSystemValues.REDIS.value,
)
self.assertEqual(span.attributes[DB_REDIS_DATABASE_INDEX], 3)
self.assertEqual(
span.attributes[SpanAttributes.DB_REDIS_DATABASE_INDEX], 3
)
self.assertEqual(
span.attributes[SpanAttributes.NET_PEER_NAME],
span.attributes[NET_PEER_NAME],
"/path/to/socket.sock",
)
self.assertEqual(
span.attributes[SpanAttributes.NET_TRANSPORT],
span.attributes[NET_TRANSPORT],
NetTransportValues.OTHER.value,
)

Expand Down