Set Up Metrics

With Sentry's Application Metrics, you can send counters, gauges, and distributions from your Rust applications to Sentry. Once in Sentry, these metrics can be viewed alongside relevant errors and searched using their individual attributes.

Requirements

Metrics for Rust are supported in Sentry Rust SDK version 0.48.0 or later when compiled with the metrics feature.

[dependencies]
sentry = { version = "0.48.2", features = ["metrics"] }

[dependencies]
sentry = { version = "0.48.2", features = ["metrics"] }

Metrics are enabled by default.

Usage

The SDK's sentry::metrics module contains functions for capturing each of the three metric types that Sentry supports.

Metrics are automatically associated with the trace and, if applicable, the span they are captured within.

Capture a Counter

Capture counter metrics using metrics::counter.

Counters track occurrences, such as handled HTTP requests, and are always unitless.

use sentry::metrics;

metrics::counter("http.requests", 1).capture();

use sentry::metrics;

metrics::counter("http.requests", 1).capture();

Capture a Gauge

Capture gauge metrics using metrics::gauge.

Gauges track current state or level, such as queue depth or active connections, and support units.

use sentry::metrics;

metrics::gauge("queue.depth", 42).capture();

use sentry::metrics;

metrics::gauge("queue.depth", 42).capture();

Distribution

Capture distribution metrics using metrics::distribution.

Distributions track values that vary and need statistical analysis, such as response times or payload sizes, and they support units.

use sentry::metrics;
use sentry::protocol::Unit;

metrics::distribution("http.response_time", 187.5)
  .unit(Unit::Millisecond)
  .capture();

use sentry::metrics;
use sentry::protocol::Unit;

metrics::distribution("http.response_time", 187.5)
  .unit(Unit::Millisecond)
  .capture();

Setting Attributes

Attributes let you filter and group metrics in Sentry. Add them with .attribute(key, value) before you call .capture(). You can add multiple attributes by chaining calls to .attribute.

When possible, use Sentry Semantic Conventions for attribute keys.

Options

Filtering Metrics

Use before_send_metric to drop or update metrics before Sentry sends them. Return None to drop a metric.

For example, to filter all metrics with the name "debug.metric", you could use the following before_send_metric:

let _guard = sentry::init((
    "___PUBLIC_DSN___",
    sentry::ClientOptions {
        before_send_metric: Some(std::sync::Arc::new(|metric| {
            if metric.name == "debug.metric" {
                return None;
            }

            Some(metric)
        })),
        ..Default::default()
    },
));

let _guard = sentry::init((
    "___PUBLIC_DSN___",
    sentry::ClientOptions {
        before_send_metric: Some(std::sync::Arc::new(|metric| {
            if metric.name == "debug.metric" {
                return None;
            }

            Some(metric)
        })),
        ..Default::default()
    },
));

Disabling Metrics

Metrics are enabled by default when the sentry crate is compiled with the metrics feature. To stop sending metrics, set enable_metrics: false in the ClientOptions.

let _guard = sentry::init((
    "___PUBLIC_DSN___",
    sentry::ClientOptions {
        enable_metrics: false,
        ..Default::default()
    },
));

let _guard = sentry::init((
    "___PUBLIC_DSN___",
    sentry::ClientOptions {
        enable_metrics: false,
        ..Default::default()
    },
));

Default Attributes

Sentry automatically attaches these attributes to every metric: