Expand description
Implements the sentry event protocol.
Structs§
- Addr
- An address
- AppContext
- Application information.
- Apple
Debug Image - Legacy apple debug images (MachO).
- BodyRaw
- Generated network error report (NEL).
- Breadcrumb
- The Breadcrumbs Interface specifies a series of application events, or “breadcrumbs”, that occurred before an event.
- Breakdowns
- A map of breakdowns. Breakdowns may be available on any event type. A breakdown are product-defined measurement values generated by the client, or materialized during ingestion. For example, for transactions, we may emit span operation breakdowns based on the attached span data.
- Browser
Context - Web browser information.
- CError
- POSIX signal with optional extended data.
- Client
Report - Client
SdkInfo - The SDK Interface describes the Sentry SDK and its configuration used to capture and transmit an event.
- Client
SdkPackage - An installed and loaded package as part of the Sentry SDK.
- Client
SdkSettings - A collection of settings that are used to control behaviour in relay through flags.
- Cloud
Resource Context - Cloud Resource Context.
- CodeId
- Context
Inner - Contexts
- The Contexts interface provides additional context data. Typically, this is data related to the
current user and the environment. For example, the device or application version. Its canonical
name is
contexts. - Cookies
- A map holding cookies.
- Csp
- Models the content of a CSP report.
- DebugId
- Debug
Meta - Debugging and processing meta information.
- Device
Class - Device
Context - Device information.
- Discarded
Event - Event
- The sentry v7 event structure.
- EventId
- Wrapper around a UUID with slightly different formatting.
- Event
Processing Error - An event processing error.
- Exception
- A single exception.
- Expect
Ct - Expect CT security report sent by user agent (browser).
- Expect
Staple - Represents an Expect Staple security report.
- Extra
Value - Fingerprint
- A fingerprint value.
- Frame
- Holds information about a single stacktrace frame.
- Frame
Data - Additional frame data information.
- Frame
Vars - Frame local variables.
- Geo
- Geographical location of the end user or device.
- GpuContext
- GPU information.
- Grouping
Config - The grouping config that should be used for grouping this event.
- Header
Name - A “into-string” type that normalizes header names.
- Header
Value - A “into-string” type that normalizes header values.
- Headers
- A map holding headers.
- Hpkp
- Schema as defined in RFC7469, Section 3
- Invalid
RegVal - Raised if a register value can’t be parsed.
- Invalid
Security Error - IpAddr
- An ip address.
- Json
Lenient String - A “into-string” type of value. All non-string values are serialized as JSON.
- JvmDebug
Image - A debug image consisting of source files for a JVM based language.
- Lenient
String - A “into-string” type of value. Emulates an invocation of
str(x)in Python - Lock
Reason - Represents an instance of a held lock (java monitor object) in a thread.
- LogEntry
- A log entry message.
- Mach
Exception - Mach exception information.
- Measurement
- An individual observed measurement.
- Measurements
- A map of observed measurement values.
- Mechanism
- The mechanism by which an exception was generated and handled.
- Mechanism
Meta - Operating system or runtime meta information to an exception mechanism.
- Message
- Metric
Summary - The metric summary of a single metric that is emitted by the SDK.
- Metrics
- Metrics captured during event ingestion and processing.
- Metrics
Summary - A collection of
MetricSummaryitems keyed by the metric. - Monitor
Context - Monitor information.
- Native
Debug Image - A generic (new-style) native platform debug information file.
- Native
Image Path - A type for strings that are generally paths, might contain system user names, but still cannot be stripped liberally because it would break processing for certain platforms.
- NelContext
- Contains NEL report information.
- Network
Report Raw - Models the content of a NEL report.
- NsError
- NSError informaiton.
- OsContext
- Operating system information.
- Otel
Context - OpenTelemetry Context
- OurLog
- OurLog
Attribute - OurLog
Attribute Value - Pair
List - A mixture of a hashmap and an array.
- Parse
Abnormal Mechanism Error - Parse
Event Type Error - An error used when parsing
EventType. - Parse
Level Error - An error used when parsing
Level. - Parse
Network Report Phase Error - Error parsing a
NetworkReportPhases. - Parse
Session Status Error - An error used when parsing
SessionStatus. - Parse
Span Kind Error - Parse
Span Status Error - Error parsing a
SpanStatus. - Performance
Score Context - Performance Score context.
- Posix
Signal - POSIX signal with optional extended data.
- Profile
Context - Profile context
- Proguard
Debug Image - Proguard mapping file.
- Query
- A map holding query string pairs.
- RawStacktrace
- A stack trace of a single thread.
- RegVal
- A register value.
- Relay
Info - The Relay Interface describes a Sentry Relay and its configuration used to process an event during ingest.
- Replay
- Replay
Context - Replay context.
- Reprocessing
Context - Auxilliary data that Sentry attaches for reprocessed events.
- Request
- Http request information.
- Response
Context - Response interface that contains information on a HTTP response related to the event.
- Route
- The route in the application, set by React Native SDK.
- Runtime
Context - Runtime information.
- Sentry
Tags - Indexable fields added by sentry (server-side).
- Session
Aggregate Item - Session
Aggregates - Session
Attributes - Additional attributes for Sessions.
- Session
Update - Single
Certificate Timestamp - Object used in ExpectCt reports
- Source
MapDebug Image - A debug image pointing to a source map.
- Span
- Span
Data - Arbitrary additional data on a span.
- SpanId
- A 16-character hex string as described in the W3C trace context spec.
- Span
Link - A link from a span to another span.
- Spring
Context - Spring context.
- Stacktrace
- System
SdkInfo - Holds information about the system SDK.
- TagEntry
- Tags
- Manual key/value tag pairs.
- Template
Info - Template debug information.
- Thread
- A process thread of an event.
- Timestamp
- Trace
Context - Trace context
- TraceId
- Represents a W3C Trace Context
trace-id. - Transaction
Info - Additional information about the name of the transaction.
- Transaction
Name Change - User
- Information about the user who triggered an event.
- User
Report - User feedback for an event as sent by the client to the userfeedback/userreport endpoint.
- User
Report V2Context - Feedback context.
- Values
- An array-like wrapper used in various places.
Enums§
- Abnormal
Mechanism - Auto
Infer Setting - Used to control the IP inference setting in relay. This is used as an alternative to magic values like {{auto}} in the user.ip_address field.
- Context
- A context describes environment info (e.g. device, os or browser).
- CspDirective
- Debug
Image - A debug information file (debug image).
- Event
Type - The type of an event.
- Expect
Staple Cert Status - Expect
Staple Response Status - Instruction
Addr Adjustment - Controls the mechanism by which the
instruction_addrof aStacktraceFrameis adjusted. - Level
- Severity level of an event or breadcrumb.
- Lock
Reason Type - Possible lock types responsible for a thread’s blocked state
- Network
Report Error - The NEL parsing errors.
- Network
Report Phases - Describes which phase the error occurred in.
- OurLog
Attribute Type - OurLog
Level - Parse
Setting Error - An error returned when parsing setting values fail.
- Security
Report Type - Session
Errored - Contains information about errored sessions. See
SessionLike. - Session
Status - The type of session event we’re dealing with.
- Span
Kind - Span
Status - Trace status.
- Thread
Id - Represents a thread id.
- Transaction
Source - Describes how the name of the transaction was determined.
Constants§
- PROTOCOL_
VERSION - The latest version of the protocol.
- VALID_
PLATFORMS - A list of all valid
platformidentifiers.
Traits§
- AsPair
- A trait to abstract over pairs.
- Default
Context - A well-known context in the
Contextsinterface. - Session
Like - Common interface for
SessionUpdateandSessionAggregateItem.
Functions§
Type Aliases§
- Metric
Summary Mapping - Operation
Type - A span’s operation type.
- Origin
Type - Origin type such as
auto.http. Follows the pattern described in the develop docs.