Skip to content

fix(redis): bring span attributes into alignment with conventions #21255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isaacs wants to merge 1 commit into
base: isaacs/sentry-internal-server-utils
Choose a base branch
from
Open

fix(redis): bring span attributes into alignment with conventions #21255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions dev-packages/e2e-tests/test-applications/deno-redis/tests/ioredis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ test('ioredis GET emits an http.server transaction containing a db.redis child s
expect(redisSpan).toBeDefined();
// ioredis publishes lowercase command names; node-redis publishes uppercase.
expect(redisSpan!.description).toBe('redis-get');
expect(redisSpan!.data?.['db.system']).toBe('redis');
expect(redisSpan!.data?.['db.statement']).toBe('get iocache:user:42');
expect(redisSpan!.data?.['db.system.name']).toBe('redis');
expect(redisSpan!.data?.['db.query.text']).toBe('get iocache:user:42');
});

test('ioredis SET then GET emit two db.redis child spans on the same transaction', async ({ baseURL }) => {
Expand Down
8 changes: 4 additions & 4 deletions dev-packages/e2e-tests/test-applications/deno-redis/tests/redis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ test('GET command emits an http.server transaction containing a db.redis child s
const redisSpan = transaction.spans!.find(span => span.op === 'db.redis');
expect(redisSpan).toBeDefined();
expect(redisSpan!.description).toBe('redis-GET');
expect(redisSpan!.data?.['db.system']).toBe('redis');
expect(redisSpan!.data?.['db.system.name']).toBe('redis');
// Statement omits the value; for GET the only allowed arg is the key.
expect(redisSpan!.data?.['db.statement']).toBe('GET cache:user:42');
expect(redisSpan!.data?.['net.peer.port']).toBe(6379);
expect(redisSpan!.data?.['db.query.text']).toBe('GET cache:user:42');
expect(redisSpan!.data?.['server.port']).toBe(6379);
});

test('SET then GET emit two db.redis child spans on the same transaction', async ({ baseURL }) => {
Expand Down Expand Up @@ -65,7 +65,7 @@ test('MULTI batch emits a PIPELINE/MULTI batch span', async ({ baseURL }) => {
const batchSpan = transaction.spans!.find(span => span.description === 'MULTI' || span.description === 'PIPELINE');
expect(batchSpan).toBeDefined();
expect(batchSpan!.op).toBe('db.redis');
expect(batchSpan!.data?.['db.system']).toBe('redis');
expect(batchSpan!.data?.['db.system.name']).toBe('redis');
});

test('shut down redis client', async ({ baseURL }) => {
Expand Down
20 changes: 10 additions & 10 deletions dev-packages/node-integration-tests/suites/tracing/ioredis-dc/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'set dc-test-key ?',
'db.system.name': 'redis',
'db.query.text': 'set dc-test-key ?',
}),
}),
expect.objectContaining({
Expand All @@ -25,7 +25,7 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'set dc-cache:test-key ?',
'db.query.text': 'set dc-cache:test-key ?',
'cache.key': ['dc-cache:test-key'],
'cache.item_size': 2,
}),
Expand All @@ -36,7 +36,7 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'set dc-cache:test-key-ex ? ? ?',
'db.query.text': 'set dc-cache:test-key-ex ? ? ?',
'cache.key': ['dc-cache:test-key-ex'],
'cache.item_size': 2,
}),
Expand All @@ -47,8 +47,8 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'get dc-test-key',
'db.system.name': 'redis',
'db.query.text': 'get dc-test-key',
}),
}),
expect.objectContaining({
Expand All @@ -57,7 +57,7 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'get dc-cache:test-key',
'db.query.text': 'get dc-cache:test-key',
'cache.hit': true,
'cache.key': ['dc-cache:test-key'],
'cache.item_size': 10,
Expand All @@ -69,7 +69,7 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'get dc-cache:unavailable-data',
'db.query.text': 'get dc-cache:unavailable-data',
'cache.hit': false,
'cache.key': ['dc-cache:unavailable-data'],
}),
Expand All @@ -80,8 +80,8 @@ describe('ioredis v5.11 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'mget ? ? ?',
'db.system.name': 'redis',
'db.query.text': 'mget ? ? ?',
}),
}),
]),
Expand Down
20 changes: 10 additions & 10 deletions dev-packages/node-integration-tests/suites/tracing/redis-dc/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'SET dc-test-key ?',
'db.system.name': 'redis',
'db.query.text': 'SET dc-test-key ?',
}),
}),
// cache SET: span name updated to key by cacheResponseHook
Expand All @@ -26,7 +26,7 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'SET dc-cache:test-key ?',
'db.query.text': 'SET dc-cache:test-key ?',
'cache.key': ['dc-cache:test-key'],
'cache.item_size': 2,
}),
Expand All @@ -38,7 +38,7 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'SET dc-cache:test-key-ex ? ? ?',
'db.query.text': 'SET dc-cache:test-key-ex ? ? ?',
'cache.key': ['dc-cache:test-key-ex'],
'cache.item_size': 2,
}),
Expand All @@ -49,8 +49,8 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'GET dc-test-key',
'db.system.name': 'redis',
'db.query.text': 'GET dc-test-key',
}),
}),
// cache GET (hit)
Expand All @@ -60,7 +60,7 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'GET dc-cache:test-key',
'db.query.text': 'GET dc-cache:test-key',
'cache.hit': true,
'cache.key': ['dc-cache:test-key'],
'cache.item_size': 10,
Expand All @@ -73,7 +73,7 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
origin: 'auto.db.redis.diagnostic_channel',
data: expect.objectContaining({
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.statement': 'GET dc-cache:unavailable-data',
'db.query.text': 'GET dc-cache:unavailable-data',
'cache.hit': false,
'cache.key': ['dc-cache:unavailable-data'],
}),
Expand All @@ -86,8 +86,8 @@ describe('redis v5 diagnostics_channel auto instrumentation', () => {
data: expect.objectContaining({
'sentry.op': 'db.redis',
'sentry.origin': 'auto.db.redis.diagnostic_channel',
'db.system': 'redis',
'db.statement': 'MGET ? ? ?',
'db.system.name': 'redis',
'db.query.text': 'MGET ? ? ?',
}),
}),
]),
Expand Down
16 changes: 8 additions & 8 deletions packages/deno/test/deno-redis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,10 @@ Deno.test('denoRedisIntegration: node-redis:command channel produces a db.redis
const redisSpan = parent.spans?.find(s => s.op === 'db.redis');
assertExists(redisSpan, `expected a db.redis child span, got ops: ${parent.spans?.map(s => s.op).join(', ')}`);
assertEquals(redisSpan!.description, 'redis-GET');
assertEquals(redisSpan!.data?.['db.system'], 'redis');
assertEquals(redisSpan!.data?.['db.statement'], 'GET cache:key');
assertEquals(redisSpan!.data?.['net.peer.name'], '127.0.0.1');
assertEquals(redisSpan!.data?.['net.peer.port'], 6379);
assertEquals(redisSpan!.data?.['db.system.name'], 'redis');
assertEquals(redisSpan!.data?.['db.query.text'], 'GET cache:key');
assertEquals(redisSpan!.data?.['server.address'], '127.0.0.1');
assertEquals(redisSpan!.data?.['server.port'], 6379);
});

