Unify OTel and Embrace envelope resource attributes

Author: bidetofevil

embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/internal/api/OTelApi.kt

@@ -43,8 +43,13 @@ public interface OTelApi {
 
     /**
      * Set an attribute on the resource used by the OTel SDK instance with the given String key and value.
-     * The value set will override any value set previously or by the Embrace SDK.
      * This must be called before the SDK is started in order for it to take effect.
+     *
+     * Resource attributes that the Embrace SDK sets will not be overridden by this call. A configuration parameter is required
+     * for that to happen as a safety mechanism for the inadvertent use of the same resource attributes that the SDK relies on.
+     *
+     * Attributes in the 'emb.' namespace (i.e. prefixed by 'emb.') are reserved for the Embrace SDK and can never be set or
+     * overridden by this method, regardless of the override configuration.
      */
     public fun setResourceAttribute(key: String, value: String)
 }

embrace-android-config-fakes/src/main/kotlin/io/embrace/android/embracesdk/fakes/config/FakeEnabledFeatureConfig.kt

@@ -32,6 +32,7 @@ class FakeEnabledFeatureConfig(
     private val uiLoadTracingTraceAll: Boolean = base.isUiLoadTracingTraceAll(),
     private val endStartupWithAppReady: Boolean = base.isEndStartupWithAppReadyEnabled(),
     private val otelKotlinSdkEnabled: Boolean = base.isOtelKotlinSdkEnabled(),
+    private val resourceAttributeOverride: Boolean = base.isResourceAttributeOverrideEnabled(),
 ) : EnabledFeatureConfig {
 
     override fun isActivityBreadcrumbCaptureEnabled(): Boolean = activityBreadcrumbCapture
@@ -59,4 +60,5 @@ class FakeEnabledFeatureConfig(
     override fun isUiLoadTracingTraceAll(): Boolean = uiLoadTracingTraceAll
     override fun isEndStartupWithAppReadyEnabled(): Boolean = endStartupWithAppReady
     override fun isOtelKotlinSdkEnabled(): Boolean = otelKotlinSdkEnabled
+    override fun isResourceAttributeOverrideEnabled(): Boolean = resourceAttributeOverride
 }

embrace-android-config-fakes/src/main/kotlin/io/embrace/android/embracesdk/fakes/config/FakeInstrumentedConfig.kt

@@ -17,7 +17,12 @@ data class FakeInstrumentedConfig(
     override val enabledFeatures: FakeEnabledFeatureConfig = FakeEnabledFeatureConfig(base.enabledFeatures),
     override val networkCapture: NetworkCaptureConfig = FakeNetworkCaptureConfig(base.networkCapture),
     override val otelLimits: OtelLimitsConfig = FakeOtelLimitsConfig(),
-    override val project: ProjectConfig = FakeProjectConfig(base.project, appId = "abcde"),
+    override val project: ProjectConfig = FakeProjectConfig(
+        base = base.project,
+        appId = "abcde",
+        versionName = "2.5.1",
+        packageName = "com.fake.package",
+    ),
     override val redaction: RedactionConfig = FakeRedactionConfig(base.redaction),
     override val symbols: Base64SharedObjectFilesMap =
         FakeBase64SharedObjectFilesMap(base.symbols.getBase64SharedObjectFilesMap()),

embrace-android-config-fakes/src/main/kotlin/io/embrace/android/embracesdk/fakes/config/FakeProjectConfig.kt

@@ -11,11 +11,13 @@ class FakeProjectConfig(
     private val buildType: String? = base.getBuildType(),
     private val buildFlavor: String? = base.getBuildFlavor(),
     private val packageName: String? = base.getPackageName(),
+    private val versionName: String? = base.getVersionName(),
 ) : ProjectConfig {
     override fun getAppId(): String? = appId
     override fun getAppFramework(): String? = appFramework
     override fun getBuildId(): String? = buildId
     override fun getBuildType(): String? = buildType
     override fun getBuildFlavor(): String? = buildFlavor
     override fun getPackageName(): String? = packageName
+    override fun getVersionName(): String? = versionName
 }

embrace-android-config/src/main/kotlin/io/embrace/android/embracesdk/internal/config/behavior/OtelBehavior.kt

@@ -10,4 +10,9 @@ interface OtelBehavior {
      * Returns true if the Kotlin SDK should be used, false if it was disabled via remote config.
      */
     fun shouldUseKotlinSdk(): Boolean
+
+    /**
+     * Whether resource attributes that the Embrace SDK sets itself can be overridden. Defaults to false.
+     */
+    fun isResourceAttributeOverrideEnabled(): Boolean
 }

embrace-android-config/src/main/kotlin/io/embrace/android/embracesdk/internal/config/behavior/OtelBehaviorImpl.kt

@@ -18,4 +18,6 @@ class OtelBehaviorImpl(
     override fun shouldUseKotlinSdk(): Boolean {
         return thresholdCheck.isBehaviorEnabled(remote?.pctEnabled) ?: local.isOtelKotlinSdkEnabled()
     }
+
+    override fun isResourceAttributeOverrideEnabled(): Boolean = local.isResourceAttributeOverrideEnabled()
 }

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/metadata/EmbraceMetadataService.kt

@@ -15,6 +15,9 @@ import io.embrace.android.embracesdk.internal.config.ConfigService
 import io.embrace.android.embracesdk.internal.envelope.resource.EnvelopeResourceSource
 import io.embrace.android.embracesdk.internal.store.KeyValueStore
 import io.embrace.android.embracesdk.internal.worker.BackgroundWorker
+import io.opentelemetry.kotlin.semconv.OsAttributes
+import io.opentelemetry.kotlin.semconv.ServiceAttributes
+import kotlinx.serialization.json.contentOrNull
 
 /**
  * Provides information about the state of the device, retrieved from Android system services,
@@ -53,8 +56,8 @@ internal class EmbraceMetadataService(
      */
     override fun precomputeValues() {
         metadataBackgroundWorker.submit {
-            appVersion = res.appVersion
-            osVersion = res.osVersion
+            appVersion = res.attributes[ServiceAttributes.SERVICE_VERSION]?.contentOrNull
+            osVersion = res.attributes[OsAttributes.OS_VERSION]?.contentOrNull
             val free = statFs.freeBytes
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O && configService.autoDataCaptureBehavior.isDiskUsageCaptureEnabled()) {
                 val deviceDiskAppUsage = getDeviceDiskAppUsage(

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/injection/OpenTelemetryModuleImpl.kt

@@ -58,6 +58,7 @@ class OpenTelemetryModuleImpl(
             sessionIdsProvider = { storedSessionIdsProvider },
             userIdProvider = { storedUserIdProvider?.invoke() },
             processIdentifierProvider = processIdentifierProvider,
+            resourceAttributeOverrideEnabled = { otelBehavior?.isResourceAttributeOverrideEnabled() ?: false },
         )
     }
 

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/injection/PayloadSourceModuleImpl.kt

@@ -125,8 +125,8 @@ class PayloadSourceModuleImpl(
                     )
                 },
                 rnBundleIdProvider = { rnBundleIdTracker.getReactNativeBundleId() },
-                versionName = BuildConfig.VERSION_NAME,
                 versionCode = BuildConfig.VERSION_CODE.toIntOrNull(),
+                otelResourceAttributesProvider = { otelModule.otelSdkConfig.getResourceAttributes() },
             )
         }
     }

