View Source Sentry.ClientReport (Sentry v10.8.0)

This module represents the data structure for a client report.

Client reports are used to provide insights into which events are being dropped (that is, not sent to Sentry) and for what reason.

This module is responsible for recording, storing, and periodically sending these client reports to Sentry. You can choose to turn off these reports by configuring the :send_client_reports option.

Refer to https://develop.sentry.dev/sdk/client-reports/ for more details.

Available since v10.8.0.

Summary

Types

reason()

The possible reasons of the discarded event.

t()

The struct for a client report.

Types

reason()

(since 10.8.0)

@type reason() ::
  :internal_sdk_error
  | :send_error
  | :backpressure
  | :insufficient_data
  | :event_processor
  | :before_send
  | :sample_rate
  | :network_error
  | :cache_overflow
  | :queue_overflow
  | :ratelimit_backoff

The possible reasons of the discarded event.

t()

(since 10.8.0)

@type t() :: %Sentry.ClientReport{
  discarded_events: [
    %{reason: reason(), category: String.t(), quantity: pos_integer()}
  ],
  timestamp: String.t() | number()
}

The struct for a client report.