Deno.test('denoRedisIntegration: errors on the command channel set span status', async () => {
Expand Down Expand Up @@ -165,8 +165,8 @@ Deno.test('denoRedisIntegration: ioredis:command channel produces a db.redis chi
const redisSpan = parent.spans?.find(s => s.op === 'db.redis');
assertExists(redisSpan, `expected a db.redis child span, got ops: ${parent.spans?.map(s => s.op).join(', ')}`);
assertEquals(redisSpan!.description, 'redis-get');
assertEquals(redisSpan!.data?.['db.system'], 'redis');
assertEquals(redisSpan!.data?.['db.statement'], 'get cache:key');
assertEquals(redisSpan!.data?.['net.peer.name'], '127.0.0.1');
assertEquals(redisSpan!.data?.['net.peer.port'], 6379);
assertEquals(redisSpan!.data?.['db.system.name'], 'redis');
assertEquals(redisSpan!.data?.['db.query.text'], 'get cache:key');
assertEquals(redisSpan!.data?.['server.address'], '127.0.0.1');
assertEquals(redisSpan!.data?.['server.port'], 6379);
});
43 changes: 24 additions & 19 deletions packages/server-utils/src/redis/redis-dc-subscriber.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@ export const IOREDIS_DC_CHANNEL_CONNECT = 'ioredis:connect';

const ORIGIN = 'auto.db.redis.diagnostic_channel';

// Inlined semconv attribute keys — these are plain strings, no need to depend
// on @opentelemetry/semantic-conventions for them.
const ATTR_DB_STATEMENT = 'db.statement';
const ATTR_DB_SYSTEM = 'db.system';
const ATTR_NET_PEER_NAME = 'net.peer.name';
const ATTR_NET_PEER_PORT = 'net.peer.port';
const DB_SYSTEM_VALUE_REDIS = 'redis';
// Inlined stable semconv attribute keys — these are plain strings, no need to
// depend on @opentelemetry/semantic-conventions for them. We use the stable
// OTel names (matching `@sentry/core`'s postgresjs integration) rather than the
// deprecated `db.statement`/`db.system`/`net.peer.*` forms.
const ATTR_DB_QUERY_TEXT = 'db.query.text';
const ATTR_DB_SYSTEM_NAME = 'db.system.name';
const ATTR_DB_OPERATION_BATCH_SIZE = 'db.operation.batch.size';
const ATTR_SERVER_ADDRESS = 'server.address';
const ATTR_SERVER_PORT = 'server.port';
const DB_SYSTEM_NAME_VALUE_REDIS = 'redis';

const NOOP = (): void => {};

Expand All @@ -37,7 +40,7 @@ const NOOP = (): void => {};
* `sanitizeArgs` in @redis/client) using the OTel `redis-common` rules. The
* arg array is `[<command>, <safe arg>, ..., '?', ...]` — `?` replaces any
* value the library considers sensitive. Subscribers can emit `args` directly
* as `db.statement` without further serialization.
* as `db.query.text` without further serialization.
*/
export interface RedisCommandData {
command: string;
Expand Down Expand Up @@ -203,10 +206,10 @@ function setupCommandChannel<T extends RedisCommandData | IORedisCommandData>(
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db.redis',
[ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
[ATTR_DB_STATEMENT]: statement,
...(data.serverAddress != null ? { [ATTR_NET_PEER_NAME]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_NET_PEER_PORT]: data.serverPort } : {}),
[ATTR_DB_SYSTEM_NAME]: DB_SYSTEM_NAME_VALUE_REDIS,
[ATTR_DB_QUERY_TEXT]: statement,
Comment thread
cursor[bot] marked this conversation as resolved.
...(data.serverAddress != null ? { [ATTR_SERVER_ADDRESS]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_SERVER_PORT]: data.serverPort } : {}),
},
},
span => span,
Expand Down Expand Up @@ -247,10 +250,12 @@ function setupBatchChannel(
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db.redis',
[ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
...(data.batchSize != null ? { 'db.redis.batch_size': data.batchSize } : {}),
...(data.serverAddress != null ? { [ATTR_NET_PEER_NAME]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_NET_PEER_PORT]: data.serverPort } : {}),
[ATTR_DB_SYSTEM_NAME]: DB_SYSTEM_NAME_VALUE_REDIS,
// should only include batch size greater than 1,
// or else it isn't properly considered a "batch"
...(Number(data.batchSize) > 1 ? { [ATTR_DB_OPERATION_BATCH_SIZE]: data.batchSize } : {}),
...(data.serverAddress != null ? { [ATTR_SERVER_ADDRESS]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_SERVER_PORT]: data.serverPort } : {}),
},
},
span => span,
Comment thread
isaacs marked this conversation as resolved.
Expand Down Expand Up @@ -283,9 +288,9 @@ function setupConnectChannel(tracingChannel: RedisTracingChannelFactory, channel
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db.redis.connect',
[ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,
...(data.serverAddress != null ? { [ATTR_NET_PEER_NAME]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_NET_PEER_PORT]: data.serverPort } : {}),
[ATTR_DB_SYSTEM_NAME]: DB_SYSTEM_NAME_VALUE_REDIS,
...(data.serverAddress != null ? { [ATTR_SERVER_ADDRESS]: data.serverAddress } : {}),
...(data.serverPort != null ? { [ATTR_SERVER_PORT]: data.serverPort } : {}),
},
},
span => span,
Expand Down
Loading