feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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
msonnb merged 4 commits into from
Jul 21, 2026
Merged

feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93a9dab
feat(node): Add `cache.key` attribute in dataloader spans
msonnb Jul 20, 2026
0af75dc
set op to `cache.remove` for redis delete commands
msonnb Jul 20, 2026
ece7d46
Update packages/server-utils/src/integrations/tracing-channel/dataloa…
msonnb Jul 21, 2026
d4fe083
Merge branch 'develop' into ms/cache-key-attribute
msonnb Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
expect(loadSpan?.status).toBe('ok');
expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
// A direct operation is a client call; the deferred `batch` below gets no kind
expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
expect(batchSpan?.op).toBe(CACHE_GET_OP);
expect(batchSpan?.origin).toBe(ORIGIN);
expect(batchSpan?.status).toBe('ok');
expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

// The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
expect(loadManySpan?.status).toBe('ok');
expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
},
})
.expect({
Expand Down
2 changes: 2 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
await redis.get('ioredis-cache:unavailable-data');

await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

await redis.del('ioredis-cache:test-key');
} finally {
await redis.disconnect();
}
Expand Down
2 changes: 2 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-redis-4.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

await redisClient.del('redis-cache:test-key');

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

Expand Down
2 changes: 2 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-redis-5.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

await redisClient.del('redis-5-cache:test-key');

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

Expand Down
35 changes: 35 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
'network.peer.port': 6383,
}),
}),
// DEL
expect.objectContaining({
description: 'ioredis-cache:test-key',
op: 'cache.remove',
origin: redisOrigin,
data: expect.objectContaining({
'sentry.origin': redisOrigin,
'db.statement': 'del ioredis-cache:test-key',
'cache.key': ['ioredis-cache:test-key'],
'network.peer.address': 'localhost',
'network.peer.port': 6383,
}),
}),

@cursorcursorBotJul 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion

Low Severity

This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.

Additional Locations (2)
Fix in CursorFix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit d4fe083. Configure here.

]),
};

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
}),
}),
// DEL
expect.objectContaining({
description: 'redis-cache:test-key',
op: 'cache.remove',
origin: redisOrigin,
data: expect.objectContaining({
'sentry.origin': redisOrigin,
'db.statement': 'DEL redis-cache:test-key',
'cache.key': ['redis-cache:test-key'],
}),
}),
...batchSpans,
// a failing command produces a span with an error status
expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
}),
}),
// DEL
expect.objectContaining({
description: 'redis-5-cache:test-key',
op: 'cache.remove',
origin: redisOrigin,
data: expect.objectContaining({
'sentry.origin': redisOrigin,
'db.statement': 'DEL redis-5-cache:test-key',
'cache.key': ['redis-5-cache:test-key'],
}),
}),
...batchSpans,
// a failing command produces a span with an error status
expect.objectContaining({
Expand Down
14 changes: 14 additions & 0 deletions packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
*/

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.
Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
if (Array.isArray(keyArg)) {
return keyArg.map(key => String(key));
}

return keyArg == null ? undefined : [String(keyArg)];
}

@cursorcursorBotJul 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load

Medium Severity

getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit ece7d46. Configure here.


export class DataloaderInstrumentation extends InstrumentationBase {
constructor(config = {}) {
super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
[CACHE_KEY]: getCacheKey(args[0]),
},
onlyIfParent: true,
},
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
[CACHE_KEY]: getCacheKey(args[0]),
},
onlyIfParent: true,
},
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
[CACHE_KEY]: getCacheKey(args[0]),
},
onlyIfParent: true,
},
Expand Down
4 changes: 3 additions & 1 deletion packages/node/src/integrations/tracing/redis/cache.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
getCacheKeySafely,
getCacheOperation,
isInCommands,
REMOVE_COMMANDS,
shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
}

const cacheItemSize = calculateCacheItemSize(response);
// A remove response is a delete-count, not a cached value, so its size is meaningless.
const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

