feat(server-utils): Emit low cardinality redis span names#23741

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
Lms24 merged 8 commits into from
Sep 2, 2026
Merged

feat(server-utils): Emit low cardinality redis span names #23741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0b60ddf
feat(server-utils)!: Emit low cardinality redis span names
Lms24 Aug 28, 2026
46d70fc
feat(server-utils): Name streamed redis spans after the command
Lms24 Aug 28, 2026
87ef892
feat(server-utils): Pair streamed redis span names with the connection
Lms24 Aug 31, 2026
a91f403
test: Follow the low-cardinality `cache.*` span names in the redis DC…
Lms24 Sep 2, 2026
bd92171
feat(server-utils): Report node-redis' own connection defaults
Lms24 Sep 2, 2026
3bb8e19
docs(migration): Document the redis span name changes
Lms24 Sep 2, 2026
3029b69
docs: Clarify why unix sockets have no span name target
Lms24 Sep 2, 2026
6a59114
test(e2e): Expect low cardinality redis span names in react-router-7
Lms24 Sep 2, 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
45 changes: 26 additions & 19 deletions MIGRATION.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 12 additions & 3 deletions ...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

const childSpans = spans.filter(span => !span.is_segment);

// Under span streaming a redis span is named after the operation and the connection — the key
// it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
// a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
expect(childSpans).toContainEqual(
expect.objectContaining({
name: 'set test-key [1 other arguments]',
name: 'set localhost:6379',
status: 'ok',
attributes: expect.objectContaining({
'sentry.op': { value: 'db.query', type: 'string' },
'sentry.origin': { value: 'auto.db.redis', type: 'string' },
'db.system.name': { value: 'redis', type: 'string' },
'db.operation.name': { value: 'set', type: 'string' },
'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 6379, type: 'integer' },
}),
}),
);
expect(childSpans).toContainEqual(
expect.objectContaining({
name: 'get test-key',
name: 'get localhost:6379',
status: 'ok',
attributes: expect.objectContaining({
'sentry.op': { value: 'db.query', type: 'string' },
'sentry.origin': { value: 'auto.db.redis', type: 'string' },
'db.system.name': { value: 'redis', type: 'string' },
'db.operation.name': { value: 'get', type: 'string' },
'db.query.text': { value: 'get test-key', type: 'string' },
'server.address': { value: 'localhost', type: 'string' },
'server.port': { value: 6379, type: 'integer' },
}),
}),
);

// Each command maps to exactly one span (no offline-queue duplicate).
const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
const setSpans = spans.filter(
span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
);
expect(setSpans).toHaveLength(1);

// Every db span nests under the native instrumentation-API http.server segment.
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
traceLifecycle: 'static',
traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
Expand Down
133 changes: 132 additions & 1 deletion dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
.completed();
});
});

// The same commands as above, asserted on the streamed span container. With span streaming the
// db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
// `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
describe('streamed', () => {
const ORIGIN = 'auto.db.redis.diagnostic_channel';
const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
const HOST = '127.0.0.1';
const PORT = 6382;

const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
value,
});

// Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
// as plain values and wrapped here.
const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
return {
name,
attributes: {
...streamAttributes({
'db.system.name': 'redis',
'sentry.environment': 'production',
'sentry.op': op,
'sentry.origin': ORIGIN,
'sentry.release': '1.0',
'sentry.sdk.name': 'sentry.javascript.node',
'sentry.segment.name': SEGMENT_NAME,
'server.address': HOST,
'server.port': PORT,
[SENTRY_TRACE_LIFECYCLE]: 'stream',
...attributes,
}),
'sentry.sdk.version': { type: 'string', value: expect.any(String) },
'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
},
end_timestamp: expect.any(Number),
is_segment: false,
parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
span_id: expect.stringMatching(/^[\da-f]{16}$/),
start_timestamp: expect.any(Number),
status: 'ok',
trace_id: expect.stringMatching(/^[\da-f]{32}$/),
};
}

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

