Skip to content

ref(node): Streamline redis instrumentation #21582

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
logaretm merged 3 commits into from
Jun 17, 2026
Merged

ref(node): Streamline redis instrumentation #21582

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
a3877bd
ref(node): Streamline redis instrumentation
logaretm Jun 16, 2026
26bdeea
test(node): Remove stale redis fake unit test, cover multi via integr…
logaretm Jun 16, 2026
bedcd11
ref(node): Remove remaining OTel tracing APIs from redis instrumentation
logaretm Jun 17, 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
3 changes: 1 addition & 2 deletions .oxlintrc.base.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,7 @@
"typescript/no-explicit-any": "off",
"typescript/no-unsafe-member-access": "off",
"typescript/no-this-alias": "off",
"max-lines": "off",
"no-bitwise": "off"

@logaretm logaretm Jun 16, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed after streamline

"max-lines": "off"
}
},
{
Expand Down
3 changes: 2 additions & 1 deletion dev-packages/node-integration-tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@
"prisma": "6.15.0",
"proxy": "^2.1.1",
"redis-4": "npm:redis@^4.6.14",
"redis-5": "npm:redis@^5.12.0",
"redis-5": "npm:redis@~5.11.0",
"redis-5-tracing": "npm:redis@^5.12.0",
"reflect-metadata": "0.2.1",
"rxjs": "^7.8.2",
"tedious": "^19.2.1",
Expand Down
10 changes: 10 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/instrument-redis-5.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.redisIntegration({ cachePrefixes: ['redis-5-cache:'] })],
});
7 changes: 7 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-redis-4.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ async function run() {
await redisClient.get('redis-cache:unavailable-data');

await redisClient.mGet(['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data']);

// MULTI/EXEC produces one span per queued command, all ended together on exec
await redisClient.multi().set('redis-multi-key', 'multi-value').get('redis-multi-key').exec();

// a failing command should produce a span with an error status
// (INCR on a non-integer string value rejects)
await redisClient.incr('redis-test-key').catch(() => {});
} finally {
await redisClient.disconnect();
}
Expand Down
39 changes: 39 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-redis-5.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import * as Sentry from '@sentry/node';
import { createClient } from 'redis-5';

async function run() {
const redisClient = await createClient().connect();

await Sentry.startSpan(
{
name: 'Test Span Redis 5',
op: 'test-span-redis-5',
},
async () => {
try {
await redisClient.set('redis-5-test-key', 'test-value');
await redisClient.set('redis-5-cache:test-key', 'test-value');

await redisClient.set('redis-5-cache:test-key-set-EX', 'test-value', { EX: 10 });
await redisClient.setEx('redis-5-cache:test-key-setex', 10, 'test-value');

await redisClient.get('redis-5-test-key');
await redisClient.get('redis-5-cache:test-key');
await redisClient.get('redis-5-cache:unavailable-data');

await redisClient.mGet(['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data']);

// MULTI/EXEC produces one span per queued command, all ended together on exec
await redisClient.multi().set('redis-5-multi-key', 'multi-value').get('redis-5-multi-key').exec();

// a failing command should produce a span with an error status
// (INCR on a non-integer string value rejects)
await redisClient.incr('redis-5-test-key').catch(() => {});
} finally {
await redisClient.disconnect();
}
},
);
}

run();
165 changes: 165 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,39 @@ describe('redis cache auto instrumentation', () => {
'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
}),
}),
// MULTI/EXEC: one span per queued command
expect.objectContaining({
description: 'SET redis-multi-key [1 other arguments]',
op: 'db',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'SET redis-multi-key [1 other arguments]',
}),
}),
expect.objectContaining({
description: 'GET redis-multi-key',
op: 'db',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'GET redis-multi-key',
}),
}),
// a failing command produces a span with an error status
expect.objectContaining({
description: 'INCR redis-test-key',
op: 'db',
status: 'internal_error',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'INCR redis-test-key',
}),
}),
Comment thread
logaretm marked this conversation as resolved.
]),
};

Expand All @@ -246,4 +279,136 @@ describe('redis cache auto instrumentation', () => {
});
});
});

