feat(server-utils)!: Start Redis spans as cache spans#23933

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
s1gr1d merged 6 commits into from
Sep 3, 2026
Merged

feat(server-utils)!: Start Redis spans as cache spans #23933

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bdc1dca
feat(server-utils)!: Start Redis spans as `cache` spans
s1gr1d Sep 2, 2026
8281d2d
Merge branch 'develop' into sig/redis-span-name-cache
s1gr1d Sep 2, 2026
7628022
assert on client report
s1gr1d Sep 2, 2026
4ef2ccc
Merge branch 'develop' into sig/redis-span-name-cache
s1gr1d Sep 2, 2026
184d355
Merge branch 'develop' into sig/redis-span-name-cache
andreiborza Sep 2, 2026
6de4f9f
Merge branch 'develop' into sig/redis-span-name-cache
s1gr1d Sep 3, 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
2 changes: 2 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
// so the `ignored` span outcomes flush while the scenario is still running
clientReportFlushInterval: 1_000,
});
4 changes: 4 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
await redisClient.get('dc-cache:unavailable-data');

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

// a failing command on a cache key (GET on a list rejects with WRONGTYPE)
await redisClient.lPush('dc-cache:list-key', 'value');
await redisClient.get('dc-cache:list-key').catch(() => {});
} finally {
await redisClient.disconnect();
}
Expand Down
64 changes: 60 additions & 4 deletions dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
'db.query.text': 'SET dc-test-key ?',
}),
}),
// cache SET: span name updated to key by cacheResponseHook
// cache SET: starts as a cache span, named by its key in the static lifecycle
expect.objectContaining({
description: 'dc-cache:test-key',
op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
'db.query.text': 'MGET ? ? ?',
}),
}),
// a failing command on a cache key reports as an errored cache span:
// the span starts as a cache span, so the classification survives the error
expect.objectContaining({
description: 'dc-cache:list-key',
op: 'cache.get',
status: 'internal_error',
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'cache.operation': 'get',
'cache.key': ['dc-cache:list-key'],
}),
}),
]),
};

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
.start()
.completed();
});

// `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
// span starts as a cache span — a db span renamed at response time would slip through.
test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
await createTestRunner()
.withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
.unignore('client_report')
// The span container and the client report flush on independent timers, so they can
// arrive in either order.
.unordered()
.expect({

@Lms24Lms24Sep 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?

span: (container: SerializedStreamedSpanContainer) => {
const names = container.items.map(item => item.name);
expect(names).toContain('cache.put');
expect(names).not.toContain('cache.get');
},
})
.expect({
client_report: {
discarded_events: [
// the two GETs on cache keys plus the failing GET, which is also decided at start
{ category: 'span', quantity: 3, reason: 'ignored' },
],
},
})
.start()
.completed();
});
});

// The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

// A cache span is a db span the cache hook took over: it is renamed to its cache operation
// and reports the connection it inherited as peer attributes too.
// A cache span is a db span whose key matched a cache prefix: it starts named after its
// cache operation and reports the connection as peer attributes too.
const cacheSpan = (
op: 'cache.get' | 'cache.put' | 'cache.remove',
attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
'db.operation.name': 'SET',
'db.query.text': 'SET dc-test-key ?',
}),
// cache SET: turned into a cache span, and renamed by the cache hook
// cache SET: starts as a cache span
cacheSpan('cache.put', {
'db.operation.name': 'SET',
'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
'db.operation.name': 'MGET',
'db.query.text': 'MGET ? ? ?',
}),
streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
'db.operation.name': 'LPUSH',
'db.query.text': 'LPUSH dc-cache:list-key ?',
}),
// a failing command on a cache key reports as an errored cache span:
// the span starts as a cache span, so the classification survives the error
{
...(cacheSpan('cache.get', {
'db.operation.name': 'GET',
'db.query.text': 'GET dc-cache:list-key',
'cache.key': ['dc-cache:list-key'],
'error.type': 'Error',
'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
}) as Record<string, unknown>),
status: 'error',
},
]);
},
})
Expand Down
27 changes: 15 additions & 12 deletions packages/server-utils/src/integrations/redis/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
};
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
commandName: string,
commandArgs: Array<string | Buffer>,
attributes: SpanAttributes,
cacheOptions: RedisCacheOptions,
): Span {
const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
host: attributes[SERVER_ADDRESS],
port: attributes[SERVER_PORT],
});
const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