if (cacheItemSize) {
span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down
9 changes: 5 additions & 4 deletions packages/node/src/utils/redisCache.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
* Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
if (isInCommands(GET_COMMANDS, command)) {
return 'cache.get';
} else if (isInCommands(SET_COMMANDS, command)) {
return 'cache.put';
} else if (isInCommands(REMOVE_COMMANDS, command)) {
return 'cache.remove';
} else {
return undefined;
}
Expand Down
3 changes: 2 additions & 1 deletion packages/node/test/integrations/tracing/redis.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
calculateCacheItemSize,
GET_COMMANDS,
getCacheKeySafely,
REMOVE_COMMANDS,
SET_COMMANDS,
shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
expect(result).toBe(false);
});

GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
it(`should return true for ${command} command with matching prefix`, () => {
const key = ['cache:test-key'];
const result = shouldConsiderForCache(command, key, prefixes);
Expand Down
31 changes: 25 additions & 6 deletions packages/server-utils/src/integrations/tracing-channel/dataloader.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
if (Array.isArray(keyArg)) {
return keyArg.map(key => String(key));
}

return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
loader: DataLoaderInstance | undefined,
operation: Operation,
keyArg?: unknown,
): StartSpanOptions {
const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
onlyIfParent: true,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
},
};
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

const original = batchLoadFn as (...args: unknown[]) => unknown;
const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
// `batchLoadFn` receives the batched keys as its first argument.
return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
original.apply(this, args),
);
};
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
requiresParentSpan: true,
});

channel.end.subscribe(message => {
const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
bindTracingChannelToSpan(
diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
data => startInactiveSpanFor(data.self, operation),
data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
{ requiresParentSpan: true },
);
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
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(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389

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

msonnb
merged 4 commits into

from

Jul 21, 2026
 Merged


feat(node,server-utils): Set cache.key on dataloader spans and capture redis delete operations as cache.remove#22389
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
93a9dab

feat(node): Add `cache.key` attribute in dataloader spans


msonnb Jul 20, 2026
0af75dc

set op to `cache.remove` for redis delete commands


msonnb Jul 20, 2026
ece7d46

Update packages/server-utils/src/integrations/tracing-channel/dataloa…


msonnb Jul 21, 2026
d4fe083

Merge branch 'develop' into ms/cache-key-attribute


msonnb Jul 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadSpan?.status).toBe('ok');
 expect(loadSpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadSpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadSpan?.data?.['cache.key']).toEqual(['user-1']);
 // A direct operation is a client call; the deferred `batch` below gets no kind
 expect(loadSpan?.data?.['otel.kind']).toBe('CLIENT');

Expand All@@ -37,6 +38,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(batchSpan?.op).toBe(CACHE_GET_OP);
 expect(batchSpan?.origin).toBe(ORIGIN);
 expect(batchSpan?.status).toBe('ok');
 expect(batchSpan?.data?.['cache.key']).toEqual(['user-1']);
 expect(batchSpan?.data?.['otel.kind']).toBeUndefined();

 // The batch span links back to the load span that triggered it
Expand DownExpand Up@@ -64,6 +66,7 @@ describe('dataloader auto-instrumentation', () => {
 expect(loadManySpan?.status).toBe('ok');
 expect(loadManySpan?.data?.['sentry.origin']).toBe(ORIGIN);
 expect(loadManySpan?.data?.['sentry.op']).toBe(CACHE_GET_OP);
 expect(loadManySpan?.data?.['cache.key']).toEqual(['user-1', 'user-2']);
 },
 })
 .expect({
Expand Down

2 changes: 2 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/scenario-ioredis.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,8 @@ async function run() {
 await redis.get('ioredis-cache:unavailable-data');

 await redis.mget('test-key', 'ioredis-cache:test-key', 'ioredis-cache:unavailable-data');

 await redis.del('ioredis-cache:test-key');
 } finally {
 await redis.disconnect();
 }
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,6 +27,8 @@ async function run() {

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

 await redisClient.del('redis-cache:test-key');

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

Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,8 @@ async function run() {

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

 await redisClient.del('redis-5-cache:test-key');

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

Expand Down

35 changes: 35 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/redis-cache/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -136,6 +136,19 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'network.peer.port': 6383,
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'ioredis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'del ioredis-cache:test-key',
 'cache.key': ['ioredis-cache:test-key'],
 'network.peer.address': 'localhost',
 'network.peer.port': 6383,
 }),
 }),
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Missing remove size assertion
Low Severity
This violates the testing rule about expect.objectContaining when a payload must omit a field: the new DEL expectations never assert that cache.item_size is absent, even though remove responses are intentionally excluded from size calculation. A regression that sets size again would still pass. Flagged because it was mentioned in this rules file.
Additional Locations (2)
Fix in CursorFix in Web
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit d4fe083. Configure here.
 ]),
 };

