Skip to content

Commit d4e997e

Browse files
Lms24Lms24
authored
ref(core): Use common span attribute keys from Sentry conventions (#22081)
Deprecates a few of our attribute key exports, in favour of the same attribute keys in `@sentry/conventions`. Replaces all usage of the attributes across the codebase.
1 parent 0504d25 commit d4e997e

9 files changed

Lines changed: 170 additions & 140 deletions

File tree

  • dev-packages
    • browser-integration-tests/suites
      • public-api/startSpan/streamed
      • tracing/browserTracingIntegration
    • cloudflare-integration-tests/suites/public-api/startSpan-streamed
    • node-core-integration-tests/suites/public-api/startSpan/basic-usage-streamed
    • node-integration-tests/suites/public-api/startSpan/basic-usage-streamed
  • packages/core

‎dev-packages/browser-integration-tests/suites/public-api/startSpan/streamed/test.ts‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ import {
66
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
77
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
88
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
9-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
10-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
11-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
12-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
139
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
1410
SEMANTIC_ATTRIBUTE_SENTRY_STATUS_MESSAGE,
1511
} from '@sentry/core';
1612
import { sentryTest } from '../../../../utils/fixtures';
1713
import { shouldSkipTracingTest } from '../../../../utils/helpers';
1814
import { waitForStreamedSpanEnvelope } from '../../../../utils/spanUtils';
19-
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
15+
import {
16+
SENTRY_SEGMENT_ID,
17+
SENTRY_SEGMENT_NAME,
18+
SENTRY_SDK_NAME,
19+
SENTRY_SDK_VERSION,
20+
SENTRY_TRACE_LIFECYCLE,
21+
} from '@sentry/conventions/attributes';
2022

2123
sentryTest(
2224
'sends a streamed span envelope if spanStreamingIntegration is enabled',
@@ -81,19 +83,19 @@ sentryTest(
8183
type: 'string',
8284
value: 'manual',
8385
},
84-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
86+
[SENTRY_SDK_NAME]: {
8587
type: 'string',
8688
value: 'sentry.javascript.browser',
8789
},
88-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
90+
[SENTRY_SDK_VERSION]: {
8991
type: 'string',
9092
value: SDK_VERSION,
9193
},
92-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
94+
[SENTRY_SEGMENT_ID]: {
9395
type: 'string',
9496
value: segmentSpanId,
9597
},
96-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
98+
[SENTRY_SEGMENT_NAME]: {
9799
type: 'string',
98100
value: 'test-span',
99101
},
@@ -121,19 +123,19 @@ sentryTest(
121123
type: 'string',
122124
value: 'manual',
123125
},
124-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
126+
[SENTRY_SDK_NAME]: {
125127
type: 'string',
126128
value: 'sentry.javascript.browser',
127129
},
128-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
130+
[SENTRY_SDK_VERSION]: {
129131
type: 'string',
130132
value: SDK_VERSION,
131133
},
132-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
134+
[SENTRY_SEGMENT_ID]: {
133135
type: 'string',
134136
value: segmentSpanId,
135137
},
136-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
138+
[SENTRY_SEGMENT_NAME]: {
137139
type: 'string',
138140
value: 'test-span',
139141
},
@@ -161,19 +163,19 @@ sentryTest(
161163
type: 'string',
162164
value: 'manual',
163165
},
164-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
166+
[SENTRY_SDK_NAME]: {
165167
type: 'string',
166168
value: 'sentry.javascript.browser',
167169
},
168-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
170+
[SENTRY_SDK_VERSION]: {
169171
type: 'string',
170172
value: SDK_VERSION,
171173
},
172-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
174+
[SENTRY_SEGMENT_ID]: {
173175
type: 'string',
174176
value: segmentSpanId,
175177
},
176-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
178+
[SENTRY_SEGMENT_NAME]: {
177179
type: 'string',
178180
value: 'test-span',
179181
},
@@ -233,23 +235,23 @@ sentryTest(
233235
type: 'integer',
234236
value: 1,
235237
},
236-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
238+
[SENTRY_SDK_NAME]: {
237239
type: 'string',
238240
value: 'sentry.javascript.browser',
239241
},
240-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
242+
[SENTRY_SDK_VERSION]: {
241243
type: 'string',
242244
value: SDK_VERSION,
243245
},
244246
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: {
245247
type: 'array',
246248
value: expect.arrayContaining(['SpanStreaming']),
247249
},
248-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
250+
[SENTRY_SEGMENT_ID]: {
249251
type: 'string',
250252
value: segmentSpanId,
251253
},
252-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
254+
[SENTRY_SEGMENT_NAME]: {
253255
type: 'string',
254256
value: 'test-span',
255257
},

‎dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/interactions-streamed/test.ts‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ import {
66
SEMANTIC_ATTRIBUTE_SENTRY_OP,
77
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
88
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
9-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
10-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
11-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
12-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
139
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
1410
} from '@sentry/core';
15-
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
11+
import {
12+
SENTRY_SEGMENT_ID,
13+
SENTRY_SEGMENT_NAME,
14+
SENTRY_SDK_NAME,
15+
SENTRY_SDK_VERSION,
16+
SENTRY_TRACE_LIFECYCLE,
17+
} from '@sentry/conventions/attributes';
1618
import { sentryTest } from '../../../../utils/fixtures';
1719
import { shouldSkipTracingTest } from '../../../../utils/helpers';
1820
import { getSpanOp, waitForStreamedSpan, waitForStreamedSpans } from '../../../../utils/spanUtils';
@@ -79,23 +81,23 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
7981
type: 'string',
8082
value: 'manual', // TODO: This is incorrect but not from span streaming.
8183
},
82-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
84+
[SENTRY_SDK_NAME]: {
8385
type: 'string',
8486
value: 'sentry.javascript.browser',
8587
},
86-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
88+
[SENTRY_SDK_VERSION]: {
8789
type: 'string',
8890
value: SDK_VERSION,
8991
},
9092
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: {
9193
type: 'array',
9294
value: expect.arrayContaining(['BrowserTracing', 'SpanStreaming']),
9395
},
94-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
96+
[SENTRY_SEGMENT_ID]: {
9597
type: 'string',
9698
value: interactionSegmentSpan!.span_id,
9799
},
98-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
100+
[SENTRY_SEGMENT_NAME]: {
99101
type: 'string',
100102
value: '/index.html',
101103
},
@@ -139,19 +141,19 @@ sentryTest('captures streamed interaction span tree. @firefox', async ({ browser
139141
type: 'string',
140142
value: 'auto.ui.browser.metrics',
141143
},
142-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
144+
[SENTRY_SDK_NAME]: {
143145
type: 'string',
144146
value: 'sentry.javascript.browser',
145147
},
146-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
148+
[SENTRY_SDK_VERSION]: {
147149
type: 'string',
148150
value: SDK_VERSION,
149151
},
150-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
152+
[SENTRY_SEGMENT_ID]: {
151153
type: 'string',
152154
value: interactionSegmentSpan!.span_id,
153155
},
154-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
156+
[SENTRY_SEGMENT_NAME]: {
155157
type: 'string',
156158
value: '/index.html',
157159
},

‎dev-packages/browser-integration-tests/suites/tracing/browserTracingIntegration/pageload-streamed/test.ts‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ import {
66
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
77
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
88
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
9-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
10-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
11-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
12-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
139
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
1410
} from '@sentry/core';
15-
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
11+
import {
12+
SENTRY_SEGMENT_ID,
13+
SENTRY_SEGMENT_NAME,
14+
SENTRY_SDK_NAME,
15+
SENTRY_SDK_VERSION,
16+
SENTRY_TRACE_LIFECYCLE,
17+
} from '@sentry/conventions/attributes';
1618
import { sentryTest } from '../../../../utils/fixtures';
1719
import { shouldSkipTracingTest } from '../../../../utils/helpers';
1820
import { getSpanOp, getSpansFromEnvelope, waitForStreamedSpanEnvelope } from '../../../../utils/spanUtils';
@@ -133,23 +135,23 @@ sentryTest(
133135
type: 'integer',
134136
value: 1,
135137
},
136-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: {
138+
[SENTRY_SDK_NAME]: {
137139
type: 'string',
138140
value: 'sentry.javascript.browser',
139141
},
140-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: {
142+
[SENTRY_SDK_VERSION]: {
141143
type: 'string',
142144
value: SDK_VERSION,
143145
},
144146
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: {
145147
type: 'array',
146148
value: expect.arrayContaining(['BrowserTracing', 'SpanStreaming']),
147149
},
148-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: {
150+
[SENTRY_SEGMENT_ID]: {
149151
type: 'string',
150152
value: pageloadSpan?.span_id,
151153
},
152-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: {
154+
[SENTRY_SEGMENT_NAME]: {
153155
type: 'string',
154156
value: '/index.html',
155157
},

‎dev-packages/cloudflare-integration-tests/suites/public-api/startSpan-streamed/test.ts‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ import {
77
SEMANTIC_ATTRIBUTE_SENTRY_RELEASE,
88
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
99
SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS,
10-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME,
11-
SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION,
12-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID,
13-
SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME,
1410
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
1511
} from '@sentry/core';
16-
import { SENTRY_TRACE_LIFECYCLE } from '@sentry/conventions/attributes';
12+
import {
13+
SENTRY_SDK_NAME,
14+
SENTRY_SDK_VERSION,
15+
SENTRY_SEGMENT_ID,
16+
SENTRY_SEGMENT_NAME,
17+
SENTRY_TRACE_LIFECYCLE,
18+
} from '@sentry/conventions/attributes';
1719
import { expect, it } from 'vitest';
1820
import { createRunner } from '../../../runner';
1921

@@ -83,10 +85,10 @@ it('sends a streamed span envelope with correct spans for a manually started spa
8385
type: 'string',
8486
value: 'test-child',
8587
},
86-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
87-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
88-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
89-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
88+
[SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
89+
[SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
90+
[SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
91+
[SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
9092
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { type: 'string', value: '1.0.0' },
9193
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'manual' },
9294
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: { type: 'string', value: 'production' },
@@ -107,10 +109,10 @@ it('sends a streamed span envelope with correct spans for a manually started spa
107109
attributes: {
108110
[SENTRY_TRACE_LIFECYCLE]: { type: 'string', value: 'stream' },
109111
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'manual' },
110-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
111-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
112-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
113-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
112+
[SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
113+
[SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
114+
[SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
115+
[SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
114116
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { type: 'string', value: '1.0.0' },
115117
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: { type: 'string', value: 'production' },
116118
},
@@ -143,10 +145,10 @@ it('sends a streamed span envelope with correct spans for a manually started spa
143145
attributes: {
144146
[SENTRY_TRACE_LIFECYCLE]: { type: 'string', value: 'stream' },
145147
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'manual' },
146-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
147-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
148-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
149-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
148+
[SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
149+
[SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
150+
[SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
151+
[SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
150152
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { type: 'string', value: '1.0.0' },
151153
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: { type: 'string', value: 'production' },
152154
},
@@ -164,10 +166,10 @@ it('sends a streamed span envelope with correct spans for a manually started spa
164166
attributes: {
165167
[SENTRY_TRACE_LIFECYCLE]: { type: 'string', value: 'stream' },
166168
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: { type: 'string', value: 'test' },
167-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
168-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
169-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
170-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
169+
[SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
170+
[SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
171+
[SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
172+
[SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
171173
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { type: 'string', value: '1.0.0' },
172174
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'manual' },
173175
[SEMANTIC_ATTRIBUTE_SENTRY_ENVIRONMENT]: { type: 'string', value: 'production' },
@@ -185,16 +187,16 @@ it('sends a streamed span envelope with correct spans for a manually started spa
185187
expect(segmentSpan).toEqual({
186188
attributes: {
187189
[SENTRY_TRACE_LIFECYCLE]: { type: 'string', value: 'stream' },
188-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
189-
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
190+
[SENTRY_SDK_NAME]: { type: 'string', value: CLOUDFLARE_SDK },
191+
[SENTRY_SDK_VERSION]: { type: 'string', value: SDK_VERSION },
190192
[SEMANTIC_ATTRIBUTE_SENTRY_SDK_INTEGRATIONS]: {
191193
type: 'array',
192194
value: expect.arrayContaining(['SpanStreaming']),
193195
},
194196
[SEMANTIC_ATTRIBUTE_SENTRY_RELEASE]: { type: 'string', value: '1.0.0' },
195197
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: { type: 'string', value: 'auto.http.cloudflare' },
196-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
197-
[SEMANTIC_ATTRIBUTE_SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
198+
[SENTRY_SEGMENT_ID]: { type: 'string', value: segmentSpanId },
199+
[SENTRY_SEGMENT_NAME]: { type: 'string', value: segmentName },
198200
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: { type: 'string', value: 'http.server' },
199201
[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: { type: 'integer', value: 1 },
200202
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: { type: 'string', value: 'route' },

0 commit comments

Comments
 (0)