← Back to packages

Package sentry_protos.relay.v1

Message EventBreadcrumbsValues

Message EventBreadcrumbs

Message EventDebugMetaSdkInfo

Message EventDebugMeta

Message EventErrors

Message EventExceptionValuesMechanismMetaErrno

Message EventExceptionValuesMechanismMetaMachException

Message EventExceptionValuesMechanismMetaNsError

Message EventExceptionValuesMechanismMetaSignal

Message EventExceptionValuesMechanismMeta

Message EventExceptionValuesMechanism

Message EventExceptionValuesStacktraceFramesLock

Message EventExceptionValuesStacktraceFrames

Message EventExceptionValuesStacktrace

Message EventExceptionValues

Message EventException

Message EventLogentry

Message EventRequest

Message EventSdkPackages

Message EventSdk

Message EventStacktraceFramesLock

Message EventStacktraceFrames

Message EventStacktrace

Message EventThreadsValuesHeldLocks

Message EventThreadsValuesStacktraceFramesLock

Message EventThreadsValuesStacktraceFrames

Message EventThreadsValuesStacktrace

Message EventThreadsValues

Message EventThreads

Message EventTransactionInfoChanges

Message EventTransactionInfo

Message EventUserGeo

Message EventUser

Message Event

Message Appcontext

Message Appledebugimage

Message Breadcrumb

Message Browsercontext

Message Cerror

Message ClientsdkinfoPackages

Message Clientsdkinfo

Message Clientsdkpackage

Message DataPreviousroute

Message DataRoute

Message Data

Message DebugmetaSdkInfo

Message Debugmeta

Message Devicecontext

Message Eventprocessingerror

Message ExceptionMechanismMetaErrno

Message ExceptionMechanismMetaMachException

Message ExceptionMechanismMetaNsError

Message ExceptionMechanismMetaSignal

Message ExceptionMechanismMeta

Message ExceptionMechanism

Message ExceptionStacktraceFramesLock

Message ExceptionStacktraceFrames

Message ExceptionStacktrace

Message Exception

Message FrameLock

Message Frame

Message Geo

Message Gpucontext

Message Jvmdebugimage

Message Lockreason

Message Logentry

Message Machexception

Message MechanismMetaErrno

Message MechanismMetaMachException

Message MechanismMetaNsError

Message MechanismMetaSignal

Message MechanismMeta

Message Mechanism

Message MechanismmetaErrno

Message MechanismmetaMachException

Message MechanismmetaNsError

Message MechanismmetaSignal

Message Mechanismmeta

Message Nativedebugimage

Message Nelcontext

Message Nserror

Message Oscontext

Message Otelcontext

Message Posixsignal

Message Profilecontext

Message Proguarddebugimage

Message RawstacktraceFramesLock

Message RawstacktraceFrames

Message Rawstacktrace

Message Replaycontext

Message Request

Message Responsecontext

Message Route

Message Runtimecontext

Message Sourcemapdebugimage

Message StacktraceFramesLock

Message StacktraceFrames

Message Stacktrace

Message Systemsdkinfo

Message Tagentry

Message ThreadHeldLocks

Message ThreadStacktraceFramesLock

Message ThreadStacktraceFrames

Message ThreadStacktrace

Message Thread

Message TracecontextDataPreviousroute

Message TracecontextDataRoute

Message TracecontextData

Message Tracecontext

Message TransactioninfoChanges

Message Transactioninfo

Message Transactionnamechange

Message UserGeo

Message User

Message Userreportv2Context

Messages

message EventBreadcrumbsValues (Nested in sentry_protos.relay.v1.Event.EventBreadcrumbs ) sentry_protos/relay/v1/event.proto

Field Type Description
oneof has_timestamp
6 timestamp google.protobuf.Value
oneof has_event_id
3 event_id string
oneof has_category
1 category string
oneof has_data
2 data google.protobuf.Value
oneof has_message
5 message string
oneof has_level
4 level string
oneof has_type
7 type string

