ref(tracing): Make metadata property on Transaction class public (#3557)

Author: lobsterkatie

packages/tracing/src/transaction.ts

@@ -1,18 +1,20 @@
 import { getCurrentHub, Hub } from '@sentry/hub';
-import { Event, Measurements, Transaction as TransactionInterface, TransactionContext } from '@sentry/types';
+import {
+  Event,
+  Measurements,
+  Transaction as TransactionInterface,
+  TransactionContext,
+  TransactionMetadata,
+} from '@sentry/types';
 import { dropUndefinedKeys, isInstanceOf, logger } from '@sentry/utils';
 
 import { Span as SpanClass, SpanRecorder } from './span';
 
-interface TransactionMetadata {
-  transactionSampling?: { [key: string]: string | number };
-}
-
 /** JSDoc */
 export class Transaction extends SpanClass implements TransactionInterface {
   public name: string;
 
-  private _metadata: TransactionMetadata = {};
+  public metadata: TransactionMetadata;
 
   private _measurements: Measurements = {};
 
@@ -39,6 +41,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
 
     this.name = transactionContext.name || '';
 
+    this.metadata = transactionContext.metadata || {};
     this._trimEnd = transactionContext.trimEnd;
 
     // this is because transactions are also spans, and spans have a transaction pointer
@@ -76,7 +79,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
    * @hidden
    */
   public setMetadata(newMetadata: TransactionMetadata): void {
-    this._metadata = { ...this._metadata, ...newMetadata };
+    this.metadata = { ...this.metadata, ...newMetadata };
   }
 
   /**
@@ -123,7 +126,7 @@ export class Transaction extends SpanClass implements TransactionInterface {
       timestamp: this.endTimestamp,
       transaction: this.name,
       type: 'transaction',
-      debug_meta: this._metadata,
+      debug_meta: this.metadata,
     };
 
     const hasMeasurements = Object.keys(this._measurements).length > 0;

packages/types/src/index.ts

@@ -43,6 +43,7 @@ export {
   TraceparentData,
   Transaction,
   TransactionContext,
+  TransactionMetadata,
   TransactionSamplingMethod,
 } from './transaction';
 export { Thread } from './thread';

packages/types/src/transaction.ts

@@ -22,6 +22,11 @@ export interface TransactionContext extends SpanContext {
    * If this transaction has a parent, the parent's sampling decision
    */
   parentSampled?: boolean;
+
+  /**
+   * Metadata associated with the transaction, for internal SDK use.
+   */
+  metadata?: TransactionMetadata;
 }
 
 /**
@@ -58,6 +63,11 @@ export interface Transaction extends TransactionContext, Span {
    */
   data: { [key: string]: any };
 
+  /**
+   * Metadata about the transaction
+   */
+  metadata: TransactionMetadata;
+
   /**
    * Set the name of the transaction
    */
@@ -113,3 +123,13 @@ export enum TransactionSamplingMethod {
   Rate = 'client_rate',
   Inheritance = 'inheritance',
 }
+
+export interface TransactionMetadata {
+  transactionSampling?: { rate?: number; method?: string };
+
+  /** The two halves (sentry and third-party) of a transaction's tracestate header, used for dynamic sampling */
+  tracestate?: {
+    sentry?: string;
+    thirdparty?: string;
+  };
+}