The SDK Interface describes the Sentry SDK and its configuration used to capture and transmit an event.
- Required. The name of the SDK. The format is
entity.ecosystem[.flavor]where entity identifies the developer of the SDK, ecosystem refers to the programming language or platform where the SDK is to be used and the optional flavor is used to identify standalone SDKs that are part of a major ecosystem. Official Sentry SDKs use the entity
For SDKs that are composed of more than one Sentry SDK. For example, the Unity SDK which includes a .NET layer as well as different native layers. When events come out of the native layer, it's important to distinguish from the stand-alone native SDK. We do that by appending the top SDK to the end of the native SDK name. Examples:
sentry.dotnet.unityon events coming from C#. As based on the spec above.
sentry.java.android.unityon for events of the Java layer on Android
sentry.native.android.unityon for events of the Native layer on Android
sentry.cocoa.unityon for events from iOS/macOS layer
sentry.native.unityon for events coming from
sentry.nativedirectly. Such as on Windows and Linux.
sentry.java.androidon events from the Java layer. Since the Android SDK is based on the Java SDK.
sentry.native.androidon events from NDK. It's
sentry.nativebut it's bundled in the Android SDK with some customization.
- Required. The version of the SDK. It should have the Semantic
MAJOR.MINOR.PATCH, without any prefix (no
vor anything else in front of the major version number). Examples:
- Optional. A list of names identifying enabled integrations. The list should have all enabled integrations, including default integrations. Default integrations are included because different SDK releases may contain different default integrations.
- Optional. A list of packages that were installed as part of this SDK or the
activated integrations. Each package consists of a
namein the format
version. If the source is a Git repository, the source should be
identifiershould be a checkout link and the
versionshould be a Git reference (branch, tag or SHA).
The following example illustrates the SDK part of the event payload and omits other attributes for simplicity.