View Source Sentry.Interfaces (Sentry v10.6.2)

Top-level module for Sentry interfaces.

Interfaces are pieces of the event payload that include various kinds of information. See the event payloads documentation and its subsections.

The types in this module and the nested structs are taken from Sentry's JSONSchema definitions.

Link to this section Summary

Types

The generic context interface.

The user interface.

Link to this section Types

Link to this type

context()

View Source (since 9.0.0)
@type context() :: map()

The generic context interface.

See https://develop.sentry.dev/sdk/event-payloads/contexts.

@type user() :: %{
  optional(:id) => term(),
  optional(:username) => term(),
  optional(:email) => String.t() | nil,
  optional(:ip_address) => String.t() | nil,
  optional(:segment) => term(),
  optional(:geo) => %{
    optional(:city) => String.t() | nil,
    optional(:country_code) => String.t() | nil,
    optional(:region) => String.t() | nil
  },
  optional(atom()) => term()
}

The user interface.

This interface is not a struct since it allows any additional arbitrary key other than the ones defined in the schema.

See https://develop.sentry.dev/sdk/event-payloads/user.