return startInactiveSpan({
name: streamedName || dbStatement || `redis-${commandName}`,
name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
attributes: {
[SENTRY_KIND]: 'client',
...attributes,
[SENTRY_OP]: DB_QUERY,
[DB_OPERATION_NAME]: commandName,
...namingAttributes,
[DB_QUERY_TEXT]: dbStatement,
...cacheProperties?.attributes,
},
});
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
if (client?.connection_options?.port != null) {
attributes[SERVER_PORT] = client.connection_options.port;
}
const span = startCommandSpan(command.command, command.args ?? [], attributes);
const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
(data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

const parentSpan = getActiveSpan();
command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
}
endSpan(span, err);
// eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
}
const commandName = String(wireArgs[0]);
const options = (data.self as NodeRedisClient | undefined)?.options;
return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
},
{
beforeSpanEnd(span, data) {
if ('error' in data) {
return;
}
const wireArgs = getWireArgs(data);
if (wireArgs?.length) {
applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
if (!('error' in data)) {
applyCacheResponseAttributes(span, data.result);
}
},
},
Expand Down
39 changes: 20 additions & 19 deletions packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
*
* Exported for unit testing.
*/
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
data: IORedisCommandContext,
cacheOptions: RedisCacheOptions,
): Span | undefined {
const command = data.arguments?.[0] as RedisCommand | undefined;
if (!command || typeof command !== 'object') {
return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
host,
port,
});
const attributes: SpanAttributes = {
[SENTRY_KIND]: 'client',
...connectionAttributes(host, port),
[SENTRY_OP]: DB_QUERY,
[DB_OPERATION_NAME]: command.name,
...namingAttributes,
[DB_QUERY_TEXT]: statement,
};
const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

return startInactiveSpan({
name: streamedName || statement,
attributes: {
[SENTRY_KIND]: 'client',
...connectionAttributes(host, port),
[SENTRY_OP]: DB_QUERY,
[DB_OPERATION_NAME]: command.name,
...namingAttributes,
[DB_QUERY_TEXT]: statement,
},
name: cacheProperties?.name ?? streamedName ?? statement,
attributes: { ...attributes, ...cacheProperties?.attributes },
});
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
CHANNELS.IOREDIS_CONNECT,
);

bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
// ioredis' `requireParentSpan` default: only create a span under an active span.
requiresParentSpan: true,
beforeSpanEnd(span, data) {
if ('error' in data) {
return;
}
const command = data.arguments?.[0] as RedisCommand | undefined;
if (command) {
applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
if (!('error' in data)) {
applyCacheResponseAttributes(span, data.result);
}
},
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(server-utils)!: Start Redis spans as cache spans#23933

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

s1gr1d
merged 6 commits into

from

Sep 3, 2026
 Merged


feat(server-utils)!: Start Redis spans as cache spans
#23933
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
bdc1dca

feat(server-utils)!: Start Redis spans as `cache` spans


s1gr1d Sep 2, 2026
8281d2d

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
7628022

assert on client report


s1gr1d Sep 2, 2026
4ef2ccc

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 2, 2026
184d355

Merge branch 'develop' into sig/redis-span-name-cache


andreiborza Sep 2, 2026
6de4f9f

Merge branch 'develop' into sig/redis-span-name-cache


s1gr1d Sep 3, 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


2 changes: 2 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -999,6 +999,8 @@ Messaging span names now read `<operation type> <destination>` in every integrat

Cache keys are unbounded, so they are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`) — the value the name is built from. That attribute is set in both trace lifecycles. This affects the redis/ioredis cache spans (`cachePrefixes`), the Nuxt and Nitro storage spans, and the dataloader spans.

A Redis command whose key matches `cachePrefixes` now starts as a `cache.*` span instead of being converted from a `db.query` span at response time. `ignoreSpans` is evaluated at span start, so filters can match these spans by their cache op and name. A failed cache command reports as a cache span too, where it previously stayed a `db.query` span.

A dataloader span no longer carries the loader's `name` either (`dataloader.load usersLoader` becomes `cache.get`), because the cache conventions have no slot for it in the name. It is reported on the `db.collection.name` attribute instead — a loader batches one entity type, so it is the closest thing dataloader has to a collection — and that attribute is set in both trace lifecycles. Unnamed loaders do not set it.

Redis has no SQL statement to summarize and no collection to pair a command with, so redis and ioredis `db.query` spans are named after the operation and the connection instead of the command that was sent. The command and its arguments remain available on `db.query.text`, redacted as before. `MULTI`/`PIPELINE` batch spans are unchanged — they were already named after their operation, which they now also report on `db.operation.name`. `db.namespace` is deliberately not used in the name: for redis it is the numeric database index, which says nothing about what the command did.
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,4 +8,7 @@ Sentry.init({
 tracesSampleRate: 1.0,
 transport: loggingTransport,
 integrations: [Sentry.redisIntegration({ cachePrefixes: ['dc-cache:'] })],
 ignoreSpans: process.env.IGNORE_CACHE_GET === 'true' ? [{ op: 'cache.get' }] : undefined,
 // so the `ignored` span outcomes flush while the scenario is still running
 clientReportFlushInterval: 1_000,
});

4 changes: 4 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/scenario-redis-5-tracing.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,10 @@ async function run() {
 await redisClient.get('dc-cache:unavailable-data');

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

 // a failing command on a cache key (GET on a list rejects with WRONGTYPE)
 await redisClient.lPush('dc-cache:list-key', 'value');
 await redisClient.get('dc-cache:list-key').catch(() => {});
 } finally {
 await redisClient.disconnect();
 }
Expand Down

64 changes: 60 additions & 4 deletions
dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ describeWithDockerCompose(
 'db.query.text': 'SET dc-test-key ?',
 }),
 }),
 // cache SET: span name updated to key by cacheResponseHook
 // cache SET: starts as a cache span, named by its key in the static lifecycle
 expect.objectContaining({
 description: 'dc-cache:test-key',
 op: 'cache.put',
Expand DownExpand Up@@ -95,6 +95,18 @@ describeWithDockerCompose(
 'db.query.text': 'MGET ? ? ?',
 }),
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 expect.objectContaining({
 description: 'dc-cache:list-key',
 op: 'cache.get',
 status: 'internal_error',
 origin: 'auto.db.redis.diagnostic_channel',
 data: expect.objectContaining({
 'cache.operation': 'get',
 'cache.key': ['dc-cache:list-key'],
 }),
 }),
 ]),
 };

Expand All@@ -112,6 +124,34 @@ describeWithDockerCompose(
 .start()
 .completed();
 });

 // `ignoreSpans` is evaluated at span start under streaming, so this only passes because the
 // span starts as a cache span — a db span renamed at response time would slip through.
 test('drops cache spans matching an ignoreSpans op filter at span start', { timeout: 60_000 }, async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true', IGNORE_CACHE_GET: 'true' })
 .unignore('client_report')
 // The span container and the client report flush on independent timers, so they can
 // arrive in either order.
 .unordered()
 .expect({
@Lms24Lms24Sep 2, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: we could also assert on a client report here for the ignored span(s) to make it more explicit, wdyt?
 span: (container: SerializedStreamedSpanContainer) => {
 const names = container.items.map(item => item.name);
 expect(names).toContain('cache.put');
 expect(names).not.toContain('cache.get');
 },
 })
 .expect({
 client_report: {
 discarded_events: [
 // the two GETs on cache keys plus the failing GET, which is also decided at start
 { category: 'span', quantity: 3, reason: 'ignored' },
 ],
 },
 })
 .start()
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
Expand DownExpand Up@@ -165,8 +205,8 @@ describeWithDockerCompose(

 const PEER = { 'network.peer.address': HOST, 'network.peer.port': PORT };

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 // A cache span is a db span whose key matched a cache prefix: it starts named after its
 // cache operation and reports the connection as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
Expand DownExpand Up@@ -194,7 +234,7 @@ describeWithDockerCompose(
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-test-key ?',
 }),
 // cache SET: turned into a cache span, and renamed by the cache hook
 // cache SET: starts as a cache span
 cacheSpan('cache.put', {
 'db.operation.name': 'SET',
 'db.query.text': 'SET dc-cache:test-key ?',
Expand DownExpand Up@@ -233,6 +273,22 @@ describeWithDockerCompose(
 'db.operation.name': 'MGET',
 'db.query.text': 'MGET ? ? ?',
 }),
 streamedSpan(`LPUSH ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'LPUSH',
 'db.query.text': 'LPUSH dc-cache:list-key ?',
 }),
 // a failing command on a cache key reports as an errored cache span:
 // the span starts as a cache span, so the classification survives the error
 {
 ...(cacheSpan('cache.get', {
 'db.operation.name': 'GET',
 'db.query.text': 'GET dc-cache:list-key',
 'cache.key': ['dc-cache:list-key'],
 'error.type': 'Error',
 'sentry.status.message': 'WRONGTYPE Operation against a key holding the wrong kind of value',
 }) as Record<string, unknown>),
 status: 'error',
 },
 ]);
 },
 })
