Sentry Developer Metrics for Electron

[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/guides/electron/metrics/

Sentry now has alpha support for Sentry developer metrics for the Sentry Electron SDK. Via the newly introduced APIs, you can now flush 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 4.17.0.

To enable capturing metrics, you first need to add the metricsAggregator experiment to your Sentry.init call in your main process

import * as Sentry from '@sentry/electron/main';

// main process init
Sentry.init({
  dsn: '__DSN__',
  _experiments: {
    metricsAggregator: true,
  },
});

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

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

// 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 on the browser, please see: #9938
For using metrics in server runtimes (Node, Deno, Bun, Vercel Edge, etc.) please see: #9973