// node-redis 5.0-5.11 still flows through the vendored monkey-patch
// instrumentation (diagnostics_channel was only added in 5.12.0), so this
// exercises the `>=5.0.0 <5.12.0` branch of the vendored RedisInstrumentation.
describe('redis-5 cache keys', () => {
const EXPECTED_REDIS_CONNECT = {
transaction: 'redis-connect',
};

const EXPECTED_TRANSACTION = {
transaction: 'Test Span Redis 5',
spans: expect.arrayContaining([
// SET
expect.objectContaining({
description: 'redis-5-cache:test-key',
op: 'cache.put',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'SET redis-5-cache:test-key [1 other arguments]',
'cache.key': ['redis-5-cache:test-key'],
'cache.item_size': 2,
}),
}),
// SET (with EX)
expect.objectContaining({
description: 'redis-5-cache:test-key-set-EX',
op: 'cache.put',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'SET redis-5-cache:test-key-set-EX [3 other arguments]',
'cache.key': ['redis-5-cache:test-key-set-EX'],
'cache.item_size': 2,
}),
}),
// SETEX
expect.objectContaining({
description: 'redis-5-cache:test-key-setex',
op: 'cache.put',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'SETEX redis-5-cache:test-key-setex [2 other arguments]',
'cache.key': ['redis-5-cache:test-key-setex'],
'cache.item_size': 2,
}),
}),
// GET
expect.objectContaining({
description: 'redis-5-cache:test-key',
op: 'cache.get',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'GET redis-5-cache:test-key',
'cache.hit': true,
'cache.key': ['redis-5-cache:test-key'],
'cache.item_size': 10,
}),
}),
// GET (unavailable - no cache hit)
expect.objectContaining({
description: 'redis-5-cache:unavailable-data',
op: 'cache.get',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'GET redis-5-cache:unavailable-data',
'cache.hit': false,
'cache.key': ['redis-5-cache:unavailable-data'],
}),
}),
// MGET
expect.objectContaining({
description: 'redis-5-test-key, redis-5-cache:test-key, redis-5-cache:unavailable-data',
op: 'cache.get',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.statement': 'MGET [3 other arguments]',
'cache.hit': true,
'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
}),
}),
// MULTI/EXEC: one span per queued command
expect.objectContaining({
description: 'SET redis-5-multi-key [1 other arguments]',
op: 'db',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'SET redis-5-multi-key [1 other arguments]',
}),
}),
expect.objectContaining({
description: 'GET redis-5-multi-key',
op: 'db',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'GET redis-5-multi-key',
}),
}),
// a failing command produces a span with an error status
expect.objectContaining({
description: 'INCR redis-5-test-key',
op: 'db',
status: 'internal_error',
origin: 'auto.db.otel.redis',
data: expect.objectContaining({
'sentry.origin': 'auto.db.otel.redis',
'db.system': 'redis',
'db.statement': 'INCR redis-5-test-key',
}),
}),
]),
};

createEsmAndCjsTests(__dirname, 'scenario-redis-5.mjs', 'instrument-redis-5.mjs', (createTestRunner, test) => {
test('should create cache spans for prefixed keys (redis-5)', async () => {
await createTestRunner()
.withDockerCompose({ workingDirectory: [__dirname] })
.expect({ transaction: EXPECTED_REDIS_CONNECT })
.expect({ transaction: EXPECTED_TRANSACTION })
.start()
.completed();
});
});
});
});
2 changes: 1 addition & 1 deletion ...tes/tracing/redis-dc/scenario-redis-5.mjs → ...ing/redis-dc/scenario-redis-5-tracing.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ async function run() {
// is registered before node-redis eagerly creates its native TracingChannels on require().
await Promise.resolve();

const { createClient } = await import('redis-5');
const { createClient } = await import('redis-5-tracing');
const redisClient = await createClient({ socket: { host: '127.0.0.1', port: 6379 } }).connect();

await Sentry.startSpan(
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
transaction: 'redis-connect',
};

createEsmAndCjsTests(__dirname, 'scenario-redis-5.mjs', 'instrument.mjs', (createTestRunner, test) => {
createEsmAndCjsTests(__dirname, 'scenario-redis-5-tracing.mjs', 'instrument.mjs', (createTestRunner, test) => {
test('should create spans for redis v5 commands via diagnostics_channel', { timeout: 60_000 }, async () => {
await createTestRunner()
.withDockerCompose({ workingDirectory: [__dirname] })
Expand Down
3 changes: 1 addition & 2 deletions packages/node/src/integrations/tracing/redis/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import type { Span } from '@opentelemetry/api';
import type { IntegrationFn } from '@sentry/core';
import type { IntegrationFn, Span } from '@sentry/core';
import {
defineIntegration,
SEMANTIC_ATTRIBUTE_CACHE_HIT,
Expand Down
Loading
Loading