// A cache span is a db span the cache hook took over: it is renamed to its cache operation
// and reports the connection it inherited as peer attributes too.
const cacheSpan = (
op: 'cache.get' | 'cache.put' | 'cache.remove',
attributes: Record<string, unknown>,
): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
test(
'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
{ timeout: 75_000 },
async () => {
await createTestRunner()
.withEnv({ STREAMED: 'true' })
.expect({
span: (container: SerializedStreamedSpanContainer) => {
// The connect span opens its own segment but shares the trace with the test span,
// so both segments arrive in the same container.
expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
'redis-connect',
SEGMENT_NAME,
]);

// ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
// channel too, but belong to the connect segment — the test span's children are the
// commands the scenario issues.
const spans = container.items.filter(
item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
);

expect(spans).toEqual([
streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
'db.operation.name': 'set',
'db.query.text': 'set dc-test-key ?',
}),
cacheSpan('cache.put', {
'db.operation.name': 'set',
'db.query.text': 'set dc-cache:test-key ?',
'cache.key': ['dc-cache:test-key'],
'cache.item_size': 2,
}),
cacheSpan('cache.put', {
'db.operation.name': 'set',
'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
'cache.key': ['dc-cache:test-key-ex'],
'cache.item_size': 2,
}),
streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
'db.operation.name': 'get',
'db.query.text': 'get dc-test-key',
}),
cacheSpan('cache.get', {
'db.operation.name': 'get',
'db.query.text': 'get dc-cache:test-key',
'cache.key': ['dc-cache:test-key'],
'cache.hit': true,
'cache.item_size': 10,
}),
cacheSpan('cache.get', {
'db.operation.name': 'get',
'db.query.text': 'get dc-cache:unavailable-data',
'cache.key': ['dc-cache:unavailable-data'],
'cache.hit': false,
}),
streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
'db.operation.name': 'mget',
'db.query.text': 'mget ? ? ?',
}),
]);
},
})
.start()
.completed();
},
);
});
});
},
);
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading

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

Skip to content
feat(server-utils): Emit low cardinality redis span names#23741

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

Lms24
merged 8 commits into

from

Sep 2, 2026
 Merged


feat(server-utils): Emit low cardinality redis span names
#23741
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
0b60ddf

feat(server-utils)!: Emit low cardinality redis span names


Lms24 Aug 28, 2026
46d70fc

feat(server-utils): Name streamed redis spans after the command


Lms24 Aug 28, 2026
87ef892

feat(server-utils): Pair streamed redis span names with the connection


Lms24 Aug 31, 2026
a91f403

test: Follow the low-cardinality `cache.*` span names in the redis DC…


Lms24 Sep 2, 2026
bd92171

feat(server-utils): Report node-redis' own connection defaults


Lms24 Sep 2, 2026
3bb8e19

docs(migration): Document the redis span name changes


Lms24 Sep 2, 2026
3029b69

docs: Clarify why unix sockets have no span name target


Lms24 Sep 2, 2026
6a59114

test(e2e): Expect low cardinality redis span names in react-router-7


Lms24 Sep 2, 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


45 changes: 26 additions & 19 deletions
MIGRATION.md

View file


Open in desktop


Large diffs are not rendered by default.


