use _experiments

Author: chargome

packages/browser/src/client.ts

@@ -108,9 +108,9 @@ export class BrowserClient extends Client<BrowserClientOptions> {
 
     super(opts);
 
-    const { sendDefaultPii, sendClientReports, enableLogs, _enableTraceMetrics } = this._options;
+    const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
 
-    if (WINDOW.document && (sendClientReports || enableLogs || _enableTraceMetrics)) {
+    if (WINDOW.document && (sendClientReports || enableLogs || _experiments?.enableTraceMetrics)) {
       WINDOW.document.addEventListener('visibilitychange', () => {
         if (WINDOW.document.visibilityState === 'hidden') {
           if (sendClientReports) {
@@ -119,7 +119,7 @@ export class BrowserClient extends Client<BrowserClientOptions> {
           if (enableLogs) {
             _INTERNAL_flushLogsBuffer(this);
           }
-          if (_enableTraceMetrics) {
+          if (_experiments?.enableTraceMetrics) {
             _INTERNAL_flushMetricsBuffer(this);
           }
         }
@@ -142,7 +142,7 @@ export class BrowserClient extends Client<BrowserClientOptions> {
       });
     }
 
-    if (_enableTraceMetrics) {
+    if (_experiments?.enableTraceMetrics) {
       this.on('flush', () => {
         _INTERNAL_flushMetricsBuffer(this);
       });

packages/core/src/metrics/internal.ts

@@ -133,8 +133,8 @@ export function _INTERNAL_captureMetric(beforeMetric: Metric, options?: Internal
     return;
   }
 
-  const { release, environment, _enableTraceMetrics = false, beforeSendMetric } = client.getOptions();
-  if (!_enableTraceMetrics) {
+  const { release, environment, _experiments } = client.getOptions();
+  if (!_experiments?.enableTraceMetrics) {
     DEBUG_BUILD && debug.warn('trace metrics option not enabled, metric will not be captured.');
     return;
   }
@@ -168,7 +168,7 @@ export function _INTERNAL_captureMetric(beforeMetric: Metric, options?: Internal
   };
 
   // Run beforeSendMetric callback
-  const processedMetric = beforeSendMetric ? beforeSendMetric(metric) : metric;
+  const processedMetric = _experiments?.beforeSendMetric ? _experiments.beforeSendMetric(metric) : metric;
 
   if (!processedMetric) {
     DEBUG_BUILD && debug.log('An event processor returned `null`, will not send metric.');

packages/core/src/metrics/public-api.ts

@@ -38,7 +38,7 @@ function captureMetric(type: MetricType, name: string, value: number | string, o
 }
 
 /**
- * @summary Increment a counter metric. Requires the `_enableTraceMetrics` option to be enabled.
+ * @summary Increment a counter metric. Requires the `_experiments.enableTraceMetrics` option to be enabled.
  *
  * @param name - The name of the counter metric.
  * @param value - The value to increment by (defaults to 1).
@@ -72,7 +72,7 @@ export function count(name: string, value: number = 1, options?: MetricOptions):
 }
 
 /**
- * @summary Set a gauge metric to a specific value. Requires the `_enableTraceMetrics` option to be enabled.
+ * @summary Set a gauge metric to a specific value. Requires the `_experiments.enableTraceMetrics` option to be enabled.
  *
  * @param name - The name of the gauge metric.
  * @param value - The current value of the gauge.
@@ -106,7 +106,7 @@ export function gauge(name: string, value: number, options?: MetricOptions): voi
 }
 
 /**
- * @summary Record a value in a distribution metric. Requires the `_enableTraceMetrics` option to be enabled.
+ * @summary Record a value in a distribution metric. Requires the `_experiments.enableTraceMetrics` option to be enabled.
  *
  * @param name - The name of the distribution metric.
  * @param value - The value to record in the distribution.

packages/core/src/server-runtime-client.ts

@@ -84,7 +84,7 @@ export class ServerRuntimeClient<
       });
     }
 
-    if (this._options._enableTraceMetrics) {
+    if (this._options._experiments?.enableTraceMetrics) {
       // eslint-disable-next-line @typescript-eslint/no-this-alias
       const client = this;
 

packages/core/src/types-hoist/options.ts

@@ -283,6 +283,29 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
   _experiments?: {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     [key: string]: any;
+
+    /**
+     * If trace metrics support should be enabled.
+     *
+     * @default false
+     * @experimental
+     */
+    enableTraceMetrics?: boolean;
+
+    /**
+     * An event-processing callback for metrics, guaranteed to be invoked after all other metric
+     * processors. This allows a metric to be modified or dropped before it's sent.
+     *
+     * Note that you must return a valid metric from this callback. If you do not wish to modify the metric, simply return
+     * it at the end. Returning `null` will cause the metric to be dropped.
+     *
+     * @default undefined
+     * @experimental
+     *
+     * @param metric The metric generated by the SDK.
+     * @returns A new metric that will be sent | null.
+     */
+    beforeSendMetric?: (metric: Metric) => Metric | null;
   };
 
   /**
@@ -380,29 +403,6 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
    */
   beforeSendLog?: (log: Log) => Log | null;
 
-  /**
-   * If trace metrics support should be enabled.
-   *
-   * @default false
-   * @experimental
-   */
-  _enableTraceMetrics?: boolean;
-
-  /**
-   * An event-processing callback for metrics, guaranteed to be invoked after all other metric
-   * processors. This allows a metric to be modified or dropped before it's sent.
-   *
-   * Note that you must return a valid metric from this callback. If you do not wish to modify the metric, simply return
-   * it at the end. Returning `null` will cause the metric to be dropped.
-   *
-   * @default undefined
-   * @experimental
-   *
-   * @param metric The metric generated by the SDK.
-   * @returns A new metric that will be sent | null.
-   */
-  beforeSendMetric?: (metric: Metric) => Metric | null;
-
   /**
    * Function to compute tracing sample rate dynamically and filter unwanted traces.
    *