ref: Deprecate enableTracing (getsentry#12897)

Luca Forstner · web-flow · commit 616915b7aeee · 2024-07-15T10:38:52.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,15 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+### Important Changes
+
+- **ref: Deprecate `enableTracing` (12897)**
+
+The `enableTracing` option has been deprecated and will be removed in the next major version. We recommend removing it
+in favor of the `tracesSampleRate` and `tracesSampler` options. If you want to enable performance monitoring, please set
+the `tracesSampleRate` to a sample rate of your choice, or provide a sampling function as `tracesSampler` option
+instead. If you wan't to disable performance monitoring, remove the `tracesSampler` and `tracesSampleRate` options.
+
 Work in this release was contributed by @GitSquared. Thank you for your contribution!
 
 ## 8.17.0
diff --git a/packages/core/src/utils/hasTracingEnabled.ts b/packages/core/src/utils/hasTracingEnabled.ts
@@ -17,6 +17,7 @@ export function hasTracingEnabled(
   }
 
   const options = maybeOptions || getClientOptions();
+  // eslint-disable-next-line deprecation/deprecation
   return !!options && (options.enableTracing || 'tracesSampleRate' in options || 'tracesSampler' in options);
 }
 
diff --git a/packages/node/src/sdk/index.ts b/packages/node/src/sdk/index.ts
@@ -92,6 +92,7 @@ function shouldAddPerformanceIntegrations(options: Options): boolean {
   }
 
   // We want to ensure `tracesSampleRate` is not just undefined/null here
+  // eslint-disable-next-line deprecation/deprecation
   return options.enableTracing || options.tracesSampleRate != null || 'tracesSampler' in options;
 }
 
diff --git a/packages/types/src/options.ts b/packages/types/src/options.ts
@@ -89,9 +89,13 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
   tracesSampleRate?: number;
 
   /**
-   * If this is enabled, transactions and trace data will be generated and captured.
+   * If this is enabled, spans and trace data will be generated and captured.
    * This will set the `tracesSampleRate` to the recommended default of `1.0` if `tracesSampleRate` is undefined.
    * Note that `tracesSampleRate` and `tracesSampler` take precedence over this option.
+   *
+   * @deprecated This option is deprecated and will be removed in the next major version. If you want to enable performance
+   * monitoring, please use the `tracesSampleRate` or `tracesSampler` options instead. If you wan't to disable performance
+   * monitoring, remove the `tracesSampler` and `tracesSampleRate` options.
    */
   enableTracing?: boolean;
 

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ export function hasTracingEnabled(`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`const options = maybeOptions \|\| getClientOptions();`
	`20`	`+ // eslint-disable-next-line deprecation/deprecation`
`20`	`21`	`return !!options && (options.enableTracing \|\| 'tracesSampleRate' in options \|\| 'tracesSampler' in options);`
`21`	`22`	`}`
`22`	`23`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,7 @@ function shouldAddPerformanceIntegrations(options: Options): boolean {`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	// We want to ensure `tracesSampleRate` is not just undefined/null here
	`95`	`+ // eslint-disable-next-line deprecation/deprecation`
`95`	`96`	`return options.enableTracing \|\| options.tracesSampleRate != null \|\| 'tracesSampler' in options;`
`96`	`97`	`}`
`97`	`98`