Skip to content

feat(redis): add DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED to suppress lifecycle spans #3757

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

Open
jbdelhommeau wants to merge 9 commits into
base: master
Choose a base branch
from
Open

feat(redis): add DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED to suppress lifecycle spans #3757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6237f61
feat(redis): declare DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED config
jbdelhommeau Mar 30, 2026
3d882b2
docs(redis): document DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED
jbdelhommeau Mar 30, 2026
55b4b9c
test(phpredis): add tests for DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED
jbdelhommeau Mar 30, 2026
f09d3b5
test(predis): add tests for DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED
jbdelhommeau Mar 30, 2026
9faeef7
feat(predis): skip lifecycle spans when DD_TRACE_REDIS_LIFECYCLE_COMM…
jbdelhommeau Mar 30, 2026
fd5b390
feat(redis): skip lifecycle spans when DD_TRACE_REDIS_LIFECYCLE_COMMA…
jbdelhommeau Mar 30, 2026
7a95683
refactor(redis): extract storeClusterMeta to eliminate duplication
jbdelhommeau Mar 30, 2026
22a09d2
fix(redis): check lifecycle flag per-call instead of at init time
jbdelhommeau Mar 30, 2026
6855610
fix(predis): check lifecycle flag per-call instead of at init time
jbdelhommeau Mar 30, 2026
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
1 change: 1 addition & 0 deletions ext/configuration.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ enum ddtrace_sidecar_connection_mode {
CONFIG(BOOL, DD_TRACE_DB_CLIENT_SPLIT_BY_INSTANCE, "false") \
CONFIG(BOOL, DD_TRACE_HTTP_CLIENT_SPLIT_BY_DOMAIN, "false") \
CONFIG(BOOL, DD_TRACE_REDIS_CLIENT_SPLIT_BY_HOST, "false") \
CONFIG(BOOL, DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED, "true") \
CONFIG(BOOL, DD_EXCEPTION_REPLAY_ENABLED, "false", .ini_change = ddtrace_alter_DD_EXCEPTION_REPLAY_ENABLED) \
CONFIG(INT, DD_EXCEPTION_REPLAY_CAPTURE_MAX_FRAMES, "-1") \
CONFIG(INT, DD_EXCEPTION_REPLAY_CAPTURE_INTERVAL_SECONDS, "3600") \
Expand Down
7 changes: 7 additions & 0 deletions metadata/supported-configurations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2049,6 +2049,13 @@
"default": "false"
}
],
"DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED": [
{
"implementation": "A",
"type": "boolean",
"default": "true"
}
],
"DD_TRACE_REMOVE_AUTOINSTRUMENTATION_ORPHANS": [
{
"implementation": "A",
Expand Down
235 changes: 159 additions & 76 deletions src/DDTrace/Integrations/PHPRedis/PHPRedisIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace DDTrace\Integrations\PHPRedis;

use DDTrace\HookData;
use DDTrace\Integrations\DatabaseIntegrationHelper;
use DDTrace\Integrations\Integration;
use DDTrace\SpanData;
Expand Down Expand Up @@ -35,94 +36,85 @@ class PHPRedisIntegration extends Integration

public static function init(): int
{
$traceConnectOpen = function (SpanData $span, $args) {
Integration::handleOrphan($span);

$connectHook = static function (HookData $hook) {
$args = $hook->args;
$instance = $hook->instance;
$hostOrUDS = (isset($args[0]) && \is_string($args[0])) ? $args[0] : PHPRedisIntegration::DEFAULT_HOST;
$span->meta[Tag::TARGET_HOST] = $hostOrUDS;
$span->meta[Tag::TARGET_PORT] = isset($args[1]) && \is_numeric($args[1]) ?
$args[1] :
PHPRedisIntegration::DEFAULT_PORT;
$span->meta[Tag::SPAN_KIND] = 'client';

// While we would have access to Redis::getHost() from the instance to retrieve it later, we compute the
// service name here and store in the instance for later because of the following reasons:
// - we would do over and over the same operation, involving a regex, for each method invocation.
// - in case of connection error, the Redis::host value is not set and we would not have access to it
// during callbacks, meaning that we would have to use two different ways to extract the name: args or
// Redis::getHost() depending on when we are interested in such information.
ObjectKVStore::put($this, PHPRedisIntegration::KEY_HOST, $hostOrUDS);
// Always store metadata so data command spans have out.host
ObjectKVStore::put($instance, PHPRedisIntegration::KEY_HOST, $hostOrUDS);

PHPRedisIntegration::enrichSpan($span, $this, 'Redis');
};
\DDTrace\trace_method('Redis', 'connect', $traceConnectOpen);
\DDTrace\trace_method('Redis', 'pconnect', $traceConnectOpen);
\DDTrace\trace_method('Redis', 'open', $traceConnectOpen);
\DDTrace\trace_method('Redis', 'popen', $traceConnectOpen);
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}

$traceNewCluster = function (SpanData $span, $args) {
$span = $hook->span();
Integration::handleOrphan($span);
$span->meta[Tag::TARGET_HOST] = $hostOrUDS;
$span->meta[Tag::TARGET_PORT] = isset($args[1]) && \is_numeric($args[1])
? $args[1]
: PHPRedisIntegration::DEFAULT_PORT;
$span->meta[Tag::SPAN_KIND] = 'client';
PHPRedisIntegration::enrichSpan($span, $instance, 'Redis');
};
\DDTrace\install_hook('Redis::connect', $connectHook);
\DDTrace\install_hook('Redis::pconnect', $connectHook);
\DDTrace\install_hook('Redis::open', $connectHook);
\DDTrace\install_hook('Redis::popen', $connectHook);

if (isset($args[1]) && \is_array($args[1]) && !empty($args[1])) {
$firstHostOrUDS = $args[1][0];
} else {
$seeds = \ini_get('redis.clusters.seeds');
if (!empty($seeds)) {
$clusters = [];
parse_str($seeds, $clusters);
if (array_key_exists($args[0], $clusters) && !empty($clusters[$args[0]])) {
$firstHostOrUDS = $clusters[$args[0]][0];
}
}
}
if (empty($firstHostOrUDS)) {
$firstHostOrUDS = PHPRedisIntegration::DEFAULT_HOST;
\DDTrace\install_hook('RedisCluster::__construct', static function (HookData $hook) {
PHPRedisIntegration::storeClusterMeta($hook->instance, $hook->args);

if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}

$configuredClusterName = isset($args[0]) && \is_string($args[0]) ? $args[0] : null;
ObjectKVStore::put($this, PHPRedisIntegration::KEY_CLUSTER_NAME, $configuredClusterName);
$span = $hook->span();
Integration::handleOrphan($span);

$firstHostOrUDS = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_FIRST_HOST_OR_UDS)
?? PHPRedisIntegration::DEFAULT_HOST;
$firstConfiguredHost = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_FIRST_HOST)
?? PHPRedisIntegration::DEFAULT_HOST;

$url = parse_url($firstHostOrUDS);
$firstConfiguredHost = is_array($url) && isset($url["host"]) ?
$url["host"] :
PHPRedisIntegration::DEFAULT_HOST;
$span->meta[Tag::TARGET_HOST] = $firstConfiguredHost;
$span->meta[Tag::TARGET_PORT] = is_array($url) && isset($url["port"]) ?
$url["port"] :
PHPRedisIntegration::DEFAULT_PORT;
ObjectKVStore::put($this, PHPRedisIntegration::KEY_FIRST_HOST, $firstConfiguredHost);
ObjectKVStore::put($this, PHPRedisIntegration::KEY_FIRST_HOST_OR_UDS, $firstHostOrUDS);
$span->meta[Tag::TARGET_PORT] = is_array($url) && isset($url["port"])
? $url["port"]
: PHPRedisIntegration::DEFAULT_PORT;

PHPRedisIntegration::enrichSpan($span, $this, 'RedisCluster');
};
\DDTrace\trace_method('RedisCluster', '__construct', $traceNewCluster);

self::traceMethodNoArgs('close');
self::traceMethodNoArgs('auth');
self::traceMethodNoArgs('ping');
self::traceMethodNoArgs('echo');
self::traceMethodNoArgs('bgRewriteAOF');
self::traceMethodNoArgs('bgSave');
self::traceMethodNoArgs('flushAll');
self::traceMethodNoArgs('flushDb');
self::traceMethodNoArgs('save');
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'RedisCluster');
});

