feat(core): Deprecate span tags, data, context & setters (#10053)

Also deprecate direct access to `span.attributes` (instead use
`spanToJSON(span)`).

There are a few usages that we still need to figure out how we will
replace them...!

Author: mydea

MIGRATION.md

@@ -100,6 +100,11 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
 * `span.description`: Use `spanToJSON(span).description` instead.
 * `transaction.setMetadata()`: Use attributes instead, or set data on the scope.
 * `transaction.metadata`: Use attributes instead, or set data on the scope.
+* `span.tags`: Set tags on the surrounding scope instead, or use attributes.
+* `span.data`: Use `spanToJSON(span).data` instead.
+* `span.setTag()`: Use `span.setAttribute()` instead or set tags on the surrounding scope.
+* `span.setData()`: Use `span.setAttribute()` instead.
+* `transaction.setContext()`: Set context on the surrounding scope instead.
 
 ## Deprecate `pushScope` & `popScope` in favor of `withScope`
 

dev-packages/browser-integration-tests/suites/public-api/startTransaction/basic_usage/test.ts

@@ -31,6 +31,7 @@ sentryTest('should report finished spans as children of the root transaction', a
   const span_1 = transaction.spans?.[0];
   expect(span_1?.op).toBe('span_1');
   expect(span_1?.parentSpanId).toEqual(rootSpanId);
+  // eslint-disable-next-line deprecation/deprecation
   expect(span_1?.data).toMatchObject({ foo: 'bar', baz: [1, 2, 3] });
 
   const span_3 = transaction.spans?.[1];

dev-packages/e2e-tests/test-applications/nextjs-app-dir/tests/transactions.test.ts

@@ -130,9 +130,9 @@ test('Should send a transaction for instrumented server actions', async ({ page
   await page.getByText('Run Action').click();
 
   expect(await serverComponentTransactionPromise).toBeDefined();
-  expect((await serverComponentTransactionPromise).contexts?.trace?.data?.['server_action_form_data']).toEqual(
-    expect.objectContaining({ 'some-text-value': 'some-default-value' }),
-  );
+  expect(
+    (await serverComponentTransactionPromise).contexts?.trace?.data?.['server_action_form_data.some-text-value'],
+  ).toEqual('some-default-value');
   expect((await serverComponentTransactionPromise).contexts?.trace?.data?.['server_action_result']).toEqual({
     city: 'Vienna',
   });

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/withoutCallback/scenario.ts

@@ -32,10 +32,10 @@ const query = connection.query('SELECT 1 + 1 AS solution');
 const query2 = connection.query('SELECT NOW()', ['1', '2']);
 
 query.on('end', () => {
-  transaction.setTag('result_done', 'yes');
+  transaction.setAttribute('result_done', 'yes');
 
   query2.on('end', () => {
-    transaction.setTag('result_done2', 'yes');
+    transaction.setAttribute('result_done2', 'yes');
 
     // Wait a bit to ensure the queries completed
     setTimeout(() => {

dev-packages/node-integration-tests/suites/tracing-new/auto-instrument/mysql/withoutCallback/test.ts

@@ -7,11 +7,15 @@ test('should auto-instrument `mysql` package when using query without callback',
   expect(envelope).toHaveLength(3);
 
   assertSentryTransaction(envelope[2], {
-    transaction: 'Test Transaction',
-    tags: {
-      result_done: 'yes',
-      result_done2: 'yes',
+    contexts: {
+      trace: {
+        data: {
+          result_done: 'yes',
+          result_done2: 'yes',
+        },
+      },
     },
+    transaction: 'Test Transaction',
     spans: [
       {
         description: 'SELECT 1 + 1 AS solution',

docs/v8-new-performance-apis.md

@@ -50,8 +50,8 @@ below to see which things used to exist, and how they can/should be mapped going
 | `status`              | use utility method TODO                              |
 | `sampled`             | `spanIsSampled(span)`                                |
 | `startTimestamp`      | `startTime` - note that this has a different format! |
-| `tags`                | `spanGetAttributes(span)`, or set tags on the scope  |
-| `data`                | `spanGetAttributes(span)`                            |
+| `tags`                | use attributes, or set tags on the scope             |
+| `data`                | `spanToJSON(span).data`                              |
 | `transaction`         | ??? Removed                                          |
 | `instrumenter`        | Removed                                              |
 | `finish()`            | `end()`                                              |
@@ -72,13 +72,13 @@ In addition, a transaction has this API:
 
 | Old name                    | Replace with                                     |
 | --------------------------- | ------------------------------------------------ |
-| `name`                      | `spanGetName(span)` (TODO)                       |
+| `name`                      | `spanToJSON(span).description`                   |
 | `trimEnd`                   | Removed                                          |
 | `parentSampled`             | `spanIsSampled(span)` & `spanContext().isRemote` |
-| `metadata`                  | `spanGetMetadata(span)`                          |
+| `metadata`                  | Use attributes instead or set on scope           |
 | `setContext()`              | Set context on scope instead                     |
 | `setMeasurement()`          | ??? TODO                                         |
-| `setMetadata()`             | `spanSetMetadata(span, metadata)`                |
+| `setMetadata()`             | Use attributes instead or set on scope           |
 | `getDynamicSamplingContext` | ??? TODO                                         |
 
 ### Attributes vs. Data vs. Tags vs. Context

packages/browser/src/profiling/hubextensions.ts

@@ -156,6 +156,8 @@ export function startProfileForTransaction(transaction: Transaction): Transactio
     // Always call onProfileHandler to ensure stopProfiling is called and the timeout is cleared.
     void onProfileHandler().then(
       () => {
+        // TODO: Can we rewrite this to use attributes?
+        // eslint-disable-next-line deprecation/deprecation
         transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });
         originalEnd();
       },

packages/bun/src/integrations/bunserver.ts

@@ -4,6 +4,7 @@ import {
   captureException,
   continueTrace,
   convertIntegrationFnToClass,
+  getCurrentScope,
   runWithAsyncContext,
   startSpan,
 } from '@sentry/core';
@@ -90,9 +91,10 @@ function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]
                   >);
                   if (response && response.status) {
                     span?.setHttpStatus(response.status);
-                    span?.setData('http.response.status_code', response.status);
+                    span?.setAttribute('http.response.status_code', response.status);
                     if (span instanceof Transaction) {
-                      span.setContext('response', {
+                      const scope = getCurrentScope();
+                      scope.setContext('response', {
                         headers: response.headers.toJSON(),
                         status_code: response.status,
                       });

packages/bun/test/integrations/bunserver.test.ts

@@ -26,6 +26,7 @@ describe('Bun Serve Integration', () => {
   test('generates a transaction around a request', async () => {
     client.on('finishTransaction', transaction => {
       expect(transaction.status).toBe('ok');
+      // eslint-disable-next-line deprecation/deprecation
       expect(transaction.tags).toEqual({
         'http.status_code': '200',
       });
@@ -48,6 +49,7 @@ describe('Bun Serve Integration', () => {
   test('generates a post transaction', async () => {
     client.on('finishTransaction', transaction => {
       expect(transaction.status).toBe('ok');
+      // eslint-disable-next-line deprecation/deprecation
       expect(transaction.tags).toEqual({
         'http.status_code': '200',
       });

packages/core/src/tracing/idletransaction.ts

@@ -146,7 +146,7 @@ export class IdleTransaction extends Transaction {
     this.activities = {};
 
     if (this.op === 'ui.action.click') {
-      this.setTag(FINISH_REASON_TAG, this._finishReason);
+      this.setAttribute(FINISH_REASON_TAG, this._finishReason);
     }
 
     if (this.spanRecorder) {