Expand Down

27 changes: 15 additions & 12 deletions
packages/server-utils/src/integrations/redis/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { CHANNELS } from '../../orchestrion/channels';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { redisModuleNames } from '../../orchestrion/config/redis';
import { ioredisModuleNames } from '../../orchestrion/config/ioredis';
Expand DownExpand Up@@ -108,22 +108,29 @@ function nodeRedisAttributes(options: NodeRedisClientOptions | undefined): SpanA
 };
}

function startCommandSpan(commandName: string, commandArgs: Array<string | Buffer>, attributes: SpanAttributes): Span {
function startCommandSpan(
 commandName: string,
 commandArgs: Array<string | Buffer>,
 attributes: SpanAttributes,
 cacheOptions: RedisCacheOptions,
): Span {
 const dbStatement = defaultDbStatementSerializer(commandName, commandArgs);
 const { streamedName, attributes: namingAttributes } = getRedisQueryNaming(commandName, commandArgs, {
 host: attributes[SERVER_ADDRESS],
 port: attributes[SERVER_PORT],
 });
 const cacheProperties = getRedisCacheAttributes(commandName, commandArgs, attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || dbStatement || `redis-${commandName}`,
 name: cacheProperties?.name ?? streamedName ?? (dbStatement || `redis-${commandName}`),
 attributes: {
 [SENTRY_KIND]: 'client',
 ...attributes,
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: commandName,
 ...namingAttributes,
 [DB_QUERY_TEXT]: dbStatement,
 ...cacheProperties?.attributes,
 },
 });
}
Expand DownExpand Up@@ -162,13 +169,13 @@ function subscribeLegacyRedisCommand(cacheOptions: RedisCacheOptions): void {
 if (client?.connection_options?.port != null) {
 attributes[SERVER_PORT] = client.connection_options.port;
 }
 const span = startCommandSpan(command.command, command.args ?? [], attributes);
 const span = startCommandSpan(command.command, command.args ?? [], attributes, cacheOptions);
 (data as CommandContext & { _sentrySpan?: Span })._sentrySpan = span;

 const parentSpan = getActiveSpan();
 command.callback = function (this: unknown, err: Error | null | undefined, reply: unknown) {
 if (!err) {
applyRedisCacheAttributes(span, command.command, command.args ?? [], reply, cacheOptions);
applyCacheResponseAttributes(span, reply);
 }
 endSpan(span, err);
 // eslint-disable-next-line prefer-rest-params
Expand DownExpand Up@@ -203,16 +210,12 @@ function bindNodeRedisCommandChannel(
 }
 const commandName = String(wireArgs[0]);
 const options = (data.self as NodeRedisClient | undefined)?.options;
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options));
 return startCommandSpan(commandName, wireArgs.slice(1), nodeRedisAttributes(options), cacheOptions);
 },
 {
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const wireArgs = getWireArgs(data);
 if (wireArgs?.length) {
 applyRedisCacheAttributes(span, String(wireArgs[0]), wireArgs.slice(1), data.result, cacheOptions);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 },
Expand Down

39 changes: 20 additions & 19 deletions
packages/server-utils/src/integrations/redis/ioredis-channel-subscriber.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,12 @@ import {
 SERVER_PORT,
} from '@sentry/conventions/attributes';
import { DB_QUERY, DB } from '@sentry/conventions/op';
import type { Span } from '@sentry/core';
import type { Span, SpanAttributes } from '@sentry/core';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import type { RedisCacheOptions } from './redis-cache';
import { applyRedisCacheAttributes } from './redis-cache';
import { applyCacheResponseAttributes, getRedisCacheAttributes } from './redis-cache';
import { getRedisQueryNaming } from './redis-span-name';
import { defaultDbStatementSerializer } from './redis-statement-serializer';

Expand DownExpand Up@@ -65,7 +65,10 @@ const tracedCommands = new WeakSet<object>();
 *
 * Exported for unit testing.
 */
export function startIORedisCommandSpan(data: IORedisCommandContext): Span | undefined {
export function startIORedisCommandSpan(
 data: IORedisCommandContext,
 cacheOptions: RedisCacheOptions,
): Span | undefined {
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (!command || typeof command !== 'object') {
 return undefined;
Expand All@@ -81,17 +84,19 @@ export function startIORedisCommandSpan(data: IORedisCommandContext): Span | und
 host,
 port,
 });
 const attributes: SpanAttributes = {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 };
 const cacheProperties = getRedisCacheAttributes(command.name, command.args ?? [], attributes, cacheOptions);

 return startInactiveSpan({
 name: streamedName || statement,
 attributes: {
 [SENTRY_KIND]: 'client',
 ...connectionAttributes(host, port),
 [SENTRY_OP]: DB_QUERY,
 [DB_OPERATION_NAME]: command.name,
 ...namingAttributes,
 [DB_QUERY_TEXT]: statement,
 },
 name: cacheProperties?.name ?? streamedName ?? statement,
 attributes: { ...attributes, ...cacheProperties?.attributes },
 });
}

Expand All@@ -109,16 +114,12 @@ export function instrumentIoredis(options: RedisCacheOptions): void {
 CHANNELS.IOREDIS_CONNECT,
 );

 bindTracingChannelToSpan(commandChannel, startIORedisCommandSpan, {
 bindTracingChannelToSpan(commandChannel, data => startIORedisCommandSpan(data, options), {
 // ioredis' `requireParentSpan` default: only create a span under an active span.
 requiresParentSpan: true,
 beforeSpanEnd(span, data) {
 if ('error' in data) {
 return;
 }
 const command = data.arguments?.[0] as RedisCommand | undefined;
 if (command) {
 applyRedisCacheAttributes(span, command.name, command.args, data.result, options);
 if (!('error' in data)) {
 applyCacheResponseAttributes(span, data.result);
 }
 },
 });
Expand Down
Loading
Loading