self::installLifecycleHookNoArgs('close');
self::installLifecycleHookNoArgs('auth');
self::installLifecycleHookNoArgs('ping');
self::installLifecycleHookNoArgs('echo');
self::installLifecycleHookNoArgs('bgRewriteAOF');
self::installLifecycleHookNoArgs('bgSave');
self::installLifecycleHookNoArgs('flushAll');
self::installLifecycleHookNoArgs('flushDb');
self::installLifecycleHookNoArgs('save');
// We do not trace arguments of restore as they are binary
self::traceMethodNoArgs('restore');
self::installLifecycleHookNoArgs('restore');

\DDTrace\trace_method('Redis', 'select', function (SpanData $span, $args) {
\DDTrace\install_hook('Redis::select', static function (HookData $hook) {
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}
$span = $hook->span();
Integration::handleOrphan($span);

PHPRedisIntegration::enrichSpan($span, $this, 'Redis');
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'Redis');
$args = $hook->args;
if (isset($args[0]) && \is_numeric($args[0])) {
$span->meta['db.index'] = $args[0];
}

$host = ObjectKVStore::get($this, PHPRedisIntegration::KEY_HOST);
$host = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_HOST);
$span->meta[Tag::TARGET_HOST] = $host;
$span->peerServiceSources = DatabaseIntegrationHelper::PEER_SERVICE_SOURCES;
});