message EventBreadcrumbs (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

List of breadcrumbs recorded before this event.

Field Type Description
1 values repeated sentry_protos.relay.v1.Event.EventBreadcrumbs.EventBreadcrumbsValues

message EventDebugMetaSdkInfo (Nested in sentry_protos.relay.v1.Event.EventDebugMeta ) sentry_protos/relay/v1/event.proto

Information about the system SDK (e.g. iOS SDK).

Field Type Description
oneof has_version_patchlevel
4 version_patchlevel uint64
oneof has_version_major
2 version_major uint64
oneof has_sdk_name
1 sdk_name string
oneof has_version_minor
3 version_minor uint64

message EventDebugMeta (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Meta data for event processing and debugging.

Field Type Description
1 images repeated google.protobuf.Value
oneof has_sdk_info
2 sdk_info sentry_protos.relay.v1.Event.EventDebugMeta.EventDebugMetaSdkInfo

message EventErrors (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Errors encountered during processing. Intended to be phased out in favor of
annotation/metadata system.

Field Type Description
2 type string
3 value google.protobuf.Value
oneof has_name
1 name string

message EventExceptionValuesMechanismMetaErrno (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta ) sentry_protos/relay/v1/event.proto

Optional ISO C standard error code.

Field Type Description
oneof has_name
1 name string
oneof has_number
2 number int64

message EventExceptionValuesMechanismMetaMachException (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta ) sentry_protos/relay/v1/event.proto

A Mach Exception on Apple systems comprising a code triple and optional descriptions.

Field Type Description
oneof has_exception
2 exception int64
oneof has_name
3 name string
oneof has_subcode
4 subcode uint64
oneof has_code
1 code uint64

message EventExceptionValuesMechanismMetaNsError (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta ) sentry_protos/relay/v1/event.proto

An NSError on Apple systems comprising code and signal.

Field Type Description
oneof has_domain
2 domain string
oneof has_code
1 code int64

message EventExceptionValuesMechanismMetaSignal (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta ) sentry_protos/relay/v1/event.proto

Information on the POSIX signal.

Field Type Description
oneof has_code_name
2 code_name string
oneof has_name
3 name string
oneof has_number
4 number int64
oneof has_code
1 code int64

message EventExceptionValuesMechanismMeta (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism ) sentry_protos/relay/v1/event.proto

Operating system or runtime meta information.

Field Type Description
oneof has_errno
1 errno sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta.EventExceptionValuesMechanismMetaErrno
oneof has_signal
4 signal sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta.EventExceptionValuesMechanismMetaSignal
oneof has_ns_error
3 ns_error sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta.EventExceptionValuesMechanismMetaNsError
oneof has_mach_exception
2 mach_exception sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta.EventExceptionValuesMechanismMetaMachException

message EventExceptionValuesMechanism (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues ) sentry_protos/relay/v1/event.proto

Mechanism by which this exception was generated and handled.

Field Type Description
11 type string
oneof has_meta
7 meta sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism.EventExceptionValuesMechanismMeta
oneof has_source
9 source string
oneof has_handled
4 handled bool
oneof has_help_link
5 help_link string
oneof has_description
2 description string
oneof has_data
1 data google.protobuf.Value
oneof has_synthetic
10 synthetic bool
oneof has_is_exception_group
6 is_exception_group bool
oneof has_parent_id
8 parent_id uint64
oneof has_exception_id
3 exception_id uint64

message EventExceptionValuesStacktraceFramesLock (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesStacktrace.EventExceptionValuesStacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message EventExceptionValuesStacktraceFrames (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesStacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesStacktrace.EventExceptionValuesStacktraceFrames.EventExceptionValuesStacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message EventExceptionValuesStacktrace (Nested in sentry_protos.relay.v1.Event.EventException.EventExceptionValues ) sentry_protos/relay/v1/event.proto

Stack trace containing frames of this exception.

Field Type Description
1 frames repeated sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesStacktrace.EventExceptionValuesStacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message EventExceptionValues (Nested in sentry_protos.relay.v1.Event.EventException ) sentry_protos/relay/v1/event.proto

Field Type Description
oneof has_stacktrace
3 stacktrace sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesStacktrace
oneof has_module
2 module string
oneof has_mechanism
1 mechanism sentry_protos.relay.v1.Event.EventException.EventExceptionValues.EventExceptionValuesMechanism
oneof has_thread_id
4 thread_id google.protobuf.Value
oneof has_type
5 type string
oneof has_value
6 value string

message EventException (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

One or multiple chained (nested) exceptions.

Field Type Description
1 values repeated sentry_protos.relay.v1.Event.EventException.EventExceptionValues

message EventLogentry (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Custom parameterized message for this event.

Field Type Description
3 params google.protobuf.Value
oneof has_formatted
1 formatted string
oneof has_message
2 message string

message EventRequest (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Information about a web request that occurred during the event.

Field Type Description
4 data google.protobuf.Value
oneof has_body_size
2 body_size uint64
oneof has_env
5 env google.protobuf.Value
oneof has_inferred_content_type
8 inferred_content_type string
oneof has_query_string
11 query_string google.protobuf.Value
oneof has_cookies
3 cookies google.protobuf.Value
oneof has_method
9 method string
oneof has_api_target
1 api_target string
oneof has_fragment
6 fragment string
oneof has_url
12 url string
oneof has_headers
7 headers google.protobuf.Value
oneof has_protocol
10 protocol string

message EventSdkPackages (Nested in sentry_protos.relay.v1.Event.EventSdk ) sentry_protos/relay/v1/event.proto

List of installed and loaded SDK packages. Optional.

A list of packages that were installed as part of this SDK or the activated integrations.
Each package consists of a name in the format source:identifier and version. If the
source is a Git repository, the source should be git, the identifier should be a
checkout link and the version should be a Git reference (branch, tag or SHA).

Field Type Description
oneof has_version
2 version string
oneof has_name
1 name string

message EventSdk (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Information about the Sentry SDK that generated this event.

Field Type Description
1 integrations repeated string
2 name string
3 packages repeated sentry_protos.relay.v1.Event.EventSdk.EventSdkPackages
4 version string

message EventStacktraceFramesLock (Nested in sentry_protos.relay.v1.Event.EventStacktrace.EventStacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message EventStacktraceFrames (Nested in sentry_protos.relay.v1.Event.EventStacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Event.EventStacktrace.EventStacktraceFrames.EventStacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message EventStacktrace (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Event stacktrace.

DEPRECATED: Prefer threads or exception depending on which is more appropriate.

Field Type Description
1 frames repeated sentry_protos.relay.v1.Event.EventStacktrace.EventStacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message EventThreadsValuesHeldLocks (Nested in sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues ) sentry_protos/relay/v1/event.proto

Represents a collection of locks (java monitor objects) held by a thread.

A map of lock object addresses and their respective lock reason/details.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message EventThreadsValuesStacktraceFramesLock (Nested in sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues.EventThreadsValuesStacktrace.EventThreadsValuesStacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message EventThreadsValuesStacktraceFrames (Nested in sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues.EventThreadsValuesStacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues.EventThreadsValuesStacktrace.EventThreadsValuesStacktraceFrames.EventThreadsValuesStacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message EventThreadsValuesStacktrace (Nested in sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues ) sentry_protos/relay/v1/event.proto

Stack trace containing frames of this exception.

The thread that crashed with an exception should not have a stack trace, but instead, the thread_id attribute should be set on the exception and Sentry will connect the two.

Field Type Description
1 frames repeated sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues.EventThreadsValuesStacktrace.EventThreadsValuesStacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message EventThreadsValues (Nested in sentry_protos.relay.v1.Event.EventThreads ) sentry_protos/relay/v1/event.proto

Field Type Description
3 held_locks map<string, EventThreadsValuesHeldLocks>
oneof has_current
2 current bool
oneof has_stacktrace
7 stacktrace sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues.EventThreadsValuesStacktrace
oneof has_id
4 id google.protobuf.Value
oneof has_main
5 main bool
oneof has_state
8 state string
oneof has_crashed
1 crashed bool
oneof has_name
6 name string

message EventThreads (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Threads that were active when the event occurred.

Field Type Description
1 values repeated sentry_protos.relay.v1.Event.EventThreads.EventThreadsValues

message EventTransactionInfoChanges (Nested in sentry_protos.relay.v1.Event.EventTransactionInfo ) sentry_protos/relay/v1/event.proto

A list of changes prior to the final transaction name.

This list must be empty if the transaction name is set at the beginning of the transaction
and never changed. There is no placeholder entry for the initial transaction name.

Field Type Description
oneof has_timestamp
3 timestamp google.protobuf.Value
oneof has_source
2 source string
oneof has_propagations
1 propagations uint64

message EventTransactionInfo (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Additional information about the name of the transaction.

Field Type Description
1 changes repeated sentry_protos.relay.v1.Event.EventTransactionInfo.EventTransactionInfoChanges
oneof has_source
4 source string
oneof has_original
2 original string
oneof has_propagations
3 propagations uint64

message EventUserGeo (Nested in sentry_protos.relay.v1.Event.EventUser ) sentry_protos/relay/v1/event.proto

Approximate geographical location of the end user or device.

Field Type Description
oneof has_country_code
2 country_code string
oneof has_city
1 city string
oneof has_subdivision
4 subdivision string
oneof has_region
3 region string

message EventUser (Nested in sentry_protos.relay.v1.Event ) sentry_protos/relay/v1/event.proto

Information about the user who triggered this event.

Field Type Description
oneof has_id
4 id string
oneof has_username
9 username string
oneof has_data
1 data google.protobuf.Value
oneof has_ip_address
5 ip_address string
oneof has_segment
7 segment string
oneof has_geo
3 geo sentry_protos.relay.v1.Event.EventUser.EventUserGeo
oneof has_sentry_user
8 sentry_user string
oneof has_name
6 name string
oneof has_email
2 email string

message Event sentry_protos/relay/v1/event.proto

The sentry v7 event structure.

Field Type Description
2 contexts map<string, Value>
7 errors repeated sentry_protos.relay.v1.Event.EventErrors
11 fingerprint repeated string
15 modules map<string, string>
oneof has_transaction_info
28 transaction_info sentry_protos.relay.v1.Event.EventTransactionInfo
oneof has_user
30 user sentry_protos.relay.v1.Event.EventUser
oneof has_extra
10 extra google.protobuf.Value
oneof has_tags
23 tags google.protobuf.Value
oneof has_level
12 level string
oneof has_version
31 version string
oneof has_release
18 release string
oneof has_timestamp
26 timestamp google.protobuf.Value
oneof has_event_id
8 event_id string
oneof has_received
17 received google.protobuf.Value
oneof has_logger
14 logger string
oneof has_request
19 request sentry_protos.relay.v1.Event.EventRequest
oneof has_exception
9 exception sentry_protos.relay.v1.Event.EventException
oneof has_debug_meta
4 debug_meta sentry_protos.relay.v1.Event.EventDebugMeta
oneof has_time_spent
25 time_spent uint64
oneof has_platform
16 platform string
oneof has_type
29 type string
oneof has_stacktrace
22 stacktrace sentry_protos.relay.v1.Event.EventStacktrace
oneof has_dist
5 dist string
oneof has_sdk
20 sdk sentry_protos.relay.v1.Event.EventSdk
oneof has_server_name
21 server_name string
oneof has_threads
24 threads sentry_protos.relay.v1.Event.EventThreads
oneof has_culprit
3 culprit string
oneof has_logentry
13 logentry sentry_protos.relay.v1.Event.EventLogentry
oneof has_transaction
27 transaction string
oneof has_breadcrumbs
1 breadcrumbs sentry_protos.relay.v1.Event.EventBreadcrumbs
oneof has_environment
6 environment string

message Appcontext sentry_protos/relay/v1/event.proto

Application information.

App context describes the application. As opposed to the runtime, this is the actual
application that was running and carries metadata about the current session.

Field Type Description
10 view_names repeated string
oneof has_app_build
1 app_build string
oneof has_app_start_time
5 app_start_time string
oneof has_app_identifier
2 app_identifier string
oneof has_device_app_hash
8 device_app_hash string
oneof has_app_name
4 app_name string
oneof has_build_type
7 build_type string
oneof has_in_foreground
9 in_foreground bool
oneof has_app_memory
3 app_memory uint64
oneof has_app_version
6 app_version string

message Appledebugimage sentry_protos/relay/v1/event.proto

Legacy apple debug images (MachO).

This was also used for non-apple platforms with similar debug setups.

Field Type Description
4 image_addr string
5 image_size uint64
7 name string
8 uuid string
oneof has_image_vmaddr
6 image_vmaddr string
oneof has_arch
1 arch string
oneof has_cpu_type
3 cpu_type uint64
oneof has_cpu_subtype
2 cpu_subtype uint64

message Breadcrumb sentry_protos/relay/v1/event.proto

The Breadcrumbs Interface specifies a series of application events, or "breadcrumbs", that
occurred before an event.

An event may contain one or more breadcrumbs in an attribute named breadcrumbs. The entries
are ordered from oldest to newest. Consequently, the last entry in the list should be the last
entry before the event occurred.

While breadcrumb attributes are not strictly validated in Sentry, a breadcrumb is most useful
when it includes at least a timestamp and type, category or message. The rendering of
breadcrumbs in Sentry depends on what is provided.

The following example illustrates the breadcrumbs part of the event payload and omits other
attributes for simplicity.

{
"breadcrumbs": {
"values": [
{
"timestamp": "2016-04-20T20:55:53.845Z",
"message": "Something happened",
"category": "log",
"data": {
"foo": "bar",
"blub": "blah"
}
},
{
"timestamp": "2016-04-20T20:55:53.847Z",
"type": "navigation",
"data": {
"from": "/login",
"to": "/dashboard"
}
}
]
}
}
Field Type Description
oneof has_timestamp
6 timestamp google.protobuf.Value
oneof has_event_id
3 event_id string
oneof has_category
1 category string
oneof has_data
2 data google.protobuf.Value
oneof has_message
5 message string
oneof has_level
4 level string
oneof has_type
7 type string

message Browsercontext sentry_protos/relay/v1/event.proto

Web browser information.

Field Type Description
oneof has_version
2 version string
oneof has_name
1 name string

message Cerror sentry_protos/relay/v1/event.proto

POSIX signal with optional extended data.

Error codes set by Linux system calls and some library functions as specified in ISO C99,
POSIX.1-2001, and POSIX.1-2008. See
errno(3) for more information.

Field Type Description
oneof has_name
1 name string
oneof has_number
2 number int64

message ClientsdkinfoPackages (Nested in sentry_protos.relay.v1.Clientsdkinfo ) sentry_protos/relay/v1/event.proto

List of installed and loaded SDK packages. Optional.

A list of packages that were installed as part of this SDK or the activated integrations.
Each package consists of a name in the format source:identifier and version. If the
source is a Git repository, the source should be git, the identifier should be a
checkout link and the version should be a Git reference (branch, tag or SHA).

Field Type Description
oneof has_version
2 version string
oneof has_name
1 name string

message Clientsdkinfo sentry_protos/relay/v1/event.proto

The SDK Interface describes the Sentry SDK and its configuration used to capture and transmit an event.

Field Type Description
1 integrations repeated string
2 name string
3 packages repeated sentry_protos.relay.v1.Clientsdkinfo.ClientsdkinfoPackages
4 version string

message Clientsdkpackage sentry_protos/relay/v1/event.proto

An installed and loaded package as part of the Sentry SDK.

Field Type Description
oneof has_version
2 version string
oneof has_name
1 name string

message DataPreviousroute (Nested in sentry_protos.relay.v1.Data ) sentry_protos/relay/v1/event.proto

The previous route in the application

Set by React Native SDK.

Field Type Description
oneof has_name
1 name string
oneof has_params
2 params google.protobuf.Value

message DataRoute (Nested in sentry_protos.relay.v1.Data ) sentry_protos/relay/v1/event.proto

The current route in the application.

Set by React Native SDK.

Field Type Description
oneof has_name
1 name string
oneof has_params
2 params google.protobuf.Value

message Data sentry_protos/relay/v1/event.proto

The arbitrary data on the trace.

Field Type Description
oneof has_previous_route
1 previous_route sentry_protos.relay.v1.Data.DataPreviousroute
oneof has_route
2 route sentry_protos.relay.v1.Data.DataRoute

message DebugmetaSdkInfo (Nested in sentry_protos.relay.v1.Debugmeta ) sentry_protos/relay/v1/event.proto

Information about the system SDK (e.g. iOS SDK).

Field Type Description
oneof has_version_patchlevel
4 version_patchlevel uint64
oneof has_version_major
2 version_major uint64
oneof has_sdk_name
1 sdk_name string
oneof has_version_minor
3 version_minor uint64

message Debugmeta sentry_protos/relay/v1/event.proto

Debugging and processing meta information.

The debug meta interface carries debug information for processing errors and crash reports.
Sentry amends the information in this interface.

Example (look at field types to see more detail):

{
"debug_meta": {
"images": [],
"sdk_info": {
"sdk_name": "iOS",
"version_major": 10,
"version_minor": 3,
"version_patchlevel": 0
}
}
}
Field Type Description
1 images repeated google.protobuf.Value
oneof has_sdk_info
2 sdk_info sentry_protos.relay.v1.Debugmeta.DebugmetaSdkInfo

message Devicecontext sentry_protos/relay/v1/event.proto

Device information.

Device context describes the device that caused the event. This is most appropriate for mobile
applications.

Field Type Description
oneof has_arch
1 arch string
oneof has_free_memory
13 free_memory uint64
oneof has_model
19 model string
oneof has_free_storage
14 free_storage uint64
oneof has_supports_location_service
36 supports_location_service bool
oneof has_processor_frequency
25 processor_frequency uint64
oneof has_device_type
8 device_type string
oneof has_screen_density
26 screen_density double
oneof has_screen_width_pixels
30 screen_width_pixels uint64
oneof has_timezone
38 timezone string
oneof has_screen_resolution
29 screen_resolution string
oneof has_manufacturer
17 manufacturer string
oneof has_name
21 name string
oneof has_screen_height_pixels
28 screen_height_pixels uint64
oneof has_cpu_description
7 cpu_description string
oneof has_supports_accelerometer
33 supports_accelerometer bool
oneof has_brand
5 brand string
oneof has_low_memory
16 low_memory bool
oneof has_external_free_storage
10 external_free_storage uint64
oneof has_supports_gyroscope
35 supports_gyroscope bool
oneof has_supports_audio
34 supports_audio bool
oneof has_model_id
20 model_id string
oneof has_screen_dpi
27 screen_dpi uint64
oneof has_memory_size
18 memory_size uint64
oneof has_simulator
31 simulator bool
oneof has_external_storage_size
11 external_storage_size uint64
oneof has_family
12 family string
oneof has_processor_count
24 processor_count uint64
oneof has_supports_vibration
37 supports_vibration bool
oneof has_battery_status
3 battery_status string
oneof has_usable_memory
39 usable_memory uint64
oneof has_battery_level
2 battery_level double
oneof has_boot_time
4 boot_time string
oneof has_online
22 online bool
oneof has_uuid
40 uuid string
oneof has_storage_size
32 storage_size uint64
oneof has_orientation
23 orientation string
oneof has_charging
6 charging bool
oneof has_locale
15 locale string
oneof has_device_unique_identifier
9 device_unique_identifier string

message Eventprocessingerror sentry_protos/relay/v1/event.proto

An event processing error.

Field Type Description
2 type string
3 value google.protobuf.Value
oneof has_name
1 name string

message ExceptionMechanismMetaErrno (Nested in sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta ) sentry_protos/relay/v1/event.proto

Optional ISO C standard error code.

Field Type Description
oneof has_name
1 name string
oneof has_number
2 number int64

message ExceptionMechanismMetaMachException (Nested in sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta ) sentry_protos/relay/v1/event.proto

A Mach Exception on Apple systems comprising a code triple and optional descriptions.

Field Type Description
oneof has_exception
2 exception int64
oneof has_name
3 name string
oneof has_subcode
4 subcode uint64
oneof has_code
1 code uint64

message ExceptionMechanismMetaNsError (Nested in sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta ) sentry_protos/relay/v1/event.proto

An NSError on Apple systems comprising code and signal.

Field Type Description
oneof has_domain
2 domain string
oneof has_code
1 code int64

message ExceptionMechanismMetaSignal (Nested in sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta ) sentry_protos/relay/v1/event.proto

Information on the POSIX signal.

Field Type Description
oneof has_code_name
2 code_name string
oneof has_name
3 name string
oneof has_number
4 number int64
oneof has_code
1 code int64

message ExceptionMechanismMeta (Nested in sentry_protos.relay.v1.Exception.ExceptionMechanism ) sentry_protos/relay/v1/event.proto

Operating system or runtime meta information.

Field Type Description
oneof has_errno
1 errno sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta.ExceptionMechanismMetaErrno
oneof has_signal
4 signal sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta.ExceptionMechanismMetaSignal
oneof has_ns_error
3 ns_error sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta.ExceptionMechanismMetaNsError
oneof has_mach_exception
2 mach_exception sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta.ExceptionMechanismMetaMachException

message ExceptionMechanism (Nested in sentry_protos.relay.v1.Exception ) sentry_protos/relay/v1/event.proto

Mechanism by which this exception was generated and handled.

Field Type Description
11 type string
oneof has_meta
7 meta sentry_protos.relay.v1.Exception.ExceptionMechanism.ExceptionMechanismMeta
oneof has_source
9 source string
oneof has_handled
4 handled bool
oneof has_help_link
5 help_link string
oneof has_description
2 description string
oneof has_data
1 data google.protobuf.Value
oneof has_synthetic
10 synthetic bool
oneof has_is_exception_group
6 is_exception_group bool
oneof has_parent_id
8 parent_id uint64
oneof has_exception_id
3 exception_id uint64

message ExceptionStacktraceFramesLock (Nested in sentry_protos.relay.v1.Exception.ExceptionStacktrace.ExceptionStacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message ExceptionStacktraceFrames (Nested in sentry_protos.relay.v1.Exception.ExceptionStacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Exception.ExceptionStacktrace.ExceptionStacktraceFrames.ExceptionStacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message ExceptionStacktrace (Nested in sentry_protos.relay.v1.Exception ) sentry_protos/relay/v1/event.proto

Stack trace containing frames of this exception.

Field Type Description
1 frames repeated sentry_protos.relay.v1.Exception.ExceptionStacktrace.ExceptionStacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message Exception sentry_protos/relay/v1/event.proto

A single exception.

Multiple values inside of an event represent chained exceptions and should be sorted oldest to newest. For example, consider this Python code snippet:

try:
raise Exception("random boring invariant was not met!")
except Exception as e:
raise ValueError("something went wrong, help!") from e

Exception would be described first in the values list, followed by a description of ValueError:

{
"exception": {
"values": [
{"type": "Exception": "value": "random boring invariant was not met!"},
{"type": "ValueError", "value": "something went wrong, help!"},
]
}
}
Field Type Description
oneof has_stacktrace
3 stacktrace sentry_protos.relay.v1.Exception.ExceptionStacktrace
oneof has_module
2 module string
oneof has_mechanism
1 mechanism sentry_protos.relay.v1.Exception.ExceptionMechanism
oneof has_thread_id
4 thread_id google.protobuf.Value
oneof has_type
5 type string
oneof has_value
6 value string

message FrameLock (Nested in sentry_protos.relay.v1.Frame ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message Frame sentry_protos/relay/v1/event.proto

Holds information about a single stacktrace frame.

Each object should contain at least a filename, function or instruction_addr
attribute. All values are optional, but recommended.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Frame.FrameLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message Geo sentry_protos/relay/v1/event.proto

Geographical location of the end user or device.

Field Type Description
oneof has_country_code
2 country_code string
oneof has_city
1 city string
oneof has_subdivision
4 subdivision string
oneof has_region
3 region string

message Gpucontext sentry_protos/relay/v1/event.proto

GPU information.

Example:

"gpu": {
"name": "AMD Radeon Pro 560",
"vendor_name": "Apple",
"memory_size": 4096,
"api_type": "Metal",
"multi_threaded_rendering": true,
"version": "Metal",
"npot_support": "Full"
}
Field Type Description
3 id google.protobuf.Value
oneof has_api_type
1 api_type string
oneof has_supports_compute_shaders
9 supports_compute_shaders bool
oneof has_multi_threaded_rendering
6 multi_threaded_rendering bool
oneof has_vendor_name
14 vendor_name string
oneof has_supports_ray_tracing
12 supports_ray_tracing bool
oneof has_npot_support
8 npot_support string
oneof has_max_texture_size
4 max_texture_size uint64
oneof has_supports_geometry_shaders
11 supports_geometry_shaders bool
oneof has_supports_draw_call_instancing
10 supports_draw_call_instancing bool
oneof has_vendor_id
13 vendor_id string
oneof has_graphics_shader_level
2 graphics_shader_level string
oneof has_version
15 version string
oneof has_name
7 name string
oneof has_memory_size
5 memory_size uint64

message Jvmdebugimage sentry_protos/relay/v1/event.proto

A debug image consisting of source files for a JVM based language.

Examples:

{
"type": "jvm",
"debug_id": "395835f4-03e0-4436-80d3-136f0749a893"
}
Field Type Description
1 debug_id string

message Lockreason sentry_protos/relay/v1/event.proto

Represents an instance of a held lock (java monitor object) in a thread.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message Logentry sentry_protos/relay/v1/event.proto

A log entry message.

A log message is similar to the message attribute on the event itself but
can additionally hold optional parameters.

{
"message": {
"message": "My raw message with interpreted strings like %s",
"params": ["this"]
}
}
{
"message": {
"message": "My raw message with interpreted strings like {foo}",
"params": {"foo": "this"}
}
}
Field Type Description
3 params google.protobuf.Value
oneof has_formatted
1 formatted string
oneof has_message
2 message string

message Machexception sentry_protos/relay/v1/event.proto

Mach exception information.

Field Type Description
oneof has_exception
2 exception int64
oneof has_name
3 name string
oneof has_subcode
4 subcode uint64
oneof has_code
1 code uint64

message MechanismMetaErrno (Nested in sentry_protos.relay.v1.Mechanism.MechanismMeta ) sentry_protos/relay/v1/event.proto

Optional ISO C standard error code.

Field Type Description
oneof has_name
1 name string
oneof has_number
2 number int64

message MechanismMetaMachException (Nested in sentry_protos.relay.v1.Mechanism.MechanismMeta ) sentry_protos/relay/v1/event.proto

A Mach Exception on Apple systems comprising a code triple and optional descriptions.

Field Type Description
oneof has_exception
2 exception int64
oneof has_name
3 name string
oneof has_subcode
4 subcode uint64
oneof has_code
1 code uint64

message MechanismMetaNsError (Nested in sentry_protos.relay.v1.Mechanism.MechanismMeta ) sentry_protos/relay/v1/event.proto

An NSError on Apple systems comprising code and signal.

Field Type Description
oneof has_domain
2 domain string
oneof has_code
1 code int64

message MechanismMetaSignal (Nested in sentry_protos.relay.v1.Mechanism.MechanismMeta ) sentry_protos/relay/v1/event.proto

Information on the POSIX signal.

Field Type Description
oneof has_code_name
2 code_name string
oneof has_name
3 name string
oneof has_number
4 number int64
oneof has_code
1 code int64

message MechanismMeta (Nested in sentry_protos.relay.v1.Mechanism ) sentry_protos/relay/v1/event.proto

Operating system or runtime meta information.

Field Type Description
oneof has_errno
1 errno sentry_protos.relay.v1.Mechanism.MechanismMeta.MechanismMetaErrno
oneof has_signal
4 signal sentry_protos.relay.v1.Mechanism.MechanismMeta.MechanismMetaSignal
oneof has_ns_error
3 ns_error sentry_protos.relay.v1.Mechanism.MechanismMeta.MechanismMetaNsError
oneof has_mach_exception
2 mach_exception sentry_protos.relay.v1.Mechanism.MechanismMeta.MechanismMetaMachException

message Mechanism sentry_protos/relay/v1/event.proto

The mechanism by which an exception was generated and handled.

The exception mechanism is an optional field residing in the exception.
It carries additional information about the way the exception was created on the target system.
This includes general exception values obtained from the operating system or runtime APIs, as
well as mechanism-specific values.

Field Type Description
11 type string
oneof has_meta
7 meta sentry_protos.relay.v1.Mechanism.MechanismMeta
oneof has_source
9 source string
oneof has_handled
4 handled bool
oneof has_help_link
5 help_link string
oneof has_description
2 description string
oneof has_data
1 data google.protobuf.Value
oneof has_synthetic
10 synthetic bool
oneof has_is_exception_group
6 is_exception_group bool
oneof has_parent_id
8 parent_id uint64
oneof has_exception_id
3 exception_id uint64

message MechanismmetaErrno (Nested in sentry_protos.relay.v1.Mechanismmeta ) sentry_protos/relay/v1/event.proto

Optional ISO C standard error code.

Field Type Description
oneof has_name
1 name string
oneof has_number
2 number int64

message MechanismmetaMachException (Nested in sentry_protos.relay.v1.Mechanismmeta ) sentry_protos/relay/v1/event.proto

A Mach Exception on Apple systems comprising a code triple and optional descriptions.

Field Type Description
oneof has_exception
2 exception int64
oneof has_name
3 name string
oneof has_subcode
4 subcode uint64
oneof has_code
1 code uint64

message MechanismmetaNsError (Nested in sentry_protos.relay.v1.Mechanismmeta ) sentry_protos/relay/v1/event.proto

An NSError on Apple systems comprising code and signal.

Field Type Description
oneof has_domain
2 domain string
oneof has_code
1 code int64

message MechanismmetaSignal (Nested in sentry_protos.relay.v1.Mechanismmeta ) sentry_protos/relay/v1/event.proto

Information on the POSIX signal.

Field Type Description
oneof has_code_name
2 code_name string
oneof has_name
3 name string
oneof has_number
4 number int64
oneof has_code
1 code int64

message Mechanismmeta sentry_protos/relay/v1/event.proto

Operating system or runtime meta information to an exception mechanism.

The mechanism metadata usually carries error codes reported by the runtime or operating system,
along with a platform-dependent interpretation of these codes. SDKs can safely omit code names
and descriptions for well-known error codes, as it will be filled out by Sentry. For
proprietary or vendor-specific error codes, adding these values will give additional
information to the user.

Field Type Description
oneof has_errno
1 errno sentry_protos.relay.v1.Mechanismmeta.MechanismmetaErrno
oneof has_signal
4 signal sentry_protos.relay.v1.Mechanismmeta.MechanismmetaSignal
oneof has_ns_error
3 ns_error sentry_protos.relay.v1.Mechanismmeta.MechanismmetaNsError
oneof has_mach_exception
2 mach_exception sentry_protos.relay.v1.Mechanismmeta.MechanismmetaMachException

message Nativedebugimage sentry_protos/relay/v1/event.proto

A generic (new-style) native platform debug information file.

The type key must be one of:

  • macho
  • elf: ELF images are used on Linux platforms. Their structure is identical to other native images.
  • pe

Examples:

{
"type": "elf",
"code_id": "68220ae2c65d65c1b6aaa12fa6765a6ec2f5f434",
"code_file": "/lib/x86_64-linux-gnu/libgcc_s.so.1",
"debug_id": "e20a2268-5dc6-c165-b6aa-a12fa6765a6e",
"image_addr": "0x7f5140527000",
"image_size": 90112,
"image_vmaddr": "0x40000",
"arch": "x86_64"
}
{
"type": "pe",
"code_id": "57898e12145000",
"code_file": "C:\\Windows\\System32\\dbghelp.dll",
"debug_id": "9c2a902b-6fdf-40ad-8308-588a41d572a0-1",
"debug_file": "dbghelp.pdb",
"image_addr": "0x70850000",
"image_size": "1331200",
"image_vmaddr": "0x40000",
"arch": "x86"
}
{
"type": "macho",
"debug_id": "84a04d24-0e60-3810-a8c0-90a65e2df61a",
"debug_file": "libDiagnosticMessagesClient.dylib",
"code_file": "/usr/lib/libDiagnosticMessagesClient.dylib",
"image_addr": "0x7fffe668e000",
"image_size": 8192,
"image_vmaddr": "0x40000",
"arch": "x86_64",
}
Field Type Description
2 code_file string
6 debug_id string
oneof has_image_size
8 image_size uint64
oneof has_arch
1 arch string
oneof has_image_vmaddr
9 image_vmaddr string
oneof has_debug_file
5 debug_file string
oneof has_image_addr
7 image_addr string
oneof has_debug_checksum
4 debug_checksum string
oneof has_code_id
3 code_id string

message Nelcontext sentry_protos/relay/v1/event.proto

Contains NEL report information.

Network Error Logging (NEL) is a browser feature that allows reporting of failed network
requests from the client side. See the following resources for more information:

Field Type Description
oneof has_server_ip
5 server_ip string
oneof has_error_type
2 error_type string
oneof has_elapsed_time
1 elapsed_time uint64
oneof has_phase
3 phase google.protobuf.Value
oneof has_sampling_fraction
4 sampling_fraction double

message Nserror sentry_protos/relay/v1/event.proto

NSError informaiton.

Field Type Description
oneof has_domain
2 domain string
oneof has_code
1 code int64

message Oscontext sentry_protos/relay/v1/event.proto

Operating system information.

OS context describes the operating system on which the event was created. In web contexts, this
is the operating system of the browser (generally pulled from the User-Agent string).

Field Type Description
oneof has_raw_description
4 raw_description string
oneof has_build
1 build string
oneof has_version
6 version string
oneof has_kernel_version
2 kernel_version string
oneof has_name
3 name string
oneof has_rooted
5 rooted bool

message Otelcontext sentry_protos/relay/v1/event.proto

OpenTelemetry Context

If an event has this context, it was generated from an OpenTelemetry signal (trace, metric, log).

Field Type Description
oneof has_attributes
1 attributes google.protobuf.Value
oneof has_resource
2 resource google.protobuf.Value

message Posixsignal sentry_protos/relay/v1/event.proto

POSIX signal with optional extended data.

On Apple systems, signals also carry a code in addition to the signal number describing the
signal in more detail. On Linux, this code does not exist.

Field Type Description
oneof has_code_name
2 code_name string
oneof has_name
3 name string
oneof has_number
4 number int64
oneof has_code
1 code int64

message Profilecontext sentry_protos/relay/v1/event.proto

Profile context

Field Type Description
1 profile_id string

message Proguarddebugimage sentry_protos/relay/v1/event.proto

Proguard mapping file.

Proguard images refer to mapping.txt files generated when Proguard obfuscates function names. The Java SDK integrations assign this file a unique identifier, which has to be included in the list of images.

Field Type Description
1 uuid string

message RawstacktraceFramesLock (Nested in sentry_protos.relay.v1.Rawstacktrace.RawstacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message RawstacktraceFrames (Nested in sentry_protos.relay.v1.Rawstacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Rawstacktrace.RawstacktraceFrames.RawstacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message Rawstacktrace sentry_protos/relay/v1/event.proto

A stack trace of a single thread.

A stack trace contains a list of frames, each with various bits (most optional) describing the
context of that frame. Frames should be sorted from oldest to newest.

For the given example program written in Python:

def foo():
my_var = 'foo'
raise ValueError()

def main():
foo()

A minimalistic stack trace for the above program in the correct order:

{
"frames": [
{"function": "main"},
{"function": "foo"}
]
}

The top frame fully symbolicated with five lines of source context:

{
"frames": [{
"in_app": true,
"function": "myfunction",
"abs_path": "/real/file/name.py",
"filename": "file/name.py",
"lineno": 3,
"vars": {
"my_var": "'value'"
},
"pre_context": [
"def foo():",
"  my_var = 'foo'",
],
"context_line": "  raise ValueError()",
"post_context": [
"",
"def main():"
],
}]
}

A minimal native stack trace with register values. Note that the package event attribute must
be "native" for these frames to be symbolicated.

{
"frames": [
{"instruction_addr": "0x7fff5bf3456c"},
{"instruction_addr": "0x7fff5bf346c0"},
],
"registers": {
"rip": "0x00007ff6eef54be2",
"rsp": "0x0000003b710cd9e0"
}
}
Field Type Description
1 frames repeated sentry_protos.relay.v1.Rawstacktrace.RawstacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message Replaycontext sentry_protos/relay/v1/event.proto

Replay context.

The replay context contains the replay_id of the session replay if the event
occurred during a replay. The replay_id is added onto the dynamic sampling context
on the javascript SDK which propagates it through the trace. In relay, we take
this value from the DSC and create a context which contains only the replay_id
This context is never set on the client for events, only on relay.

Field Type Description
oneof has_replay_id
1 replay_id string

message Request sentry_protos/relay/v1/event.proto

Http request information.

The Request interface contains information on a HTTP request related to the event. In client
SDKs, this can be an outgoing request, or the request that rendered the current web page. On
server SDKs, this could be the incoming web request that is being handled.

The data variable should only contain the request body (not the query string). It can either be
a dictionary (for standard HTTP requests) or a raw request body.

Ordered Maps

In the Request interface, several attributes can either be declared as string, object, or list
of tuples. Sentry attempts to parse structured information from the string representation in
such cases.

Sometimes, keys can be declared multiple times, or the order of elements matters. In such
cases, use the tuple representation over a plain object.

Example of request headers as object:

{
"content-type": "application/json",
"accept": "application/json, application/xml"
}

Example of the same headers as list of tuples:

[
["content-type", "application/json"],
["accept", "application/json"],
["accept", "application/xml"]
]

Example of a fully populated request object:

{
"request": {
"method": "POST",
"url": "http://absolute.uri/foo",
"query_string": "query=foobar&page=2",
"data": {
"foo": "bar"
},
"cookies": "PHPSESSID=298zf09hf012fh2; csrftoken=u32t4o3tb3gg43; _gat=1;",
"headers": {
"content-type": "text/html"
},
"env": {
"REMOTE_ADDR": "192.168.0.1"
}
}
}
Field Type Description
4 data google.protobuf.Value
oneof has_body_size
2 body_size uint64
oneof has_env
5 env google.protobuf.Value
oneof has_inferred_content_type
8 inferred_content_type string
oneof has_query_string
11 query_string google.protobuf.Value
oneof has_cookies
3 cookies google.protobuf.Value
oneof has_method
9 method string
oneof has_api_target
1 api_target string
oneof has_fragment
6 fragment string
oneof has_url
12 url string
oneof has_headers
7 headers google.protobuf.Value
oneof has_protocol
10 protocol string

message Responsecontext sentry_protos/relay/v1/event.proto

Response interface that contains information on a HTTP response related to the event.

The data variable should only contain the response body. It can either be
a dictionary (for standard HTTP responses) or a raw response body.

Field Type Description
3 data google.protobuf.Value
oneof has_body_size
1 body_size uint64
oneof has_cookies
2 cookies google.protobuf.Value
oneof has_headers
4 headers google.protobuf.Value
oneof has_inferred_content_type
5 inferred_content_type string
oneof has_status_code
6 status_code uint64

message Route sentry_protos/relay/v1/event.proto

The route in the application, set by React Native SDK.

Field Type Description
oneof has_name
1 name string
oneof has_params
2 params google.protobuf.Value

message Runtimecontext sentry_protos/relay/v1/event.proto

Runtime information.

Runtime context describes a runtime in more detail. Typically, this context is present in
contexts multiple times if multiple runtimes are involved (for instance, if you have a
JavaScript application running on top of JVM).

Field Type Description
oneof has_version
4 version string
oneof has_raw_description
3 raw_description string
oneof has_name
2 name string
oneof has_build
1 build string

message Sourcemapdebugimage sentry_protos/relay/v1/event.proto

A debug image pointing to a source map.

Examples:

{
"type": "sourcemap",
"code_file": "https://example.com/static/js/main.min.js",
"debug_id": "395835f4-03e0-4436-80d3-136f0749a893"
}

Note:* Stack frames and the correlating entries in the debug image here
for code_file/abs_path are not PII stripped as they need to line up
perfectly for source map processing.

Field Type Description
1 code_file string
3 debug_id string
oneof has_debug_file
2 debug_file string

message StacktraceFramesLock (Nested in sentry_protos.relay.v1.Stacktrace.StacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message StacktraceFrames (Nested in sentry_protos.relay.v1.Stacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Stacktrace.StacktraceFrames.StacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message Stacktrace sentry_protos/relay/v1/event.proto

Field Type Description
1 frames repeated sentry_protos.relay.v1.Stacktrace.StacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message Systemsdkinfo sentry_protos/relay/v1/event.proto

Holds information about the system SDK.

This is relevant for iOS and other platforms that have a system
SDK. Not to be confused with the client SDK.

Field Type Description
oneof has_version_patchlevel
4 version_patchlevel uint64
oneof has_version_major
2 version_major uint64
oneof has_sdk_name
1 sdk_name string
oneof has_version_minor
3 version_minor uint64

message Tagentry sentry_protos/relay/v1/event.proto

Field Type Description
oneof has_a0
1 a0 string
oneof has_a1
2 a1 string

message ThreadHeldLocks (Nested in sentry_protos.relay.v1.Thread ) sentry_protos/relay/v1/event.proto

Represents a collection of locks (java monitor objects) held by a thread.

A map of lock object addresses and their respective lock reason/details.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message ThreadStacktraceFramesLock (Nested in sentry_protos.relay.v1.Thread.ThreadStacktrace.ThreadStacktraceFrames ) sentry_protos/relay/v1/event.proto

A possible lock (java monitor object) held by this frame.

Field Type Description
5 type string
oneof has_class_name
2 class_name string
oneof has_package_name
3 package_name string
oneof has_address
1 address string
oneof has_thread_id
4 thread_id google.protobuf.Value

message ThreadStacktraceFrames (Nested in sentry_protos.relay.v1.Thread.ThreadStacktrace ) sentry_protos/relay/v1/event.proto

Required. A non-empty list of stack frames. The list is ordered from caller to callee, or
oldest to youngest. The last frame is the one creating the exception.

Field Type Description
16 post_context repeated string
17 pre_context repeated string
oneof has_module
13 module string
oneof has_lock
12 lock sentry_protos.relay.v1.Thread.ThreadStacktrace.ThreadStacktraceFrames.ThreadStacktraceFramesLock
oneof has_in_app
9 in_app bool
oneof has_vars
22 vars google.protobuf.Value
oneof has_symbol
20 symbol string
oneof has_lineno
11 lineno uint64
oneof has_function_id
7 function_id string
oneof has_abs_path
1 abs_path string
oneof has_package
14 package string
oneof has_stack_start
19 stack_start bool
oneof has_image_addr
8 image_addr string
oneof has_colno
3 colno uint64
oneof has_function
6 function string
oneof has_filename
5 filename string
oneof has_context_line
4 context_line string
oneof has_platform
15 platform string
oneof has_symbol_addr
21 symbol_addr string
oneof has_addr_mode
2 addr_mode string
oneof has_instruction_addr
10 instruction_addr string
oneof has_raw_function
18 raw_function string

message ThreadStacktrace (Nested in sentry_protos.relay.v1.Thread ) sentry_protos/relay/v1/event.proto

Stack trace containing frames of this exception.

The thread that crashed with an exception should not have a stack trace, but instead, the thread_id attribute should be set on the exception and Sentry will connect the two.

Field Type Description
1 frames repeated sentry_protos.relay.v1.Thread.ThreadStacktrace.ThreadStacktraceFrames
4 registers map<string, string>
oneof has_lang
3 lang string
oneof has_instruction_addr_adjustment
2 instruction_addr_adjustment string
oneof has_snapshot
5 snapshot bool

message Thread sentry_protos/relay/v1/event.proto

A process thread of an event.

The Threads Interface specifies threads that were running at the time an event happened. These threads can also contain stack traces.

An event may contain one or more threads in an attribute named threads.

The following example illustrates the threads part of the event payload and omits other attributes for simplicity.

{
"threads": {
"values": [
{
"id": "0",
"name": "main",
"crashed": true,
"stacktrace": {}
}
]
}
}
Field Type Description
3 held_locks map<string, EventThreadsValuesHeldLocks>
oneof has_current
2 current bool
oneof has_stacktrace
7 stacktrace sentry_protos.relay.v1.Thread.ThreadStacktrace
oneof has_id
4 id google.protobuf.Value
oneof has_main
5 main bool
oneof has_state
8 state string
oneof has_crashed
1 crashed bool
oneof has_name
6 name string

message TracecontextDataPreviousroute (Nested in sentry_protos.relay.v1.Tracecontext.TracecontextData ) sentry_protos/relay/v1/event.proto

The previous route in the application

Set by React Native SDK.

Field Type Description
oneof has_name
1 name string
oneof has_params
2 params google.protobuf.Value

message TracecontextDataRoute (Nested in sentry_protos.relay.v1.Tracecontext.TracecontextData ) sentry_protos/relay/v1/event.proto

The current route in the application.

Set by React Native SDK.

Field Type Description
oneof has_name
1 name string
oneof has_params
2 params google.protobuf.Value

message TracecontextData (Nested in sentry_protos.relay.v1.Tracecontext ) sentry_protos/relay/v1/event.proto

Arbitrary additional data on a trace.

Field Type Description
oneof has_previous_route
1 previous_route sentry_protos.relay.v1.Tracecontext.TracecontextData.TracecontextDataPreviousroute
oneof has_route
2 route sentry_protos.relay.v1.Tracecontext.TracecontextData.TracecontextDataRoute

message Tracecontext sentry_protos/relay/v1/event.proto

Trace context

Field Type Description
8 span_id string
10 trace_id string
oneof has_origin
5 origin string
oneof has_client_sample_rate
1 client_sample_rate double
oneof has_sampled
7 sampled bool
oneof has_data
2 data sentry_protos.relay.v1.Tracecontext.TracecontextData
oneof has_op
4 op string
oneof has_parent_span_id
6 parent_span_id string
oneof has_status
9 status string
oneof has_exclusive_time
3 exclusive_time double

message TransactioninfoChanges (Nested in sentry_protos.relay.v1.Transactioninfo ) sentry_protos/relay/v1/event.proto

A list of changes prior to the final transaction name.

This list must be empty if the transaction name is set at the beginning of the transaction
and never changed. There is no placeholder entry for the initial transaction name.

Field Type Description
oneof has_timestamp
3 timestamp google.protobuf.Value
oneof has_source
2 source string
oneof has_propagations
1 propagations uint64

message Transactioninfo sentry_protos/relay/v1/event.proto

Additional information about the name of the transaction.

Field Type Description
1 changes repeated sentry_protos.relay.v1.Transactioninfo.TransactioninfoChanges
oneof has_source
4 source string
oneof has_original
2 original string
oneof has_propagations
3 propagations uint64

message Transactionnamechange sentry_protos/relay/v1/event.proto

Field Type Description
oneof has_timestamp
3 timestamp google.protobuf.Value
oneof has_source
2 source string
oneof has_propagations
1 propagations uint64

message UserGeo (Nested in sentry_protos.relay.v1.User ) sentry_protos/relay/v1/event.proto

Approximate geographical location of the end user or device.

Field Type Description
oneof has_country_code
2 country_code string
oneof has_city
1 city string
oneof has_subdivision
4 subdivision string
oneof has_region
3 region string

message User sentry_protos/relay/v1/event.proto

Information about the user who triggered an event.

{
"user": {
"id": "unique_id",
"username": "my_user",
"email": "foo@example.com",
"ip_address": "127.0.0.1",
"subscription": "basic"
}
}
Field Type Description
oneof has_id
4 id string
oneof has_username
9 username string
oneof has_data
1 data google.protobuf.Value
oneof has_ip_address
5 ip_address string
oneof has_segment
7 segment string
oneof has_geo
3 geo sentry_protos.relay.v1.User.UserGeo
oneof has_sentry_user
8 sentry_user string
oneof has_name
6 name string
oneof has_email
2 email string

message Userreportv2Context sentry_protos/relay/v1/event.proto

Feedback context.

This contexts contains user feedback specific attributes.
We don't PII scrub contact_email as that is provided by the user.
TODO(jferg): rename to FeedbackContext once old UserReport logic is deprecated.

Field Type Description
oneof has_contact_email
1 contact_email string
oneof has_message
2 message string