feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 4 commits into from
Nov 4, 2024
Merged

feat: Deprecate metrics API #14157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f99bdf
feat: Deprecate metrics API
AbhiPrasad Oct 31, 2024
c7207e8
Merge branch 'develop' into abhi-deprecate-metrics
AbhiPrasad Nov 4, 2024
0fb1203
fix missing eslint disables
AbhiPrasad Nov 4, 2024
cbb02a1
forgot about sveltekit
AbhiPrasad Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down
1 change: 1 addition & 0 deletions packages/astro/src/index.server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
localVariablesIntegration,
lruMemoizerIntegration,
makeNodeTransport,
// eslint-disable-next-line deprecation/deprecation
metrics,
modulesIntegration,
mongoIntegration,
Expand Down
1 change: 1 addition & 0 deletions packages/astro/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
1 change: 1 addition & 0 deletions packages/aws-serverless/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
continueTrace,
getAutoPerformanceIntegrations,
cron,
// eslint-disable-next-line deprecation/deprecation
metrics,
parameterize,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down
20 changes: 15 additions & 5 deletions packages/browser/src/metrics.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
continueTrace,
getAutoPerformanceIntegrations,
cron,
// eslint-disable-next-line deprecation/deprecation
metrics,
parameterize,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down
1 change: 1 addition & 0 deletions packages/cloudflare/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
withActiveSpan,
getSpanDescendants,
continueTrace,
// eslint-disable-next-line deprecation/deprecation
metrics,
functionToStringIntegration,
inboundFiltersIntegration,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/metrics/aggregator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down
21 changes: 16 additions & 5 deletions packages/core/src/metrics/exports-default.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down
17 changes: 12 additions & 5 deletions packages/core/src/metrics/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
},
Expand All@@ -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);
Expand All@@ -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,
Expand Down
1 change: 1 addition & 0 deletions packages/core/test/lib/metrics/timing.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down
1 change: 1 addition & 0 deletions packages/deno/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
startSpanManual,
startNewTrace,
suppressTracing,
// eslint-disable-next-line deprecation/deprecation
metricsDefault as metrics,
inboundFiltersIntegration,
linkedErrorsIntegration,
Expand Down
1 change: 0 additions & 1 deletion packages/deno/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
dedupeIntegration,
Expand Down
1 change: 1 addition & 0 deletions packages/google-cloud-serverless/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
continueTrace,
getAutoPerformanceIntegrations,
cron,
// eslint-disable-next-line deprecation/deprecation
metrics,
parameterize,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down
1 change: 1 addition & 0 deletions packages/nextjs/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down
1 change: 1 addition & 0 deletions packages/node/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
extraErrorDataIntegration,
rewriteFramesIntegration,
sessionTimingIntegration,
// eslint-disable-next-line deprecation/deprecation
metricsDefault as metrics,
startSession,
captureSession,
Expand Down
1 change: 1 addition & 0 deletions packages/nuxt/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
1 change: 1 addition & 0 deletions packages/remix/src/index.server.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
linkedErrorsIntegration,
localVariablesIntegration,
makeNodeTransport,
// eslint-disable-next-line deprecation/deprecation
metrics,
modulesIntegration,
mongoIntegration,
Expand Down
1 change: 1 addition & 0 deletions packages/remix/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
1 change: 1 addition & 0 deletions packages/solidstart/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;
1 change: 1 addition & 0 deletions packages/solidstart/src/server/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
linkedErrorsIntegration,
localVariablesIntegration,
makeNodeTransport,
// eslint-disable-next-line deprecation/deprecation
metrics,
modulesIntegration,
mongoIntegration,
Expand Down
1 change: 1 addition & 0 deletions packages/sveltekit/src/index.types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;
1 change: 1 addition & 0 deletions packages/sveltekit/src/server/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
linkedErrorsIntegration,
localVariablesIntegration,
makeNodeTransport,
// eslint-disable-next-line deprecation/deprecation
metrics,
modulesIntegration,
mongoIntegration,
Expand Down
1 change: 1 addition & 0 deletions packages/vercel-edge/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
withActiveSpan,
getSpanDescendants,
continueTrace,
// eslint-disable-next-line deprecation/deprecation
metrics,
functionToStringIntegration,
inboundFiltersIntegration,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: Deprecate metrics API#14157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Nov 4, 2024
 Merged


feat: Deprecate metrics API
#14157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2f99bdf

feat: Deprecate metrics API


AbhiPrasad Oct 31, 2024
c7207e8

Merge branch 'develop' into abhi-deprecate-metrics


AbhiPrasad Nov 4, 2024
0fb1203

fix missing eslint disables


AbhiPrasad Nov 4, 2024
cbb02a1

forgot about sveltekit


AbhiPrasad Nov 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 0 additions & 14 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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',
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 localVariablesIntegration,
 lruMemoizerIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/astro/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/aws-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

20 changes: 15 additions & 5 deletions
packages/browser/src/metrics.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,6 +94,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/metrics/aggregator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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) {
Expand Down

21 changes: 16 additions & 5 deletions
packages/core/src/metrics/exports-default.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
}

Expand All@@ -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;
Expand All@@ -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;
} = {
Expand Down

17 changes: 12 additions & 5 deletions
packages/core/src/metrics/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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);
Expand All@@ -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);
Expand All@@ -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,
Expand DownExpand Up@@ -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);
 },
Expand All@@ -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);
Expand All@@ -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,
Expand Down

1 change: 1 addition & 0 deletions
packages/core/test/lib/metrics/timing.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/deno/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,7 @@ export {
 startSpanManual,
 startNewTrace,
 suppressTracing,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand Down

1 change: 0 additions & 1 deletion
packages/deno/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/consistent-type-imports */
import type { ServerRuntimeClientOptions } from '@sentry/core';
import {
 dedupeIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/google-cloud-serverless/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 continueTrace,
 getAutoPerformanceIntegrations,
 cron,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 parameterize,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
Expand Down

1 change: 1 addition & 0 deletions
packages/nextjs/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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';
Expand Down

1 change: 1 addition & 0 deletions
packages/node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,6 +116,7 @@ export {
 extraErrorDataIntegration,
 rewriteFramesIntegration,
 sessionTimingIntegration,
 // eslint-disable-next-line deprecation/deprecation
 metricsDefault as metrics,
 startSession,
 captureSession,
Expand Down

1 change: 1 addition & 0 deletions
packages/nuxt/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/remix/src/index.server.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/remix/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

1 change: 1 addition & 0 deletions
packages/solidstart/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/sveltekit/src/index.types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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>;

1 change: 1 addition & 0 deletions
packages/sveltekit/src/server/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,6 +67,7 @@ export {
 linkedErrorsIntegration,
 localVariablesIntegration,
 makeNodeTransport,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 modulesIntegration,
 mongoIntegration,
Expand Down

1 change: 1 addition & 0 deletions
packages/vercel-edge/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,7 @@ export {
 withActiveSpan,
 getSpanDescendants,
 continueTrace,
 // eslint-disable-next-line deprecation/deprecation
 metrics,
 functionToStringIntegration,
 inboundFiltersIntegration,
Expand Down