Skip to content

Commit 901f56a

Browse files
Yun-Kimmabdinur
andauthored
chore(redis): extract redis common helpers to contrib utils [backport #5608 to 1.12] (#5708)
Backports #5608 to 1.12. This PR extracts redis-common helpers to outside the `ddtrace.contrib.redis` module and into `ddtrace.contrib.trace_utils_redis.py`, as `aioredis/aredis/yaaredis` were also using the contained helper functions. This PR should fix #5601 (see [comment](#5601 (comment))) ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/contributing.html#Release-Note-Guidelines) are followed. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] PR description includes explicit acknowledgement/acceptance of the performance implications of this PR as reported in the benchmarks PR comment. ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. Co-authored-by: Munir Abdinur <[email protected]>
1 parent 766419d commit 901f56a

File tree

7 files changed

+21
-22
lines changed

7 files changed

+21
-22
lines changed

ddtrace/contrib/aioredis/patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
from ...ext import net
2020
from ...ext import redis as redisx
2121
from ...internal.utils.formats import stringify_cache_args
22-
from ..redis.util import _trace_redis_cmd
23-
from ..redis.util import _trace_redis_execute_pipeline
22+
from ..trace_utils_redis import _trace_redis_cmd
23+
from ..trace_utils_redis import _trace_redis_execute_pipeline
2424

2525

2626
try:

ddtrace/contrib/aredis/patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
from ...internal.utils.formats import stringify_cache_args
77
from ...internal.utils.wrappers import unwrap
88
from ...pin import Pin
9-
from ..redis.util import _trace_redis_cmd
10-
from ..redis.util import _trace_redis_execute_pipeline
9+
from ..trace_utils_redis import _trace_redis_cmd
10+
from ..trace_utils_redis import _trace_redis_execute_pipeline
1111

1212

1313
config._add("aredis", dict(_default_service="redis"))

ddtrace/contrib/flask_cache/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# project
22
from ...ext import net
33
from ..pylibmc.addrs import parse_addresses
4-
from ..redis.util import _extract_conn_tags as extract_redis_tags
4+
from ..trace_utils_redis import _extract_conn_tags as extract_redis_tags
55

66

77
def _resource_from_cache_prefix(resource, cache):

ddtrace/contrib/redis/asyncio_patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
from ...internal.utils.formats import stringify_cache_args
44
from ...pin import Pin
5-
from .util import _trace_redis_cmd
6-
from .util import _trace_redis_execute_pipeline
5+
from ..trace_utils_redis import _trace_redis_cmd
6+
from ..trace_utils_redis import _trace_redis_execute_pipeline
77

88

99
#

ddtrace/contrib/redis/patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
from ...internal.utils.formats import stringify_cache_args
88
from ...pin import Pin
99
from ..trace_utils import unwrap
10-
from .util import _trace_redis_cmd
11-
from .util import _trace_redis_execute_pipeline
10+
from ..trace_utils_redis import _trace_redis_cmd
11+
from ..trace_utils_redis import _trace_redis_execute_pipeline
1212

1313

1414
config._add("redis", dict(_default_service="redis"))

ddtrace/contrib/redis/util.py renamed to ddtrace/contrib/trace_utils_redis.py

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,17 @@
33
"""
44
from contextlib import contextmanager
55

6+
from ddtrace.constants import ANALYTICS_SAMPLE_RATE_KEY
7+
from ddtrace.constants import SPAN_KIND
8+
from ddtrace.constants import SPAN_MEASURED_KEY
9+
from ddtrace.contrib import trace_utils
10+
from ddtrace.ext import SpanKind
11+
from ddtrace.ext import SpanTypes
12+
from ddtrace.ext import db
13+
from ddtrace.ext import net
14+
from ddtrace.ext import redis as redisx
615
from ddtrace.internal.constants import COMPONENT
7-
8-
from .. import trace_utils
9-
from ...constants import ANALYTICS_SAMPLE_RATE_KEY
10-
from ...constants import SPAN_KIND
11-
from ...constants import SPAN_MEASURED_KEY
12-
from ...ext import SpanKind
13-
from ...ext import SpanTypes
14-
from ...ext import db
15-
from ...ext import net
16-
from ...ext import redis as redisx
17-
from ...internal.utils.formats import stringify_cache_args
16+
from ddtrace.internal.utils.formats import stringify_cache_args
1817

1918

2019
format_command_args = stringify_cache_args

ddtrace/contrib/yaaredis/patch.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
from ...internal.utils.formats import stringify_cache_args
77
from ...internal.utils.wrappers import unwrap
88
from ...pin import Pin
9-
from ..redis.util import _trace_redis_cmd
10-
from ..redis.util import _trace_redis_execute_pipeline
9+
from ..trace_utils_redis import _trace_redis_cmd
10+
from ..trace_utils_redis import _trace_redis_execute_pipeline
1111

1212

1313
config._add("yaaredis", dict(_default_service="redis"))

0 commit comments

Comments
 (0)