Sentry Developer Metrics for the Browser

[AbhiPrasad]

Important

Below were docs from our initial alpha. We now have docs for this in our main docs site: https://docs.sentry.io/platforms/javascript/metrics/

Sentry now has alpha support for Sentry Developer Metrics in the Browser SDKs (@sentry/browser and related framework SDKs). Via the newly introduced APIs, you can now send metrics directly to Sentry.

To get enrolled into our Metrics alpha program, please sign up here. If you're using self-hosted Sentry, please reach out via discord for help to get set up!

To use metrics, you need a minimum SDK version of 7.94.0.

Then you need to add metricsAggregratorIntegration under the Sentry.metrics namespace.

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    Sentry.metrics.metricsAggregratorIntegration(),
  ],
});

Then you'll be able to add counters, sets, distributions, and gauges under the Sentry.metrics namespace.

import * as Sentry from '@sentry/browser';

// Add 4 to a counter named `hits`
Sentry.metrics.increment('hits', 4);

// Add 2 to gauge named `parallel_requests`, tagged with `type: "a"`
Sentry.metrics.gauge('parallel_requests', 2, { tags: { type: 'a' } });

// Add 4.6 to a distribution named `response_time` with unit seconds
Sentry.metrics.distribution('response_time', 4.6, { unit: 'seconds' });

// Add 2 to a set named `valuable.ids`
Sentry.metrics.set('valuable.ids', 2);

For using metrics in server runtimes (Node, Deno, Bun, Vercel Edge, etc.) please see: #9973