feat: Deprecate metrics API (#14157)

AbhiPrasad · web-flow · commit 0e474f64a42e · 2024-11-04T18:30:31.000Z
The metrics beta has ended, so we are deprecating the metrics API.

🫡
diff --git a/.size-limit.js b/.size-limit.js
@@ -88,20 +88,6 @@ module.exports = [
     gzip: true,
     limit: '95 KB',
   },
-  {
-    name: '@sentry/browser (incl. Tracing, Replay, Feedback, metrics)',
-    path: 'packages/browser/build/npm/esm/index.js',
-    import: createImport('init', 'browserTracingIntegration', 'replayIntegration', 'feedbackIntegration', 'metrics'),
-    gzip: true,
-    limit: '100 KB',
-  },
-  {
-    name: '@sentry/browser (incl. metrics)',
-    path: 'packages/browser/build/npm/esm/index.js',
-    import: createImport('init', 'metrics'),
-    gzip: true,
-    limit: '30 KB',
-  },
   {
     name: '@sentry/browser (incl. Feedback)',
     path: 'packages/browser/build/npm/esm/index.js',
diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts
@@ -74,6 +74,7 @@ export {
   localVariablesIntegration,
   lruMemoizerIntegration,
   makeNodeTransport,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   modulesIntegration,
   mongoIntegration,
diff --git a/packages/astro/src/index.types.ts b/packages/astro/src/index.types.ts
@@ -32,5 +32,6 @@ export declare const continueTrace: typeof clientSdk.continueTrace;
 
 export declare const Span: clientSdk.Span;
 
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk;
 export default sentryAstro;
diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -73,6 +73,7 @@ export {
   continueTrace,
   getAutoPerformanceIntegrations,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   parameterize,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
diff --git a/packages/browser/src/metrics.ts b/packages/browser/src/metrics.ts
@@ -4,36 +4,40 @@ import type { DurationUnit, MetricData, Metrics } from '@sentry/types';
 /**
  * Adds a value to a counter metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function increment(name: string, value: number = 1, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.increment(BrowserMetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a distribution metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function distribution(name: string, value: number, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.distribution(BrowserMetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a set metric. Value must be a string or integer.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function set(name: string, value: number | string, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.set(BrowserMetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a gauge metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function gauge(name: string, value: number, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.gauge(BrowserMetricsAggregator, name, value, data);
 }
 
@@ -44,7 +48,7 @@ function gauge(name: string, value: number, data?: MetricData): void {
  * You can either directly capture a numeric `value`, or wrap a callback function in `timing`.
  * In the latter case, the duration of the callback execution will be captured as a span & a metric.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function timing(name: string, value: number, unit?: DurationUnit, data?: Omit<MetricData, 'unit'>): void;
 function timing<T>(name: string, callback: () => T, unit?: DurationUnit, data?: Omit<MetricData, 'unit'>): T;
@@ -54,9 +58,15 @@ function timing<T = void>(
   unit: DurationUnit = 'second',
   data?: Omit<MetricData, 'unit'>,
 ): T | void {
+  // eslint-disable-next-line deprecation/deprecation
   return metricsCore.timing(BrowserMetricsAggregator, name, value, unit, data);
 }
 
+/**
+ * The metrics API is used to capture custom metrics in Sentry.
+ *
+ * @deprecated The Sentry metrics beta has ended. This export will be removed in a future release.
+ */
 export const metrics: Metrics = {
   increment,
   distribution,
diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -94,6 +94,7 @@ export {
   continueTrace,
   getAutoPerformanceIntegrations,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   parameterize,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
diff --git a/packages/cloudflare/src/index.ts b/packages/cloudflare/src/index.ts
@@ -65,6 +65,7 @@ export {
   withActiveSpan,
   getSpanDescendants,
   continueTrace,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   functionToStringIntegration,
   inboundFiltersIntegration,
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -99,9 +99,11 @@ export { rewriteFramesIntegration } from './integrations/rewriteframes';
 export { sessionTimingIntegration } from './integrations/sessiontiming';
 export { zodErrorsIntegration } from './integrations/zoderrors';
 export { thirdPartyErrorFilterIntegration } from './integrations/third-party-errors-filter';
+// eslint-disable-next-line deprecation/deprecation
 export { metrics } from './metrics/exports';
 export { profiler } from './profiling';
 export type { MetricData } from '@sentry/types';
+// eslint-disable-next-line deprecation/deprecation
 export { metricsDefault } from './metrics/exports-default';
 export { BrowserMetricsAggregator } from './metrics/browser-aggregator';
 export { getMetricSummaryJsonForSpan } from './metrics/metric-summary';
diff --git a/packages/core/src/metrics/aggregator.ts b/packages/core/src/metrics/aggregator.ts
@@ -40,6 +40,7 @@ export class MetricsAggregator implements MetricsAggregatorBase {
     this._buckets = new Map();
     this._bucketsTotalWeight = 0;
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this._interval = setInterval(() => this._flush(), DEFAULT_FLUSH_INTERVAL) as any;
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     if (this._interval.unref) {
diff --git a/packages/core/src/metrics/exports-default.ts b/packages/core/src/metrics/exports-default.ts
@@ -11,36 +11,40 @@ import { metrics as metricsCore } from './exports';
 /**
  * Adds a value to a counter metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function increment(name: string, value: number = 1, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.increment(MetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a distribution metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function distribution(name: string, value: number, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.distribution(MetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a set metric. Value must be a string or integer.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function set(name: string, value: number | string, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.set(MetricsAggregator, name, value, data);
 }
 
 /**
  * Adds a value to a gauge metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function gauge(name: string, value: number, data?: MetricData): void {
+  // eslint-disable-next-line deprecation/deprecation
   metricsCore.gauge(MetricsAggregator, name, value, data);
 }
 
@@ -51,7 +55,7 @@ function gauge(name: string, value: number, data?: MetricData): void {
  * You can either directly capture a numeric `value`, or wrap a callback function in `timing`.
  * In the latter case, the duration of the callback execution will be captured as a span & a metric.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function timing(name: string, value: number, unit?: DurationUnit, data?: Omit<MetricData, 'unit'>): void;
 function timing<T>(name: string, callback: () => T, unit?: DurationUnit, data?: Omit<MetricData, 'unit'>): T;
@@ -61,16 +65,23 @@ function timing<T = void>(
   unit: DurationUnit = 'second',
   data?: Omit<MetricData, 'unit'>,
 ): T | void {
+  // eslint-disable-next-line deprecation/deprecation
   return metricsCore.timing(MetricsAggregator, name, value, unit, data);
 }
 
 /**
  * Returns the metrics aggregator for a given client.
  */
 function getMetricsAggregatorForClient(client: Client): MetricsAggregatorInterface {
+  // eslint-disable-next-line deprecation/deprecation
   return metricsCore.getMetricsAggregatorForClient(client, MetricsAggregator);
 }
 
+/**
+ * The metrics API is used to capture custom metrics in Sentry.
+ *
+ * @deprecated The Sentry metrics beta has ended. This export will be removed in a future release.
+ */
 export const metricsDefault: Metrics & {
   getMetricsAggregatorForClient: typeof getMetricsAggregatorForClient;
 } = {
diff --git a/packages/core/src/metrics/exports.ts b/packages/core/src/metrics/exports.ts
@@ -78,7 +78,7 @@ function addToMetricsAggregator(
 /**
  * Adds a value to a counter metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function increment(aggregator: MetricsAggregatorConstructor, name: string, value: number = 1, data?: MetricData): void {
   addToMetricsAggregator(aggregator, COUNTER_METRIC_TYPE, name, ensureNumber(value), data);
@@ -87,7 +87,7 @@ function increment(aggregator: MetricsAggregatorConstructor, name: string, value
 /**
  * Adds a value to a distribution metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function distribution(aggregator: MetricsAggregatorConstructor, name: string, value: number, data?: MetricData): void {
   addToMetricsAggregator(aggregator, DISTRIBUTION_METRIC_TYPE, name, ensureNumber(value), data);
@@ -100,7 +100,7 @@ function distribution(aggregator: MetricsAggregatorConstructor, name: string, va
  * You can either directly capture a numeric `value`, or wrap a callback function in `timing`.
  * In the latter case, the duration of the callback execution will be captured as a span & a metric.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function timing<T = void>(
   aggregator: MetricsAggregatorConstructor,
@@ -129,6 +129,7 @@ function timing<T = void>(
           () => {
             const endTime = timestampInSeconds();
             const timeDiff = endTime - startTime;
+            // eslint-disable-next-line deprecation/deprecation
             distribution(aggregator, name, timeDiff, { ...data, unit: 'second' });
             span.end(endTime);
           },
@@ -138,13 +139,14 @@ function timing<T = void>(
   }
 
   // value form
+  // eslint-disable-next-line deprecation/deprecation
   distribution(aggregator, name, value, { ...data, unit });
 }
 
 /**
  * Adds a value to a set metric. Value must be a string or integer.
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function set(aggregator: MetricsAggregatorConstructor, name: string, value: number | string, data?: MetricData): void {
   addToMetricsAggregator(aggregator, SET_METRIC_TYPE, name, value, data);
@@ -153,12 +155,17 @@ function set(aggregator: MetricsAggregatorConstructor, name: string, value: numb
 /**
  * Adds a value to a gauge metric
  *
- * @experimental This API is experimental and might have breaking changes in the future.
+ * @deprecated The Sentry metrics beta has ended. This method will be removed in a future release.
  */
 function gauge(aggregator: MetricsAggregatorConstructor, name: string, value: number, data?: MetricData): void {
   addToMetricsAggregator(aggregator, GAUGE_METRIC_TYPE, name, ensureNumber(value), data);
 }
 
+/**
+ * The metrics API is used to capture custom metrics in Sentry.
+ *
+ * @deprecated The Sentry metrics beta has ended. This export will be removed in a future release.
+ */
 export const metrics = {
   increment,
   distribution,
diff --git a/packages/core/test/lib/metrics/timing.test.ts b/packages/core/test/lib/metrics/timing.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable deprecation/deprecation */
 import { getCurrentScope, getIsolationScope, setCurrentClient } from '../../../src';
 import { MetricsAggregator } from '../../../src/metrics/aggregator';
 import { metrics as metricsCore } from '../../../src/metrics/exports';
diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts
@@ -62,6 +62,7 @@ export {
   startSpanManual,
   startNewTrace,
   suppressTracing,
+  // eslint-disable-next-line deprecation/deprecation
   metricsDefault as metrics,
   inboundFiltersIntegration,
   linkedErrorsIntegration,
diff --git a/packages/deno/src/sdk.ts b/packages/deno/src/sdk.ts
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/consistent-type-imports */
 import type { ServerRuntimeClientOptions } from '@sentry/core';
 import {
   dedupeIntegration,
diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -74,6 +74,7 @@ export {
   continueTrace,
   getAutoPerformanceIntegrations,
   cron,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   parameterize,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
diff --git a/packages/nextjs/src/index.types.ts b/packages/nextjs/src/index.types.ts
@@ -36,6 +36,7 @@ export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
 export declare const showReportDialog: typeof clientSdk.showReportDialog;
 export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
 
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;
 
 export { withSentryConfig } from './config';
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -116,6 +116,7 @@ export {
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   sessionTimingIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   metricsDefault as metrics,
   startSession,
   captureSession,
diff --git a/packages/nuxt/src/index.types.ts b/packages/nuxt/src/index.types.ts
@@ -15,4 +15,5 @@ export declare const contextLinesIntegration: typeof clientSdk.contextLinesInteg
 export declare const getDefaultIntegrations: (options: Options) => Integration[];
 export declare const defaultStackParser: StackParser;
 export declare const continueTrace: typeof clientSdk.continueTrace;
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;
diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts
@@ -74,6 +74,7 @@ export {
   linkedErrorsIntegration,
   localVariablesIntegration,
   makeNodeTransport,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   modulesIntegration,
   mongoIntegration,
diff --git a/packages/remix/src/index.types.ts b/packages/remix/src/index.types.ts
@@ -39,4 +39,5 @@ export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
 export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;
 export const lastEventId = runtime === 'client' ? clientSdk.lastEventId : serverSdk.lastEventId;
 
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;
diff --git a/packages/solidstart/src/index.types.ts b/packages/solidstart/src/index.types.ts
@@ -27,4 +27,5 @@ export declare function lastEventId(): string | undefined;
 
 export declare const continueTrace: typeof clientSdk.continueTrace;
 
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;
diff --git a/packages/solidstart/src/server/index.ts b/packages/solidstart/src/server/index.ts
@@ -65,6 +65,7 @@ export {
   linkedErrorsIntegration,
   localVariablesIntegration,
   makeNodeTransport,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   modulesIntegration,
   mongoIntegration,
diff --git a/packages/sveltekit/src/index.types.ts b/packages/sveltekit/src/index.types.ts
@@ -52,6 +52,7 @@ export declare function lastEventId(): string | undefined;
 
 export declare const continueTrace: typeof clientSdk.continueTrace;
 
+// eslint-disable-next-line deprecation/deprecation
 export declare const metrics: typeof clientSdk.metrics & typeof serverSdk.metrics;
 
 export declare function trackComponent(options: clientSdk.TrackingOptions): ReturnType<typeof clientSdk.trackComponent>;
diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -67,6 +67,7 @@ export {
   linkedErrorsIntegration,
   localVariablesIntegration,
   makeNodeTransport,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   modulesIntegration,
   mongoIntegration,
diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/src/index.ts
@@ -65,6 +65,7 @@ export {
   withActiveSpan,
   getSpanDescendants,
   continueTrace,
+  // eslint-disable-next-line deprecation/deprecation
   metrics,
   functionToStringIntegration,
   inboundFiltersIntegration,
