index.mdx

title	sidebar_title	description	sidebar_order	sidebar_hidden
Set Up Metrics	Metrics	Learn how to measure the data points you care about by configuring Metrics in your Java app.	5500	true

Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster.

Requirements

Metrics are supported with Sentry Java SDK version 7.6.0 and above.

Configure

Here's how to add Metrics to your application:

import io.sentry.android.core.SentryAndroid;

Sentry.init(this, options -> {
  options.setEnableMetrics(true);
});

import io.sentry.android.core.SentryAndroid

Sentry.init(this) { options ->
  options.enableMetrics = true
}

sentry.enable-metrics=true

Emit a Counter

Counters are one of the more basic types of metrics and can be used to count certain event occurrences.

To emit a counter, do the following:

final Map<String, String> tags = new HashMap<>();
tags.put("provider", "e-mail");

Sentry.metrics().increment(
    "button_login_click", // key
    1.0,                  // value
    null,                 // unit
    tags                  // tags
);

Sentry.metrics()
    .increment(
        "button_login_click", // key
        1.0,                  // value
        null,                 // unit
        mapOf(                // tags
            "provider" to "e-mail"
        )
    )

Emit a Distribution

Distributions help you get the most insights from your data by allowing you to obtain aggregations such as p90, min, max, and avg.

To emit a distribution, do the following:

final Map<String, String> tags = new HashMap<>();
tags.put("type", "thumbnail");

Sentry.metrics().distribution(
    "image_download_duration",
    150.0,
    MeasurementUnit.Duration.MILLISECOND,
    tags);

Sentry.metrics().distribution(
    "image_download_duration",
    150.0,
    MeasurementUnit.Duration.MILLISECOND,
    mapOf(
        "type" to "thumbnail"
    )
)

Emit a Set

Sets are useful for looking at unique occurrences and counting the unique elements you added.

To emit a set, do the following:

// Add 'jane' to a set used for tracking the number of users that viewed a page.
final Map<String, String> tags = new HashMap<>();
tags.put("page", "home");

Sentry.metrics().set(
    "user_view",
    "jane",
    new MeasurementUnit.Custom("username"),
    tags);

Sentry.metrics().set(
    "user_view",
    "jane",
    MeasurementUnit.Custom("username"),
    mapOf(
        "page" to "home"
    )
)

Emit a Gauge

Gauges let you obtain aggregates like min, max, avg, sum, and count. They can be represented in a more space-efficient way than distributions, but they can't be used to get percentiles. If percentiles aren't important to you, we recommend using gauges.

To emit a gauge, do the following:

final Map<String, String> tags = new HashMap<>();
tags.put("page", "/home");

Sentry.metrics().gauge(
    "page_load",
    15.0,
    MeasurementUnit.Duration.MILLISECOND,
    tags);

Sentry.metrics().gauge(
    "page_load",
    15.0,
    MeasurementUnit.Duration.MILLISECOND,
    mapOf(
        "page" to "/home"
    )
)

Emit a Timer

Timers can be used to measure the execution time of a specific block of code. They're implemented like distributions, but measured in seconds.

To emit a timer, do the following:

Sentry.metrics().timing("load_user_profile", () -> {
    // db.load() ...
});

Sentry.metrics().timing("load_user_profile") {
    // db.load() ...
}