From 9c26cc28d4ef6712d13319948d0ec26175150be5 Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 9 Feb 2023 09:16:16 -0500 Subject: [PATCH 1/2] sdk.name for hybrid sdks --- src/docs/sdk/event-payloads/sdk.mdx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/docs/sdk/event-payloads/sdk.mdx b/src/docs/sdk/event-payloads/sdk.mdx index 3d2cdefd4d..90ddfe86ba 100644 --- a/src/docs/sdk/event-payloads/sdk.mdx +++ b/src/docs/sdk/event-payloads/sdk.mdx @@ -19,6 +19,24 @@ ecosystem. Official Sentry SDKs use the _entity_ `sentry`. Examples: - `sentry.python` - `sentry.javascript.react-native` +For SDKs that are composed of more than one Sentry SDK. For example, [the Unity SDK](https://github.com/getsentry/sentry-unity/issues/616) +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. Eamples: + +Unity SDK + +- `sentry.dotnet.unity` on events coming from C#. As based on the base spec above. + - `sentry.java.android.unity` on for events of the Java layer on Android + - `sentry.native.android.unity` on for events of the Native layer on Android + - `sentry.cocoa.unity` on for events from iOS/macOS layer + - `sentry.native.unity` on for events coming from `sentry.native` directly. Such as on Windows and Linux. + +Android SDK + +- `sentry.java.android` on events from the Java layer. Since the Android SDK is based on the Java SDK. +- `sentry.native.android` on events from NDK. It's `sentry.native` but it's bundled in the Android SDK with some customization. + `version` : **Required**. The version of the SDK. It should have the [Semantic From b83e07af227de2abfbe260ec909a83be4835d7f8 Mon Sep 17 00:00:00 2001 From: Bruno Garcia Date: Thu, 9 Feb 2023 09:44:19 -0500 Subject: [PATCH 2/2] Apply suggestions from code review --- src/docs/sdk/event-payloads/sdk.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/docs/sdk/event-payloads/sdk.mdx b/src/docs/sdk/event-payloads/sdk.mdx index 90ddfe86ba..c61dbe9a15 100644 --- a/src/docs/sdk/event-payloads/sdk.mdx +++ b/src/docs/sdk/event-payloads/sdk.mdx @@ -22,11 +22,11 @@ ecosystem. Official Sentry SDKs use the _entity_ `sentry`. Examples: For SDKs that are composed of more than one Sentry SDK. For example, [the Unity SDK](https://github.com/getsentry/sentry-unity/issues/616) 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. Eamples: +We do that by appending the top SDK to the end of the native SDK name. Examples: -Unity SDK +Unity SDK: -- `sentry.dotnet.unity` on events coming from C#. As based on the base spec above. +- `sentry.dotnet.unity` on events coming from C#. As based on the spec above. - `sentry.java.android.unity` on for events of the Java layer on Android - `sentry.native.android.unity` on for events of the Native layer on Android - `sentry.cocoa.unity` on for events from iOS/macOS layer