Set Up Metrics for ElixirNEW

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.

Once in Sentry, these metrics can be viewed alongside relevant errors, and searched using their individual attributes.

Requirements

Metrics for Elixir are supported in Sentry Elixir SDK version 13.0.0 and above.

Add sentry to your mix.exs dependencies:

defp deps do
  [
    {:sentry, "~> 13.0"}
  ]
end

defp deps do
  [
    {:sentry, "~> 13.0"}
  ]
end

Usage

Metrics are enabled by default. Once you initialize the SDK, you can send metrics using the Sentry.Metrics module.

The module exposes three functions that you can use to capture different types of metric information: count, gauge, and distribution.

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:

# Record five total button clicks
Sentry.Metrics.count(
  "button_click",
  5,
  attributes: %{browser: "Firefox", app_version: "1.0.0"}
)

# Record five total button clicks
Sentry.Metrics.count(
  "button_click",
  5,
  attributes: %{browser: "Firefox", app_version: "1.0.0"}
)

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:

# Add '15.0' to a distribution used for tracking the loading times per page.
Sentry.Metrics.distribution(
  "page_load",
  15.0,
  unit: "millisecond",
  attributes: %{page: "/home"}
)

# Add '15.0' to a distribution used for tracking the loading times per page.
Sentry.Metrics.distribution(
  "page_load",
  15.0,
  unit: "millisecond",
  attributes: %{page: "/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:

# Add '15.0' to a gauge used for tracking the loading times for a page.
Sentry.Metrics.gauge(
  "page_load",
  15.0,
  unit: "millisecond",
  attributes: %{page: "/home"}
)

# Add '15.0' to a gauge used for tracking the loading times for a page.
Sentry.Metrics.gauge(
  "page_load",
  15.0,
  unit: "millisecond",
  attributes: %{page: "/home"}
)

Options

enable_metrics

You can disable metrics collection globally by setting enable_metrics to false. When disabled, calls to Sentry.Metrics functions will be no-ops. Metrics are enabled by default.

config :sentry, enable_metrics: false

config :sentry, enable_metrics: false

before_send_metric

To filter metrics, or update them before they are sent to Sentry, you can use the before_send_metric option. If the callback returns nil, the metric is not emitted. Attributes can also be updated in the callback function.

config :sentry,
  before_send_metric: fn metric ->
    # filter metric
    if metric.name == "removed-metric" do
      nil
    else
      # add attributes
      attributes = Map.put(metric.attributes, "extra", "foo")

      # remove attributes
      attributes = Map.delete(attributes, "browser")

      %{metric | attributes: attributes}
    end
  end

config :sentry,
  before_send_metric: fn metric ->
    # filter metric
    if metric.name == "removed-metric" do
      nil
    else
      # add attributes
      attributes = Map.put(metric.attributes, "extra", "foo")

      # remove attributes
      attributes = Map.delete(attributes, "browser")

      %{metric | attributes: attributes}
    end
  end

You can also pass a {module, function} tuple:

config :sentry,
  before_send_metric: {MyApp.SentryFilters, :filter_metric}

config :sentry,
  before_send_metric: {MyApp.SentryFilters, :filter_metric}

The before_send_metric callback receives a Sentry.Metric struct, and should return a Sentry.Metric struct if you want it to be sent to Sentry, or nil if you want to discard it.

The Sentry.Metric struct has the following fields:

• name: (String.t()) The name of the metric.
• type: (:counter | :gauge | :distribution) The type of metric.
• value: (number()) The numeric value of the metric.
• unit: (String.t() | nil) The unit of measurement for the metric value.
• attributes: (map()) Additional attributes to be sent with the metric.
• timestamp: (float()) Timestamp in seconds indicating when the metric was recorded.
• trace_id: (String.t() | nil) The trace ID of the trace this metric belongs to.
• span_id: (String.t() | nil) The span ID of the span that was active when the metric was emitted.

Default Attributes

The Elixir SDK automatically sets several default attributes on all metrics to provide context and improve debugging:

Core Attributes

• environment: The environment set in the SDK if defined. This is sent from the SDK as sentry.environment.
• release: The release set in the SDK if defined. This is sent from the SDK as sentry.release.
• sdk.name: The name of the SDK that sent the metric. This is sent from the SDK as sentry.sdk.name.
• sdk.version: The version of the SDK that sent the metric. This is sent from the SDK as sentry.sdk.version.

Server Attributes

• server.address: The address of the server that sent the metric. Equivalent to server_name that gets attached to Sentry errors.