Expand DownExpand Up@@ -258,6 +271,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-test-key', 'redis-cache:test-key', 'redis-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-cache:test-key',
 'cache.key': ['redis-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand DownExpand Up@@ -400,6 +424,17 @@ describeWithDockerCompose('redis cache auto instrumentation', { workingDirectory
 'cache.key': ['redis-5-test-key', 'redis-5-cache:test-key', 'redis-5-cache:unavailable-data'],
 }),
 }),
 // DEL
 expect.objectContaining({
 description: 'redis-5-cache:test-key',
 op: 'cache.remove',
 origin: redisOrigin,
 data: expect.objectContaining({
 'sentry.origin': redisOrigin,
 'db.statement': 'DEL redis-5-cache:test-key',
 'cache.key': ['redis-5-cache:test-key'],
 }),
 }),
 ...batchSpans,
 // a failing command produces a span with an error status
 expect.objectContaining({
Expand Down

14 changes: 14 additions & 0 deletions
packages/node/src/integrations/tracing/dataloader/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
 */

import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { BatchLoadFn, DataLoader, DataLoaderConstructor } from './types';
import {
 SDK_VERSION,
Comment thread
isaacs marked this conversation as resolved.

Expand DownExpand Up@@ -59,6 +60,16 @@ function getSpanOp(operation: 'load' | 'loadMany' | 'batch' | 'prime' | 'clear'
 return undefined;
}

// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}
@cursorcursorBotJul 21, 2026

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Array keys mishandled on load
Medium Severity
getCacheKey uses Array.isArray to decide between a single key and a key list, but load can take an array as one composite key. In that case cache.key is expanded into multiple entries instead of one, so the span attribute no longer matches the actual dataloader key.
Additional Locations (1)
Fix in CursorFix in Web
Reviewed by Cursor Bugbot for commit ece7d46. Configure here.

export class DataloaderInstrumentation extends InstrumentationBase {
 constructor(config = {}) {
 super(PACKAGE_NAME, SDK_VERSION, config);
Expand DownExpand Up@@ -107,6 +118,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('batch'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -161,6 +173,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('load'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand DownExpand Up@@ -199,6 +212,7 @@ export class DataloaderInstrumentation extends InstrumentationBase {
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: getSpanOp('loadMany'),
 [CACHE_KEY]: getCacheKey(args[0]),
 },
 onlyIfParent: true,
 },
Expand Down

4 changes: 3 additions & 1 deletion
packages/node/src/integrations/tracing/redis/cache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 getCacheKeySafely,
 getCacheOperation,
 isInCommands,
 REMOVE_COMMANDS,
 shouldConsiderForCache,
} from '../../../utils/redisCache';
import type { IORedisResponseCustomAttributeFunction } from './vendored/types';
Expand DownExpand Up@@ -79,7 +80,8 @@ export const cacheResponseHook: IORedisResponseCustomAttributeFunction = (
 span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });
 }

 const cacheItemSize = calculateCacheItemSize(response);
 // A remove response is a delete-count, not a cached value, so its size is meaningless.
 const cacheItemSize = isInCommands(REMOVE_COMMANDS, redisCommand) ? undefined : calculateCacheItemSize(response);

 if (cacheItemSize) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
Expand Down

9 changes: 5 additions & 4 deletions
packages/node/src/utils/redisCache.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,8 @@ const SINGLE_ARG_COMMANDS = ['get', 'set', 'setex'];

export const GET_COMMANDS = ['get', 'mget'];
export const SET_COMMANDS = ['set', 'setex'];
// todo: del, expire
export const REMOVE_COMMANDS = ['del', 'unlink'];
// todo: expire (no matching cache convention op yet)

/** Checks if a given command is in the list of redis commands.
 * Useful because commands can come in lowercase or uppercase (depending on the library). */
Expand All@@ -13,13 +14,13 @@ export function isInCommands(redisCommands: string[], command: string): boolean
}

/** Determine cache operation based on redis statement */
export function getCacheOperation(
 command: string,
): 'cache.get' | 'cache.put' | 'cache.remove' | 'cache.flush' | undefined {
export function getCacheOperation(command: string): 'cache.get' | 'cache.put' | 'cache.remove' | undefined {
 if (isInCommands(GET_COMMANDS, command)) {
 return 'cache.get';
 } else if (isInCommands(SET_COMMANDS, command)) {
 return 'cache.put';
 } else if (isInCommands(REMOVE_COMMANDS, command)) {
 return 'cache.remove';
 } else {
 return undefined;
 }
Expand Down

3 changes: 2 additions & 1 deletion
packages/node/test/integrations/tracing/redis.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import {
 calculateCacheItemSize,
 GET_COMMANDS,
 getCacheKeySafely,
 REMOVE_COMMANDS,
 SET_COMMANDS,
 shouldConsiderForCache,
} from '../../../src/utils/redisCache';
Expand DownExpand Up@@ -256,7 +257,7 @@ describe('Redis', () => {
 expect(result).toBe(false);
 });

 GET_COMMANDS.concat(SET_COMMANDS).forEach(command => {
 GET_COMMANDS.concat(SET_COMMANDS, REMOVE_COMMANDS).forEach(command => {
 it(`should return true for ${command} command with matching prefix`, () => {
 const key = ['cache:test-key'];
 const result = shouldConsiderForCache(command, key, prefixes);
Expand Down

31 changes: 25 additions & 6 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { CACHE_KEY } from '@sentry/conventions/attributes';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
Expand DownExpand Up@@ -61,7 +62,21 @@ function getSpanName(loader: DataLoaderInstance | undefined, operation: Operatio
 return name ? `${MODULE_NAME}.${operation} ${name}` : `${MODULE_NAME}.${operation}`;
}

function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Operation): StartSpanOptions {
// `load` receives a single key, `loadMany`/`batch` receive a key array. Normalize both to the
// `string[]` shape `cache.key` expects.
function getCacheKey(keyArg: unknown): string[] | undefined {
 if (Array.isArray(keyArg)) {
 return keyArg.map(key => String(key));
 }

 return keyArg == null ? undefined : [String(keyArg)];
}

function makeSpanOptions(
 loader: DataLoaderInstance | undefined,
 operation: Operation,
 keyArg?: unknown,
): StartSpanOptions {
 const isCacheGet = operation === 'load' || operation === 'loadMany' || operation === 'batch';

 return {
Expand All@@ -74,6 +89,7 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 onlyIfParent: true,
 attributes: {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
 [CACHE_KEY]: isCacheGet ? getCacheKey(keyArg) : undefined,
 },
 };
}
Expand DownExpand Up@@ -117,7 +133,8 @@ function subscribeConstruct(): void {

 const original = batchLoadFn as (...args: unknown[]) => unknown;
 const wrapped = function (this: DataLoaderInstance, ...args: unknown[]): unknown {
 return startSpan({ ...makeSpanOptions(this, 'batch'), links: this._batch?.spanLinks }, () =>
 // `batchLoadFn` receives the batched keys as its first argument.
 return startSpan({ ...makeSpanOptions(this, 'batch', args[0]), links: this._batch?.spanLinks }, () =>
 original.apply(this, args),
 );
 };
Expand All@@ -139,7 +156,9 @@ function subscribeConstruct(): void {
function subscribeLoad(): void {
 const channel = diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(CHANNELS.DATALOADER_LOAD);

 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load'), { requiresParentSpan: true });
 bindTracingChannelToSpan(channel, data => startInactiveSpanFor(data.self, 'load', data.arguments[0]), {
 requiresParentSpan: true,
 });

 channel.end.subscribe(message => {
 const data = message as TracingChannelPayloadWithSpan<DataLoaderChannelContext>;
Expand All@@ -154,13 +173,13 @@ function subscribeLoad(): void {
function subscribeSimpleOperation(channelName: ChannelName, operation: Operation): void {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<DataLoaderChannelContext>(channelName),
 data => startInactiveSpanFor(data.self, operation),
 data => startInactiveSpanFor(data.self, operation, data.arguments[0]),
 { requiresParentSpan: true },
 );
}

function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation));
function startInactiveSpanFor(loader: DataLoaderInstance | undefined, operation: Operation, keyArg?: unknown): Span {
 return startInactiveSpan(makeSpanOptions(loader, operation, keyArg));
}

/**
Expand Down
Loading