Module protocol

Implements the sentry event protocol.

Structs

• Addr
  An address
• AppContext
  Application information.
• AppleDebugImage
  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.
• BrowserContext
  Web browser information.
• CError
  POSIX signal with optional extended data.
• ClientReport
• ClientSdkInfo
  The SDK Interface describes the Sentry SDK and its configuration used to capture and transmit an event.
• ClientSdkPackage
  An installed and loaded package as part of the Sentry SDK.
• CloudResourceContext
  Cloud Resource Context.
• CodeId
• ContextInner
• 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
• DebugMeta
  Debugging and processing meta information.
• DeviceClass
• DeviceContext
  Device information.
• DiscardedEvent
• Event
  The sentry v7 event structure.
• EventId
  Wrapper around a UUID with slightly different formatting.
• EventProcessingError
  An event processing error.
• Exception
  A single exception.
• ExpectCt
  Expect CT security report sent by user agent (browser).
• ExpectStaple
  Represents an Expect Staple security report.
• ExtraValue
• Fingerprint
  A fingerprint value.
• Frame
  Holds information about a single stacktrace frame.
• FrameData
  Additional frame data information.
• FrameVars
  Frame local variables.
• Geo
  Geographical location of the end user or device.
• GpuContext
  GPU information.
• GroupingConfig
  The grouping config that should be used for grouping this event.
• HeaderName
  A “into-string” type that normalizes header names.
• HeaderValue
  A “into-string” type that normalizes header values.
• Headers
  A map holding headers.
• Hpkp
  Schema as defined in RFC7469, Section 3
• InvalidRegVal
  Raised if a register value can’t be parsed.
• InvalidSecurityError
• IpAddr
  An ip address.
• JsonLenientString
  A “into-string” type of value. All non-string values are serialized as JSON.
• JvmDebugImage
  A debug image consisting of source files for a JVM based language.
• LenientString
  A “into-string” type of value. Emulates an invocation of str(x) in Python
• LockReason
  Represents an instance of a held lock (java monitor object) in a thread.
• LogEntry
  A log entry message.
• MachException
  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.
• MechanismMeta
  Operating system or runtime meta information to an exception mechanism.
• Message
• MetricSummary
  The metric summary of a single metric that is emitted by the SDK.
• Metrics
  Metrics captured during event ingestion and processing.
• MetricsSummary
  A collection of MetricSummary items keyed by the metric.
• MonitorContext
  Monitor information.
• NativeDebugImage
  A generic (new-style) native platform debug information file.
• NativeImagePath
  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.
• NetworkReportRaw
  Models the content of a NEL report.
• NsError
  NSError informaiton.
• OsContext
  Operating system information.
• OtelContext
  OpenTelemetry Context
• PairList
  A mixture of a hashmap and an array.
• ParseAbnormalMechanismError
• ParseEventTypeError
  An error used when parsing EventType.
• ParseLevelError
  An error used when parsing Level.
• ParseNetworkReportPhaseError
  Error parsing a NetworkReportPhases.
• ParseSessionStatusError
  An error used when parsing SessionStatus.
• ParseSpanStatusError
  Error parsing a SpanStatus.
• PerformanceScoreContext
  Performance Score context.
• PosixSignal
  POSIX signal with optional extended data.
• ProfileContext
  Profile context
• ProguardDebugImage
  Proguard mapping file.
• Query
  A map holding query string pairs.
• RawStacktrace
  A stack trace of a single thread.
• RegVal
  A register value.
• RelayInfo
  The Relay Interface describes a Sentry Relay and its configuration used to process an event during ingest.
• Replay
• ReplayContext
  Replay context.
• ReprocessingContext
  Auxilliary data that Sentry attaches for reprocessed events.
• Request
  Http request information.
• ResponseContext
  Response interface that contains information on a HTTP response related to the event.
• Route
  The route in the application, set by React Native SDK.
• RuntimeContext
  Runtime information.
• SentryTags
  Indexable fields added by sentry (server-side).
• SessionAggregateItem
• SessionAggregates
• SessionAttributes
  Additional attributes for Sessions.
• SessionUpdate
• SingleCertificateTimestamp
  Object used in ExpectCt reports
• SourceMapDebugImage
  A debug image pointing to a source map.
• Span
• SpanData
  Arbitrary additional data on a span.
• SpanId
  A 16-character hex string as described in the W3C trace context spec.
• Stacktrace
• SystemSdkInfo
  Holds information about the system SDK.
• TagEntry
• Tags
  Manual key/value tag pairs.
• TemplateInfo
  Template debug information.
• Thread
  A process thread of an event.
• Timestamp
• TraceContext
  Trace context
• TraceId
  A 32-character hex string as described in the W3C trace context spec.
• TransactionInfo
  Additional information about the name of the transaction.
• TransactionNameChange
• User
  Information about the user who triggered an event.
• UserReport
  User feedback for an event as sent by the client to the userfeedback/userreport endpoint.
• UserReportV2Context
  Feedback context.
• Values
  An array-like wrapper used in various places.

Enums

• AbnormalMechanism
• Context
  A context describes environment info (e.g. device, os or browser).
• CspDirective
• DebugImage
  A debug information file (debug image).
• EventType
  The type of an event.
• ExpectStapleCertStatus
• ExpectStapleResponseStatus
• InstructionAddrAdjustment
  Controls the mechanism by which the instruction_addr of a Stacktrace Frame is adjusted.
• Level
  Severity level of an event or breadcrumb.
• LockReasonType
  Possible lock types responsible for a thread’s blocked state
• NetworkReportError
  The NEL parsing errors.
• NetworkReportPhases
  Describes which phase the error occurred in.
• SecurityReportType
• SessionErrored
  Contains information about errored sessions. See SessionLike.
• SessionStatus
  The type of session event we’re dealing with.
• SpanStatus
  Trace status.
• ThreadId
  Represents a thread id.
• TransactionSource
  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 platform identifiers.

Traits

• AsPair
  A trait to abstract over pairs.
• DefaultContext
  A well-known context in the Contexts interface.
• SessionLike
  Common interface for SessionUpdate and SessionAggregateItem.

Functions

• datetime_to_timestamp

Type Aliases

• MetricSummaryMapping
• OperationType
  A span’s operation type.
• OriginType
  Origin type such as auto.http. Follows the pattern described in the develop docs.