feat(metrics): Add timings method to metrics

Author: mydea

.size-limit.js

@@ -57,6 +57,20 @@ module.exports = [
     gzip: true,
     limit: '87 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: '40 KB',
+  },
   {
     name: '@sentry/browser (incl. Feedback)',
     path: 'packages/browser/build/npm/esm/index.js',

packages/core/src/metrics/exports.ts

@@ -1,12 +1,15 @@
 import type {
   Client,
+  DurationUnit,
   MeasurementUnit,
   MetricsAggregator as MetricsAggregatorInterface,
   Primitive,
 } from '@sentry/types';
-import { getGlobalSingleton, logger } from '@sentry/utils';
+import { getGlobalSingleton, logger, timestampInSeconds } from '@sentry/utils';
 import { getClient } from '../currentScopes';
 import { DEBUG_BUILD } from '../debug-build';
+import { startInactiveSpan } from '../tracing';
+import { handleCallbackErrors } from '../utils/handleCallbackErrors';
 import { getActiveSpan, getRootSpan, spanToJSON } from '../utils/spanUtils';
 import { COUNTER_METRIC_TYPE, DISTRIBUTION_METRIC_TYPE, GAUGE_METRIC_TYPE, SET_METRIC_TYPE } from './constants';
 import type { MetricType } from './types';
@@ -102,6 +105,50 @@ function distribution(aggregator: MetricsAggregatorConstructor, name: string, va
   addToMetricsAggregator(aggregator, DISTRIBUTION_METRIC_TYPE, name, ensureNumber(value), data);
 }
 
+function timing(
+  aggregator: MetricsAggregatorConstructor,
+  name: string,
+  value: number,
+  unit?: DurationUnit,
+  data?: Omit<MetricData, 'unit'>,
+): void;
+function timing<T>(
+  aggregator: MetricsAggregatorConstructor,
+  name: string,
+  value: () => T,
+  unit?: DurationUnit,
+  data?: Omit<MetricData, 'unit'>,
+): T;
+function timing<T = void>(
+  aggregator: MetricsAggregatorConstructor,
+  name: string,
+  value: number | (() => T),
+  unit: DurationUnit = 'second',
+  data?: Omit<MetricData, 'unit'>,
+): T | void {
+  // callback form
+  if (typeof value === 'function') {
+    const startTime = timestampInSeconds();
+    const span = startInactiveSpan({ op: 'metrics.timing', name, startTime });
+
+    return handleCallbackErrors(
+      () => value(),
+      () => {
+        // no special error handling necessary
+      },
+      () => {
+        const endTime = timestampInSeconds();
+        const timeDiff = endTime - startTime;
+        distribution(aggregator, name, timeDiff, { ...data, unit });
+        span.end(endTime);
+      },
+    );
+  }
+
+  // value form
+  distribution(aggregator, name, value, { ...data, unit });
+}
+
 /**
  * Adds a value to a set metric. Value must be a string or integer.
  *
@@ -125,6 +172,7 @@ export const metrics = {
   distribution,
   set,
   gauge,
+  timing,
   /**
    * @ignore This is for internal use only.
    */