self::traceMethodAsCommand('swapdb');
self::installLifecycleHookAsCommand('swapdb');

self::traceMethodAsCommand('append');
self::traceMethodAsCommand('decr');
Expand Down Expand Up @@ -278,18 +270,18 @@ public static function init(): int
self::traceMethodAsCommand('eval');
self::traceMethodAsCommand('evalSha');
self::traceMethodAsCommand('script');
self::traceMethodAsCommand('getLastError');
self::traceMethodAsCommand('clearLastError');
self::traceMethodAsCommand('_unserialize');
self::traceMethodAsCommand('_serialize');
self::installLifecycleHookAsCommand('getLastError');
self::installLifecycleHookAsCommand('clearLastError');
self::installLifecycleHookAsCommand('_unserialize');
self::installLifecycleHookAsCommand('_serialize');

// Introspection
self::traceMethodAsCommand('isConnected');
self::traceMethodAsCommand('getHost');
self::traceMethodAsCommand('getPort');
self::traceMethodAsCommand('getDbNum');
self::traceMethodAsCommand('getTimeout');
self::traceMethodAsCommand('getReadTimeout');
self::installLifecycleHookAsCommand('isConnected');
self::installLifecycleHookAsCommand('getHost');
self::installLifecycleHookAsCommand('getPort');
self::installLifecycleHookAsCommand('getDbNum');
self::installLifecycleHookAsCommand('getTimeout');
self::installLifecycleHookAsCommand('getReadTimeout');

// Geocoding
self::traceMethodAsCommand('geoAdd');
Expand Down Expand Up @@ -353,6 +345,68 @@ public static function enrichSpan(SpanData $span, $instance, $class, $method = n
}
}

private static function installLifecycleHookNoArgs($method)
{
\DDTrace\install_hook('Redis::' . $method, static function (HookData $hook) use ($method) {
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}
$span = $hook->span();
Integration::handleOrphan($span);
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'Redis', $method);
$host = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_HOST);
$span->meta[Tag::TARGET_HOST] = $host;
$span->peerServiceSources = DatabaseIntegrationHelper::PEER_SERVICE_SOURCES;
});
\DDTrace\install_hook('RedisCluster::' . $method, static function (HookData $hook) use ($method) {
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}
$span = $hook->span();
Integration::handleOrphan($span);
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'RedisCluster', $method);
if ($clusterName = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_CLUSTER_NAME)) {
$span->meta[PHPRedisIntegration::INTERNAL_ONLY_TAG_CLUSTER_NAME] = $clusterName;
} elseif ($firstHost = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_FIRST_HOST)) {
$span->meta[PHPRedisIntegration::INTERNAL_ONLY_TAG_FIRST_HOST] = $firstHost;
}
$span->peerServiceSources = DatabaseIntegrationHelper::PEER_SERVICE_SOURCES;
});
}

