feat: Remove tags from spans & transactions

mydea · mydea · commit 81db979077dd · 2024-02-26T12:19:40.000Z
diff --git a/packages/core/src/tracing/sentrySpan.ts b/packages/core/src/tracing/sentrySpan.ts
@@ -1,5 +1,4 @@
 import type {
-  Primitive,
   Span as SpanInterface,
   SpanAttributeValue,
   SpanAttributes,
@@ -63,12 +62,6 @@ export class SpanRecorder {
  * Span contains all data about a span
  */
 export class SentrySpan implements SpanInterface {
-  /**
-   * Tags for the span.
-   * @deprecated Use `spanToJSON(span).atttributes` instead.
-   */
-  public tags: { [key: string]: Primitive };
-
   /**
    * Data for the span.
    * @deprecated Use `spanToJSON(span).atttributes` instead.
@@ -115,8 +108,6 @@ export class SentrySpan implements SpanInterface {
     this._spanId = spanContext.spanId || uuid4().substring(16);
     this._startTime = spanContext.startTimestamp || timestampInSeconds();
     // eslint-disable-next-line deprecation/deprecation
-    this.tags = spanContext.tags ? { ...spanContext.tags } : {};
-    // eslint-disable-next-line deprecation/deprecation
     this.data = spanContext.data ? { ...spanContext.data } : {};
 
     this._attributes = {};
@@ -338,21 +329,6 @@ export class SentrySpan implements SpanInterface {
     return childSpan;
   }
 
-  /**
-   * Sets the tag attribute on the current span.
-   *
-   * Can also be used to unset a tag, by passing `undefined`.
-   *
-   * @param key Tag key
-   * @param value Tag value
-   * @deprecated Use `setAttribute()` instead.
-   */
-  public setTag(key: string, value: Primitive): this {
-    // eslint-disable-next-line deprecation/deprecation
-    this.tags = { ...this.tags, [key]: value };
-    return this;
-  }
-
   /**
    * Sets the data attribute on the current span
    * @param key Data key
@@ -435,8 +411,6 @@ export class SentrySpan implements SpanInterface {
       spanId: this._spanId,
       startTimestamp: this._startTime,
       status: this._status,
-      // eslint-disable-next-line deprecation/deprecation
-      tags: this.tags,
       traceId: this._traceId,
     });
   }
@@ -457,8 +431,6 @@ export class SentrySpan implements SpanInterface {
     this._spanId = spanContext.spanId || this._spanId;
     this._startTime = spanContext.startTimestamp || this._startTime;
     this._status = spanContext.status;
-    // eslint-disable-next-line deprecation/deprecation
-    this.tags = spanContext.tags || {};
     this._traceId = spanContext.traceId || this._traceId;
 
     return this;
@@ -490,8 +462,6 @@ export class SentrySpan implements SpanInterface {
       span_id: this._spanId,
       start_timestamp: this._startTime,
       status: this._status,
-      // eslint-disable-next-line deprecation/deprecation
-      tags: Object.keys(this.tags).length > 0 ? this.tags : undefined,
       timestamp: this._endTime,
       trace_id: this._traceId,
       origin: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
diff --git a/packages/core/src/tracing/transaction.ts b/packages/core/src/tracing/transaction.ts
@@ -292,8 +292,6 @@ export class Transaction extends SentrySpan implements TransactionInterface {
       // TODO: Pass spans serialized via `spanToJSON()` here instead in v8.
       spans: finishedSpans,
       start_timestamp: this._startTime,
-      // eslint-disable-next-line deprecation/deprecation
-      tags: this.tags,
       timestamp: this._endTime,
       transaction: this._name,
       type: 'transaction',
diff --git a/packages/core/src/utils/spanUtils.ts b/packages/core/src/utils/spanUtils.ts
@@ -11,15 +11,14 @@ export const TRACE_FLAG_SAMPLED = 0x1;
  */
 export function spanToTraceContext(span: Span): TraceContext {
   const { spanId: span_id, traceId: trace_id } = span.spanContext();
-  const { data, op, parent_span_id, status, tags, origin } = spanToJSON(span);
+  const { data, op, parent_span_id, status, origin } = spanToJSON(span);
 
   return dropUndefinedKeys({
     data,
     op,
     parent_span_id,
     span_id,
     status,
-    tags,
     trace_id,
     origin,
   });
diff --git a/packages/opentelemetry/src/spanExporter.ts b/packages/opentelemetry/src/spanExporter.ts
@@ -145,7 +145,7 @@ function createTransactionForOtelSpan(span: ReadableSpan): Transaction {
 
   const parentSampled = span.attributes[InternalSentrySemanticAttributes.PARENT_SAMPLED] as boolean | undefined;
 
-  const { op, description, tags, data, origin, source } = getSpanData(span);
+  const { op, description, data, origin, source } = getSpanData(span);
   const metadata = getSpanMetadata(span);
   const capturedSpanScopes = getSpanScopes(span);
 
@@ -167,7 +167,6 @@ function createTransactionForOtelSpan(span: ReadableSpan): Transaction {
     },
     data: removeSentryAttributes(data),
     origin,
-    tags,
     sampled: true,
   });
 
@@ -203,7 +202,7 @@ function createAndFinishSpanForOtelSpan(node: SpanNode, sentryParentSpan: Sentry
   const spanId = span.spanContext().spanId;
   const { attributes } = span;
 
-  const { op, description, tags, data, origin } = getSpanData(span);
+  const { op, description, data, origin } = getSpanData(span);
   const allData = { ...removeSentryAttributes(attributes), ...data };
 
   // eslint-disable-next-line deprecation/deprecation
@@ -215,7 +214,6 @@ function createAndFinishSpanForOtelSpan(node: SpanNode, sentryParentSpan: Sentry
     startTimestamp: convertOtelTimeToSeconds(span.startTime),
     spanId,
     origin,
-    tags,
   });
 
   node.children.forEach(child => {
@@ -226,7 +224,6 @@ function createAndFinishSpanForOtelSpan(node: SpanNode, sentryParentSpan: Sentry
 }
 
 function getSpanData(span: ReadableSpan): {
-  tags: Record<string, string>;
   data: Record<string, unknown>;
   op?: string;
   description: string;
@@ -239,15 +236,14 @@ function getSpanData(span: ReadableSpan): {
   const op = definedOp || inferredOp;
   const source = definedSource || inferredSource;
 
-  const tags = getTags(span);
   const data = { ...inferredData, ...getData(span) };
 
   return {
     op,
     description,
     source,
     origin,
-    tags,
+
     data,
   };
 }
@@ -270,18 +266,6 @@ function removeSentryAttributes(data: Record<string, unknown>): Record<string, u
   return cleanedData;
 }
 
-function getTags(span: ReadableSpan): Record<string, string> {
-  const attributes = span.attributes;
-  const tags: Record<string, string> = {};
-
-  if (attributes[SemanticAttributes.HTTP_STATUS_CODE]) {
-    const statusCode = attributes[SemanticAttributes.HTTP_STATUS_CODE] as string | number;
-    tags['http.status_code'] = `${statusCode}`;
-  }
-
-  return tags;
-}
-
 function getData(span: ReadableSpan): Record<string, unknown> {
   const attributes = span.attributes;
   const data: Record<string, unknown> = {
diff --git a/packages/profiling-node/test/hubextensions.test.ts b/packages/profiling-node/test/hubextensions.test.ts
@@ -15,7 +15,6 @@ import { __PRIVATE__wrapStartTransactionWithProfiling } from '../src/hubextensio
 function makeTransactionMock(options = {}): Transaction {
   return {
     metadata: {},
-    tags: {},
     sampled: true,
     contexts: {},
     startChild: () => ({ end: () => void 0 }),
@@ -29,10 +28,6 @@ function makeTransactionMock(options = {}): Transaction {
       // @ts-expect-error - contexts is private
       this.contexts[key] = context;
     },
-    setTag(this: Transaction, key: string, value: any) {
-      // eslint-disable-next-line deprecation/deprecation
-      this.tags[key] = value;
-    },
     setMetadata(this: Transaction, metadata: Partial<TransactionMetadata>) {
       // eslint-disable-next-line deprecation/deprecation
       this.metadata = { ...metadata } as TransactionMetadata;
diff --git a/packages/types/src/span.ts b/packages/types/src/span.ts
@@ -50,7 +50,6 @@ export interface SpanJSON {
   span_id: string;
   start_timestamp: number;
   status?: string;
-  tags?: { [key: string]: Primitive };
   timestamp?: number;
   trace_id: string;
   origin?: SpanOrigin;
@@ -134,12 +133,6 @@ export interface SpanContext {
    */
   traceId?: string | undefined;
 
-  /**
-   * Tags of the Span.
-   * @deprecated Pass `attributes` instead.
-   */
-  tags?: { [key: string]: Primitive };
-
   /**
    * Data of the Span.
    * @deprecated Pass `attributes` instead.
@@ -206,12 +199,6 @@ export interface Span extends Omit<SpanContext, 'name' | 'op' | 'status' | 'orig
    */
   endTimestamp?: number | undefined;
 
-  /**
-   * Tags for the span.
-   * @deprecated Use `spanToJSON(span).atttributes` instead.
-   */
-  tags: { [key: string]: Primitive };
-
   /**
    * Data for the span.
    * @deprecated Use `spanToJSON(span).atttributes` instead.
@@ -250,17 +237,6 @@ export interface Span extends Omit<SpanContext, 'name' | 'op' | 'status' | 'orig
    */
   end(endTimestamp?: SpanTimeInput): void;
 
-  /**
-   * Sets the tag attribute on the current span.
-   *
-   * Can also be used to unset a tag, by passing `undefined`.
-   *
-   * @param key Tag key
-   * @param value Tag value
-   * @deprecated Use `setAttribute()` instead.
-   */
-  setTag(key: string, value: Primitive): this;
-
   /**
    * Sets the data attribute on the current span
    * @param key Data key
diff --git a/packages/types/src/transaction.ts b/packages/types/src/transaction.ts
@@ -1,7 +1,7 @@
 import type { Context } from './context';
 import type { DynamicSamplingContext } from './envelope';
 import type { MeasurementUnit } from './measurement';
-import type { ExtractedNodeRequestData, Primitive, WorkerLocation } from './misc';
+import type { ExtractedNodeRequestData, WorkerLocation } from './misc';
 import type { PolymorphicRequest } from './polymorphics';
 import type { Span, SpanAttributes, SpanContext } from './span';
 
@@ -66,12 +66,6 @@ export interface Transaction extends Omit<TransactionContext, 'name' | 'op'>, Sp
    */
   startTimestamp: number;
 
-  /**
-   * Tags for the transaction.
-   * @deprecated Use `getSpanAttributes(transaction)` instead.
-   */
-  tags: { [key: string]: Primitive };
-
   /**
    * Data for the transaction.
    * @deprecated Use `getSpanAttributes(transaction)` instead.
