Skip to content

Commit 4a64529

Browse files
committed
Document :integration_meta field in Sentry.Event
1 parent c1c5e97 commit 4a64529

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

lib/sentry/event.ex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ defmodule Sentry.Event do
3939
`:original_exception` field, instead, contains the original exception as the raw Elixir
4040
term (such as `%RuntimeError{...}`).
4141
42+
* `:integration_meta` - a free-form map of integration-specific metadata. Integrations
43+
(such as [the Oban integration](https://docs.sentry.io/platforms/elixir/integrations/oban/))
44+
can set this field to store metadata that
45+
is specific to the integration. This field is not part of the Sentry API payload,
46+
but you can use it for example in [`:before_send`
47+
callbacks](`t:Sentry.before_send_event_callback/0`) to determine whether to report events.
48+
*Available since v10.7.0*.
49+
4250
See also [`%Sentry.Event{}`](`__struct__/0`).
4351
"""
4452
@type t() :: %__MODULE__{

0 commit comments

Comments
 (0)