Public API for recording metrics and sending them to Sentry.

Metrics follow the Sentry Metrics Protocol as defined in: https://develop.sentry.dev/sdk/telemetry/metrics/

Metric Types

The SDK supports three metric types:

• Counter - Tracks a value that always increments
• Gauge - Tracks a value that can go up or down
• Distribution - Tracks a distribution of values for statistical aggregation

Usage

# Record a counter
Sentry.Metrics.count("button.clicks", 1)
Sentry.Metrics.count("button.clicks", 5, unit: "click", attributes: %{button_id: "submit"})

# Record a gauge
Sentry.Metrics.gauge("memory.usage", 1024, unit: "megabyte")

# Record a distribution
Sentry.Metrics.distribution("response.time", 42.5, unit: "millisecond")

Configuration

Metrics can be disabled globally via configuration:

config :sentry, enable_metrics: false

You can also filter metrics using the :before_send_metric callback:

config :sentry,
  before_send_metric: fn metric ->
    # Drop metrics from test environments
    if metric.attributes["sentry.environment"] == "test", do: nil, else: metric
  end