The struct representing the event.

You're not advised to manipulate this struct's fields directly. Instead, use functions such as create_event/1 or transform_exception/2 for creating events.

See the t/0 type for information on the fields and their types.

@spec create_event([option]) :: t()
when option:
       {:user, Sentry.Interfaces.user()}
       | {:request, map()}
       | {:extra, Sentry.Context.extra()}
       | {:breadcrumbs, Sentry.Context.breadcrumb()}
       | {:tags, Sentry.Context.tags()}
       | {:level, level()}
       | {:fingerprint, [String.t()]}
       | {:message, String.t()}
       | {:event_source, atom()}
       | {:exception, Exception.t()}
       | {:stacktrace, Exception.stacktrace()}

Creates an event struct out of collected context and options.

Merging Options with Context and Config

Some of the options documented below are merged with the Sentry context, or with the Sentry context and the configuration. The option you pass here always has higher precedence, followed by the context and finally by the configuration.

See also Sentry.Context for information on the Sentry context and Sentry for information on configuration.

options

Options

• :exception - an Exception.t/0. This is the exception that gets reported in the :exception field of t/0. The term passed here also ends up unchanged in the :original_exception field of t/0. This option is required unless the :message option is present. This is not present by default.

• :stacktrace - a stacktrace, as in Exception.stacktrace/0. This is not present by default.

• :message - a message (String.t/0). This is not present by default.

• :extra - map of extra context, which gets merged with the current context (see Sentry.Context.set_extra_context/1). If fields collide, the ones in the map passed through this option have precedence over the ones in the context. Defaults to %{}.

• :user - map of user context, which gets merged with the current context (see Sentry.Context.set_user_context/1). If fields collide, the ones in the map passed through this option have precedence over the ones in the context. Defaults to %{}.

• :tags - map of tags context, which gets merged with the current context (see Sentry.Context.set_tags_context/1) and with the :tags option in the global Sentry configuration. If fields collide, the ones in the map passed through this option have precedence over the ones in the context, which have precedence over the ones in the configuration. Defaults to %{}.

• :request - map of request context, which gets merged with the current context (see Sentry.Context.set_request_context/1). If fields collide, the ones in the map passed through this option have precedence over the ones in the context. Defaults to %{}.

• :breadcrumbs - list of breadcrumbs. This list gets prepended to the list in the context (see Sentry.Context.add_breadcrumb/1). Defaults to [].

• :level - error level (see t/0). Defaults to :error.

• :fingerprint - list of the fingerprint for grouping this event (a list of String.t/0). Defaults to ["{{ default }}"].

• :event_source - the source of the event. This fills in the :source field of the returned struct. This is not present by default.

examples

Examples

iex> event = create_event(exception: %RuntimeError{message: "oops"}, level: :warning)
iex> event.level
:warning
iex> hd(event.exception).type
"RuntimeError"
iex> event.original_exception
%RuntimeError{message: "oops"}

iex> event = create_event(message: "Unknown route", event_source: :plug)
iex> event.source
:plug

@spec transform_exception(
  Exception.t(),
  keyword()
) :: t()

Transforms an exception to a Sentry event.

This essentially defers to create_event/1, inferring some options from the given exception.

options

Options

This function takes the same options as create_event/1.