embrace-android-core/src/test/kotlin/io/embrace/android/embracesdk/internal/envelope/resource/EnvelopeResourceSourceImplTest.kt

@@ -1,77 +1,65 @@
 package io.embrace.android.embracesdk.internal.envelope.resource
 
-import android.os.Environment
 import io.embrace.android.embracesdk.fakes.FakeConfigService
 import io.embrace.android.embracesdk.fakes.FakeDevice
-import io.embrace.android.embracesdk.fakes.FakeKeyValueStore
+import io.embrace.android.embracesdk.fakes.FakeHostedSdkVersionInfo
 import io.embrace.android.embracesdk.internal.capture.metadata.AppEnvironment
-import io.embrace.android.embracesdk.internal.envelope.metadata.UnitySdkVersionInfo
-import io.embrace.android.embracesdk.internal.payload.AppFramework
-import io.mockk.every
-import io.mockk.mockkStatic
-import io.mockk.unmockkAll
-import org.junit.After
+import io.opentelemetry.kotlin.semconv.ServiceAttributes
 import org.junit.Assert.assertEquals
-import org.junit.BeforeClass
+import org.junit.Assert.assertFalse
 import org.junit.Test
-import java.io.File
 
 internal class EnvelopeResourceSourceImplTest {
 
-    companion object {
-        @BeforeClass
-        @JvmStatic
-        fun beforeClass() {
-            mockkStatic(Environment::class)
-            every { Environment.getDataDirectory() }.returns(File("ANDROID_DATA"))
-        }
+    @Test
+    fun `getEnvelopeResource merges the OTel resource with Embrace internal attributes`() {
+        val source = createSource(
+            otelResourceAttributes = mapOf(
+                ServiceAttributes.SERVICE_VERSION to "2.5.1",
+                "my.custom.one" to "1",
+                "build_id" to "should-be-ignored",
+            ),
+        )
+        val attrs = source.getEnvelopeResource().attributes
 
-        @After
-        fun tearDown() {
-            unmockkAll()
-        }
+        assertEquals("2.5.1", attrs.getValue(ServiceAttributes.SERVICE_VERSION).content)
+        assertEquals("1", attrs.getValue("my.custom.one").content)
+        assertEquals("fakeBuildId", attrs.getValue("build_id").content)
+        assertEquals("prod", attrs.getValue("emb.app.environment").content)
+
+        // legacy bespoke keys are gone, replaced by their canonical semconv keys
+        assertFalse(attrs.containsKey("app_version"))
+        assertFalse(attrs.containsKey("app_ecosystem_id"))
+        assertFalse(attrs.containsKey("environment"))
+        assertFalse(attrs.containsKey("sdk_version"))
+        assertFalse(attrs.containsKey("device_manufacturer"))
+        assertFalse(attrs.containsKey("device_model"))
     }
 
     @Test
-    fun getEnvelopeResource() {
-        val hostedSdkVersionInfo = UnitySdkVersionInfo(FakeKeyValueStore())
-        hostedSdkVersionInfo.hostedSdkVersion = "1.2.0"
-        hostedSdkVersionInfo.hostedPlatformVersion = "19"
-        hostedSdkVersionInfo.unityBuildIdNumber = "5092abc"
-        val source = EnvelopeResourceSourceImpl(
-            FakeConfigService(),
-            hostedSdkVersionInfo,
-            AppEnvironment.Environment.PROD,
-            FakeDevice(),
-            "",
-            53,
-            { "fakeReactNativeBundleId" },
-        )
-        val envelope = source.getEnvelopeResource()
+    fun `internal attributes added via add() are not overridable by customer attributes`() {
+        val source = createSource(
+            otelResourceAttributes = mapOf(
+                "my.internal.key" to "customer-value",
+                "other.custom" to "keep",
+            ),
+        ).apply {
+            add("my.internal.key", "embrace-value")
+        }
+        val attrs = source.getEnvelopeResource().attributes
 
-        assertEquals("2.5.1", envelope.appVersion)
-        assertEquals(AppFramework.NATIVE, envelope.appFramework)
-        assertEquals("com.fake.package", envelope.appEcosystemId)
-        assertEquals("fakeBuildId", envelope.buildId)
-        assertEquals("fakeBuildType", envelope.buildType)
-        assertEquals("fakeBuildFlavor", envelope.buildFlavor)
-        assertEquals("prod", envelope.environment)
-        assertEquals("99", envelope.bundleVersion)
-        assertEquals(53, envelope.sdkSimpleVersion)
-        assertEquals("fakeReactNativeBundleId", envelope.reactNativeBundleId)
-        assertEquals("1.2.0", envelope.hostedSdkVersion)
-        assertEquals("19", envelope.hostedPlatformVersion)
-        assertEquals("5092abc", envelope.unityBuildId)
-        assertEquals("Samsung", envelope.deviceManufacturer)
-        assertEquals("Galaxy S10", envelope.deviceModel)
-        assertEquals("arm64-v8a", envelope.deviceArchitecture)
-        assertEquals(false, envelope.jailbroken)
-        assertEquals(10000000L, envelope.diskTotalCapacity)
-        assertEquals("linux", envelope.osType)
-        assertEquals("android", envelope.osName)
-        assertEquals("8.0.0", envelope.osVersion)
-        assertEquals("26", envelope.osCode)
-        assertEquals("1920x1080", envelope.screenResolution)
-        assertEquals(8, envelope.numCores)
+        assertEquals("embrace-value", attrs.getValue("my.internal.key").content)
+        assertEquals("keep", attrs.getValue("other.custom").content)
     }
+
+    private fun createSource(otelResourceAttributes: Map<String, String>) =
+        EnvelopeResourceSourceImpl(
+            configService = FakeConfigService(),
+            hosted = FakeHostedSdkVersionInfo(),
+            environment = AppEnvironment.Environment.PROD,
+            device = FakeDevice(),
+            versionCode = 53,
+            rnBundleIdProvider = { null },
+            otelResourceAttributesProvider = { otelResourceAttributes },
+        )
 }