Add OTel resource attributes to the embrace payload envelopes

Author: bidetofevil

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

@@ -109,6 +109,10 @@ class PayloadSourceModuleImpl(
         AppEnvironment(isDebug)
     }
 
+    private val otelResourceAttributes: Map<String, String> by lazy {
+        otelModule.otelSdkConfig.getOTelResourceAttributes()
+    }
+
     override val resourceSource: EnvelopeResourceSource by singleton {
         EmbTrace.trace("resource-source") {
             EnvelopeResourceSourceImpl(
@@ -126,8 +130,10 @@ class PayloadSourceModuleImpl(
                 },
                 rnBundleIdProvider = { rnBundleIdTracker.getReactNativeBundleId() },
                 versionName = BuildConfig.VERSION_NAME,
-                versionCode = BuildConfig.VERSION_CODE.toIntOrNull()
-            )
+                versionCode = BuildConfig.VERSION_CODE.toIntOrNull(),
+            ) {
+                otelResourceAttributes
+            }
         }
     }
 

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

@@ -46,7 +46,9 @@ internal class EnvelopeResourceSourceImplTest {
             "",
             53,
             { "fakeReactNativeBundleId" }
-        )
+        ) {
+            mapOf("resource-attr" to "foo")
+        }
         val envelope = source.getEnvelopeResource()
 
         assertEquals("2.5.1", envelope.appVersion)
@@ -73,5 +75,6 @@ internal class EnvelopeResourceSourceImplTest {
         assertEquals("26", envelope.osCode)
         assertEquals("1920x1080", envelope.screenResolution)
         assertEquals(8, envelope.numCores)
+        assertEquals("foo", envelope.extras["resource-attr"])
     }
 }

embrace-android-envelope/src/main/kotlin/io/embrace/android/embracesdk/internal/envelope/resource/EnvelopeResourceSourceImpl.kt

@@ -4,6 +4,7 @@ import io.embrace.android.embracesdk.internal.capture.metadata.AppEnvironment
 import io.embrace.android.embracesdk.internal.config.ConfigService
 import io.embrace.android.embracesdk.internal.envelope.metadata.HostedSdkVersionInfo
 import io.embrace.android.embracesdk.internal.payload.EnvelopeResource
+import io.embrace.android.embracesdk.internal.utils.Provider
 import java.util.concurrent.ConcurrentHashMap
 
 class EnvelopeResourceSourceImpl(
@@ -14,6 +15,7 @@ class EnvelopeResourceSourceImpl(
     private val versionName: String,
     private val versionCode: Int?,
     private val rnBundleIdProvider: () -> String?,
+    private val otelResourceAttributesSupplier: Provider<Map<String, String>>,
 ) : EnvelopeResourceSource {
 
     private val extras = ConcurrentHashMap<String, String>()
@@ -48,7 +50,7 @@ class EnvelopeResourceSourceImpl(
             osCode = device.systemInfo.androidOsApiLevel,
             screenResolution = device.screenResolution,
             numCores = device.numberOfCores,
-            extras = extras.toMap()
+            extras = extras.toMap() + otelResourceAttributesSupplier()
         )
     }
 

embrace-android-otel/src/main/kotlin/io/embrace/android/embracesdk/internal/otel/config/OtelSdkConfig.kt

@@ -1,6 +1,7 @@
 package io.embrace.android.embracesdk.internal.otel.config
 
 import io.embrace.android.embracesdk.internal.SystemInfo
+import io.embrace.android.embracesdk.internal.otel.impl.EmbMutableAttributeContainer
 import io.embrace.android.embracesdk.internal.otel.logs.DefaultLogRecordExporter
 import io.embrace.android.embracesdk.internal.otel.logs.DefaultLogRecordProcessor
 import io.embrace.android.embracesdk.internal.otel.logs.LogSink
@@ -118,4 +119,10 @@ class OtelSdkConfig(
     fun setResourceAttribute(key: String, value: String) {
         customAttributes[key] = value
     }
+
+    fun getOTelResourceAttributes(): Map<String, String> {
+        val resourceAttrContainer = EmbMutableAttributeContainer()
+        resourceAction(resourceAttrContainer)
+        return resourceAttrContainer.attributes
+    }
 }

embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/EmbraceInternalInterfaceTest.kt

@@ -58,12 +58,11 @@ internal class EmbraceInternalInterfaceTest {
                 }
             },
             assertAction = {
-                val expected = mapOf("foo" to "bar")
                 val sessionResource = checkNotNull(getSingleSessionEnvelope().resource)
-                assertEquals(expected, sessionResource.extras)
+                assertEquals("bar", sessionResource.extras["foo"])
 
                 val logResource = checkNotNull(getSingleLogEnvelope().resource)
-                assertEquals(expected, logResource.extras)
+                assertEquals("bar", logResource.extras["foo"])
             }
         )
     }

embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/session/SessionPayloadTest.kt

@@ -17,8 +17,11 @@ internal class SessionPayloadTest {
     val testRule: SdkIntegrationTestRule = SdkIntegrationTestRule()
 
     @Test
-    fun `device and app attributes are present in session envelope`() {
+    fun `device, app, and otel resource attributes are present in session envelope`() {
         testRule.runTest(
+            preSdkStartAction = {
+                embrace.setResourceAttribute("resource-attr", "foo")
+            },
             testCaseAction = {
                 recordSession()
 
@@ -33,6 +36,7 @@ internal class SessionPayloadTest {
                         assertTrue(checkNotNull(osName).isNotBlank())
                         assertTrue(checkNotNull(deviceModel).isNotBlank())
                         assertEquals(AppFramework.NATIVE, appFramework)
+                        assertEquals("foo", extras["resource-attr"])
                     }
                     assertTrue(getSessionId().isNotBlank())
                 }

embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testframework/assertions/JsonComparator.kt

@@ -20,6 +20,7 @@ internal object JsonComparator {
      */
     fun compare(expected: JSONObject, observed: JSONObject, path: String = ""): List<String> {
         val mismatches = mutableListOf<String>()
+        var findMissingKeys = true
 
         expected.keys().forEach { key ->
             val expectedValue = expected.get(key)
@@ -30,6 +31,7 @@ internal object JsonComparator {
                 else -> "$path.$key"
             }
             if (expectedValue == IGNORE_VALUE) {
+                findMissingKeys = false
                 return@forEach
             }
             if (observedValue == null) {
@@ -39,8 +41,10 @@ internal object JsonComparator {
             compareJsonValue(expectedValue, observedValue, mismatches, currentPath)
         }
 
-        // Check for keys in observed JSON that are not present in expected JSON recursively
-        findMissingExpectedKeys(observed, expected, mismatches)
+        // Check for keys in observed JSON that are not present in expected JSON recursively only if the parent value isn't ignored
+        if (findMissingKeys) {
+            findMissingExpectedKeys(observed, expected, mismatches)
+        }
         return mismatches
     }
 

embrace-android-sdk/src/test/resources/v2_session_expected.json

@@ -33,7 +33,8 @@
     "os_version": "__EMBRACE_TEST_IGNORE__",
     "os_code": "__EMBRACE_TEST_IGNORE__",
     "screen_resolution": "__EMBRACE_TEST_IGNORE__",
-    "num_cores": "__EMBRACE_TEST_IGNORE__"
+    "num_cores": "__EMBRACE_TEST_IGNORE__",
+    "extras": "__EMBRACE_TEST_IGNORE__"
   },
   "type": "spans",
   "version": "0.1.0"