private static function installLifecycleHookAsCommand($method)
{
\DDTrace\install_hook('Redis::' . $method, static function (HookData $hook) use ($method) {
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}
$span = $hook->span();
Integration::handleOrphan($span);
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'Redis', $method);
$normalizedArgs = PHPRedisIntegration::normalizeArgs($hook->args);
$span->meta[Tag::REDIS_RAW_COMMAND] = empty($normalizedArgs) ? $method : ($method . ' ' . $normalizedArgs);
$host = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_HOST);
$span->meta[Tag::TARGET_HOST] = $host;
$span->peerServiceSources = DatabaseIntegrationHelper::PEER_SERVICE_SOURCES;
});
\DDTrace\install_hook('RedisCluster::' . $method, static function (HookData $hook) use ($method) {
if (!\dd_trace_env_config("DD_TRACE_REDIS_LIFECYCLE_COMMANDS_ENABLED")) {
return;
}
$span = $hook->span();
Integration::handleOrphan($span);
PHPRedisIntegration::enrichSpan($span, $hook->instance, 'RedisCluster', $method);
$normalizedArgs = PHPRedisIntegration::normalizeArgs($hook->args);
$span->meta[Tag::REDIS_RAW_COMMAND] = empty($normalizedArgs) ? $method : ($method . ' ' . $normalizedArgs);
if ($clusterName = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_CLUSTER_NAME)) {
$span->meta[PHPRedisIntegration::INTERNAL_ONLY_TAG_CLUSTER_NAME] = $clusterName;
} elseif ($firstHost = ObjectKVStore::get($hook->instance, PHPRedisIntegration::KEY_FIRST_HOST)) {
$span->meta[PHPRedisIntegration::INTERNAL_ONLY_TAG_FIRST_HOST] = $firstHost;
}
$span->peerServiceSources = DatabaseIntegrationHelper::PEER_SERVICE_SOURCES;
});
}

public static function traceMethodNoArgs($method)
{
\DDTrace\trace_method('Redis', $method, function (SpanData $span, $args) use ($method) {
Expand Down Expand Up @@ -409,6 +463,35 @@ public static function traceMethodAsCommand($method)
});
}

public static function storeClusterMeta($instance, $args)
{
if (isset($args[1]) && \is_array($args[1]) && !empty($args[1])) {
$firstHostOrUDS = $args[1][0];
} else {
$seeds = \ini_get('redis.clusters.seeds');
if (!empty($seeds)) {
$clusters = [];
parse_str($seeds, $clusters);
if (array_key_exists($args[0], $clusters) && !empty($clusters[$args[0]])) {
$firstHostOrUDS = $clusters[$args[0]][0];
}
}
}
if (empty($firstHostOrUDS)) {
$firstHostOrUDS = self::DEFAULT_HOST;
}

$configuredClusterName = isset($args[0]) && \is_string($args[0]) ? $args[0] : null;
ObjectKVStore::put($instance, self::KEY_CLUSTER_NAME, $configuredClusterName);

$url = parse_url($firstHostOrUDS);
$firstConfiguredHost = is_array($url) && isset($url["host"])
? $url["host"]
: self::DEFAULT_HOST;
ObjectKVStore::put($instance, self::KEY_FIRST_HOST, $firstConfiguredHost);
ObjectKVStore::put($instance, self::KEY_FIRST_HOST_OR_UDS, $firstHostOrUDS);
}

/**
* Based on logic from python tracer:
* https://github.com/DataDog/dd-trace-py/blob/0d7e7cb38216acb0c8b29f0ae1318d25bc160123/ddtrace/contrib/redis/util.py#L25
Expand Down
Loading