15 changes: 12 additions & 3 deletions
...applications/react-router-7-framework-instrumentation/tests/performance/db.server.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,35 +22,44 @@ test.describe('server - orchestrion db instrumentation', () => {

 const childSpans = spans.filter(span => !span.is_segment);

 // Under span streaming a redis span is named after the operation and the connection — the key
 // it acts on is unbounded, so it stays on `db.query.text`. The route builds its client without
 // a host or port, so ioredis' own `localhost:6379` defaults are what the name reports.
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'set test-key [1 other arguments]',
 name: 'set localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'set', type: 'string' },
 'db.query.text': { value: 'set test-key [1 other arguments]', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );
 expect(childSpans).toContainEqual(
 expect.objectContaining({
 name: 'get test-key',
 name: 'get localhost:6379',
 status: 'ok',
 attributes: expect.objectContaining({
 'sentry.op': { value: 'db.query', type: 'string' },
 'sentry.origin': { value: 'auto.db.redis', type: 'string' },
 'db.system.name': { value: 'redis', type: 'string' },
 'db.operation.name': { value: 'get', type: 'string' },
 'db.query.text': { value: 'get test-key', type: 'string' },
 'server.address': { value: 'localhost', type: 'string' },
 'server.port': { value: 6379, type: 'integer' },
 }),
 }),
 );

 // Each command maps to exactly one span (no offline-queue duplicate).
 const setSpans = spans.filter(span => span.name === 'set test-key [1 other arguments]');
 const setSpans = spans.filter(
 span => span.attributes['db.query.text']?.value === 'set test-key [1 other arguments]',
 );
 expect(setSpans).toHaveLength(1);

 // Every db span nests under the native instrumentation-API http.server segment.
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/instrument.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 traceLifecycle: 'static',
 traceLifecycle: process.env.STREAMED === 'true' ? 'stream' : 'static',
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
Expand Down

133 changes: 132 additions & 1 deletion
dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import { afterAll, expect } from 'vitest';
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
import type { SerializedStreamedSpanContainer } from '@sentry/core';
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests, describeWithDockerCompose } from '../../../utils/runner';

describeWithDockerCompose(
Expand DownExpand Up@@ -103,5 +105,134 @@ describeWithDockerCompose(
 .completed();
 });
 });

 // The same commands as above, asserted on the streamed span container. With span streaming the
 // db spans are named `{db.operation.name} {server.address}:{server.port}` instead of
 // `redis-{command}`. ioredis reports its commands lowercase, so the name follows suit.
 describe('streamed', () => {
 const ORIGIN = 'auto.db.redis.diagnostic_channel';
 const SEGMENT_NAME = 'Test Span IORedis 5.11 DC';
 const HOST = '127.0.0.1';
 const PORT = 6382;

 const streamAttribute = (value: unknown): { type: string; value: unknown } => ({
 type: Array.isArray(value) ? 'array' : Number.isInteger(value) ? 'integer' : typeof value,
 value,
 });

 // Streamed spans carry `{ type, value }` attribute pairs; the expectations below are written
 // as plain values and wrapped here.
 const streamAttributes = (values: Record<string, unknown>): Record<string, unknown> =>
 Object.fromEntries(Object.entries(values).map(([key, value]) => [key, streamAttribute(value)]));

 function streamedSpan(name: string, op: string, attributes: Record<string, unknown>): unknown {
 return {
 name,
 attributes: {
 ...streamAttributes({
 'db.system.name': 'redis',
 'sentry.environment': 'production',
 'sentry.op': op,
 'sentry.origin': ORIGIN,
 'sentry.release': '1.0',
 'sentry.sdk.name': 'sentry.javascript.node',
 'sentry.segment.name': SEGMENT_NAME,
 'server.address': HOST,
 'server.port': PORT,
 [SENTRY_TRACE_LIFECYCLE]: 'stream',
 ...attributes,
 }),
 'sentry.sdk.version': { type: 'string', value: expect.any(String) },
 'sentry.segment.id': { type: 'string', value: expect.stringMatching(/^[\da-f]{16}$/) },
 },
 end_timestamp: expect.any(Number),
 is_segment: false,
 parent_span_id: expect.stringMatching(/^[\da-f]{16}$/),
 span_id: expect.stringMatching(/^[\da-f]{16}$/),
 start_timestamp: expect.any(Number),
 status: 'ok',
 trace_id: expect.stringMatching(/^[\da-f]{32}$/),
 };
 }

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

 // A cache span is a db span the cache hook took over: it is renamed to its cache operation
 // and reports the connection it inherited as peer attributes too.
 const cacheSpan = (
 op: 'cache.get' | 'cache.put' | 'cache.remove',
 attributes: Record<string, unknown>,
 ): unknown => streamedSpan(op, op, { ...PEER, 'cache.operation': op.slice('cache.'.length), ...attributes });

 createEsmAndCjsTests(__dirname, 'scenario-ioredis-5-11.mjs', 'instrument.mjs', (createTestRunner, test) => {
 test(
 'creates streamed spans for ioredis v5.11 commands via diagnostics_channel',
 { timeout: 75_000 },
 async () => {
 await createTestRunner()
 .withEnv({ STREAMED: 'true' })
 .expect({
 span: (container: SerializedStreamedSpanContainer) => {
 // The connect span opens its own segment but shares the trace with the test span,
 // so both segments arrive in the same container.
 expect(container.items.filter(item => item.is_segment).map(item => item.name)).toEqual([
 'redis-connect',
 SEGMENT_NAME,
 ]);

 // ioredis' own handshake commands (`client SETINFO`, `info`) are emitted on the
 // channel too, but belong to the connect segment — the test span's children are the
 // commands the scenario issues.
 const spans = container.items.filter(
 item => !item.is_segment && item.attributes['sentry.segment.name']?.value === SEGMENT_NAME,
 );

 expect(spans).toEqual([
 streamedSpan(`set ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-test-key ?',
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key ?',
 'cache.key': ['dc-cache:test-key'],
 'cache.item_size': 2,
 }),
 cacheSpan('cache.put', {
 'db.operation.name': 'set',
 'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
 'cache.key': ['dc-cache:test-key-ex'],
 'cache.item_size': 2,
 }),
 streamedSpan(`get ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-test-key',
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:test-key',
 'cache.key': ['dc-cache:test-key'],
 'cache.hit': true,
 'cache.item_size': 10,
 }),
 cacheSpan('cache.get', {
 'db.operation.name': 'get',
 'db.query.text': 'get dc-cache:unavailable-data',
 'cache.key': ['dc-cache:unavailable-data'],
 'cache.hit': false,
 }),
 streamedSpan(`mget ${HOST}:${PORT}`, 'db.query', {
 'db.operation.name': 'mget',
 'db.query.text': 'mget ? ? ?',
 }),
 ]);
 },
 })
 .start()
 .completed();
 },
 );
 });
 });
 },
);
Loading
Loading