Merge branch 'main' into integration/kotlin-otel-api

Author: fractalwrench

.github/workflows/release-workflow.yml

@@ -24,6 +24,16 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 60
     steps:
+      - name: Validate access to version data service
+        uses: embrace-io/public-actions/upload-sdk-version@f4229398f257b24dbbe8b873f78e719f9af6cbbb
+        with:
+          platform: 'android'
+          version: ${{ inputs.rc_version }}
+          dryRun: true
+          uploadUrl: ${{ vars.SDK_VERSION_URL }}
+        env:
+          SDK_VERSION_TOKEN: ${{ secrets.SDK_VERSION_TOKEN }}
+
       - name: Checkout SDK
         uses: actions/checkout@v4
         with:
@@ -43,6 +53,16 @@ jobs:
         run: |
           ./gradlew findSonatypeStagingRepository releaseSonatypeStagingRepository -Dorg.gradle.parallel=false --no-build-cache --no-configuration-cache --stacktrace
 
+      - name: Record SDK Version History
+        uses: embrace-io/public-actions/upload-sdk-version@f4229398f257b24dbbe8b873f78e719f9af6cbbb
+        with:
+          platform: 'android'
+          version: ${{ inputs.rc_version }}
+          dryRun: false
+          uploadUrl: ${{ vars.SDK_VERSION_URL }}
+        env:
+          SDK_VERSION_TOKEN: ${{ secrets.SDK_VERSION_TOKEN }}
+
   publish-api-docs:
     name: Publish API Docs to GitHub Pages
     uses: ./.github/workflows/publish-api-docs.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Embrace Android SDK Changelog
 
+## 7.5.0
+*June 9, 2025*
+
+- New configuration option to start the SDK automatically (default off)
+- Link Spans with Sessions in which they ended via Span Links
+- Bypass instrumentation-time restrictions for Spans and Embrace Logs for non-Embrace Users
+- Use `BuildFeatures` API for Gradle 8.5+ instead of a deprecated feature to be removed in Gradle 10
+
 ## 7.4.0
 *May 5, 2025*
 

build.gradle.kts

@@ -19,7 +19,7 @@ nexusPublishing {
         sonatype {
             username = System.getenv("SONATYPE_USERNAME")
             password = System.getenv("SONATYPE_PASSWORD")
-            nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
+            nexusUrl.set(uri("https://ossrh-staging-api.central.sonatype.com/service/local/"))
         }
     }
     transitionCheckOptions {

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

@@ -26,11 +26,6 @@ interface OpenTelemetryModule {
      */
     val otelSdkConfig: OtelSdkConfig
 
-    /**
-     * Setup configuration for redacting sensitive keys
-     */
-    fun setupSensitiveKeysBehavior(sensitiveKeysBehavior: SensitiveKeysBehavior)
-
     /**
      * Caches span instances that are in progress or completed in the current session
      */
@@ -92,4 +87,12 @@ interface OpenTelemetryModule {
      * OpenTelemetry SDK compatible clock based on the internal Embrace clock instance
      */
     val openTelemetryClock: io.opentelemetry.sdk.common.Clock
+
+    /**
+     * Setup configuration configuration-dependent behavior
+     */
+    fun applyConfiguration(
+        sensitiveKeysBehavior: SensitiveKeysBehavior,
+        bypassValidation: Boolean,
+    )
 }

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

@@ -9,6 +9,7 @@ import io.embrace.android.embracesdk.internal.otel.impl.EmbOpenTelemetry
 import io.embrace.android.embracesdk.internal.otel.impl.EmbTracerProvider
 import io.embrace.android.embracesdk.internal.otel.logs.LogSink
 import io.embrace.android.embracesdk.internal.otel.logs.LogSinkImpl
+import io.embrace.android.embracesdk.internal.otel.sdk.DataValidator
 import io.embrace.android.embracesdk.internal.otel.sdk.OtelSdkWrapper
 import io.embrace.android.embracesdk.internal.otel.spans.EmbraceSpanFactory
 import io.embrace.android.embracesdk.internal.otel.spans.EmbraceSpanFactoryImpl
@@ -80,17 +81,23 @@ internal class OpenTelemetryModuleImpl(
 
     private var sensitiveKeysBehavior: SensitiveKeysBehavior? = null
 
-    override fun setupSensitiveKeysBehavior(sensitiveKeysBehavior: SensitiveKeysBehavior) {
+    override fun applyConfiguration(sensitiveKeysBehavior: SensitiveKeysBehavior, bypassValidation: Boolean) {
         this.sensitiveKeysBehavior = sensitiveKeysBehavior
+        this.bypassLimitsValidation = bypassValidation
     }
 
     private var internalSpanStopCallback: ((spanId: String) -> Unit)? = null
 
+    private var bypassLimitsValidation: Boolean = false
+
+    private val dataValidator: DataValidator = DataValidator(bypassValidation = ::bypassLimitsValidation)
+
     private val embraceSpanFactory: EmbraceSpanFactory by singleton {
         EmbraceSpanFactoryImpl(
             tracer = sdkTracer,
             openTelemetryClock = openTelemetryClock,
             spanRepository = spanRepository,
+            dataValidator = dataValidator,
             stopCallback = ::spanStopCallbackWrapper,
             redactionFunction = ::redactionFunction
         )
@@ -113,6 +120,7 @@ internal class OpenTelemetryModuleImpl(
             spanRepository = spanRepository,
             canStartNewSpan = currentSessionSpan::canStartNewSpan,
             initCallback = currentSessionSpan::initializeService,
+            dataValidator = dataValidator
         ) { embraceSpanFactory }
     }
 

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/logs/EmbraceLogService.kt

@@ -16,7 +16,7 @@ import io.embrace.android.embracesdk.internal.otel.attrs.embExceptionHandling
 import io.embrace.android.embracesdk.internal.payload.AppFramework
 import io.embrace.android.embracesdk.internal.payload.Envelope
 import io.embrace.android.embracesdk.internal.session.orchestrator.PayloadStore
-import io.embrace.android.embracesdk.internal.utils.PropertyUtils.normalizeProperties
+import io.embrace.android.embracesdk.internal.utils.PropertyUtils.sanitizeProperties
 import io.embrace.android.embracesdk.internal.utils.Uuid
 import io.opentelemetry.semconv.incubating.LogIncubatingAttributes
 
@@ -31,6 +31,7 @@ class EmbraceLogService(
 ) : LogService {
 
     private val behavior = configService.logMessageBehavior
+    private val bypassLimitsValidation = configService.isOnlyUsingOtelExporters()
     private val logCounters = mapOf(
         Severity.INFO to LogCounter(behavior::getInfoLogLimit),
         Severity.WARNING to LogCounter(behavior::getWarnLogLimit),
@@ -45,7 +46,7 @@ class EmbraceLogService(
         customLogAttrs: Map<String, String>,
         logAttachment: Attachment.EmbraceHosted?,
     ) {
-        val redactedProperties = redactSensitiveProperties(normalizeProperties(properties))
+        val redactedProperties = redactSensitiveProperties(sanitizeProperties(properties, bypassLimitsValidation))
         val attrs = createTelemetryAttributes(redactedProperties, customLogAttrs)
 
         val schemaProvider: (TelemetryAttributes) -> SchemaType = when {

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/utils/PropertyUtils.kt

@@ -10,42 +10,21 @@ object PropertyUtils {
 
     const val MAX_PROPERTY_SIZE: Int = 10
 
-    /**
-     * This method will normalize the map by applying the following rules:
-     *
-     * - Null key registries will be discarded.
-     * - Null value registries will be renamed to null as a String.
-     * - Cap the properties map to a maximum of [PropertyUtils.MAX_PROPERTY_SIZE] properties.
-     *
-     * @param properties properties to be normalized.
-     * @return a normalized Map of the provided properties.
-     */
-    @JvmStatic
-    fun sanitizeProperties(properties: Map<String, Any?>?): Map<String, Any> {
-        properties ?: return emptyMap()
-
-        return properties.entries
-            .take(MAX_PROPERTY_SIZE)
-            .associate { Pair(it.key, checkIfSerializable(it.value)) }
-    }
-
-    @JvmStatic
-    fun normalizeProperties(properties: Map<String, Any>?): Map<String, Any>? {
-        var normalizedProperties: Map<String, Any> = HashMap()
-        if (properties != null) {
-            runCatching {
-                normalizedProperties = sanitizeProperties(properties)
-            }
-            return normalizedProperties
+    fun sanitizeProperties(properties: Map<String, Any>?, bypassPropertyLimit: Boolean = false): Map<String, Any> {
+        return if (properties == null) {
+            emptyMap()
         } else {
-            return null
+            runCatching {
+                if (bypassPropertyLimit) {
+                    properties.entries
+                } else {
+                    properties.entries.take(MAX_PROPERTY_SIZE)
+                }.associate { Pair(it.key, checkIfSerializable(it.value)) }
+            }.getOrDefault(emptyMap())
         }
     }
 
-    private fun checkIfSerializable(value: Any?): Any {
-        if (value == null) {
-            return "null"
-        }
+    private fun checkIfSerializable(value: Any): Any {
         if (!(value is Parcelable || value is Serializable)) {
             return "not serializable"
         }

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/capture/session/EmbraceSessionPropertiesTest.kt

@@ -150,7 +150,11 @@ internal class EmbraceSessionPropertiesTest {
         }
         assertFalse(
             "should not be able to add new key when limit is hit",
-            sessionProperties.add("propNew", VALUE_VALID, true)
+            sessionProperties.add("propPermNew", VALUE_VALID, true)
+        )
+        assertFalse(
+            "should not be able to add new key when limit is hit",
+            sessionProperties.add("propTempNew", VALUE_VALID, false)
         )
         val otherValue = "other"
         assertTrue(
@@ -180,7 +184,11 @@ internal class EmbraceSessionPropertiesTest {
         }
         assertFalse(
             "should not be able to add new key when limit is hit",
-            sessionProperties.add("propNew", VALUE_VALID, true)
+            sessionProperties.add("propPermNew", VALUE_VALID, true)
+        )
+        assertFalse(
+            "should not be able to add new key when limit is hit",
+            sessionProperties.add("propTempNew", VALUE_VALID, false)
         )
         val otherValue = "other"
         assertTrue(

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/utils/PropertiesTest.kt

@@ -2,6 +2,8 @@ package io.embrace.android.embracesdk.internal.utils
 
 import io.embrace.android.embracesdk.internal.utils.PropertyUtils.sanitizeProperties
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertTrue
 import org.junit.Test
 
 internal class PropertyUtilsTest {
@@ -19,11 +21,6 @@ internal class PropertyUtilsTest {
         assertEquals(expected, sanitizeProperties(input as Map<String, Any>?))
     }
 
-    @Test
-    fun testNullValue() {
-        assertEquals("null", sanitizeProperties(mapOf("a" to null))["a"])
-    }
-
     @Test
     fun testSerializableValue() {
         val obj = SerializableClass()
@@ -35,6 +32,41 @@ internal class PropertyUtilsTest {
         assertEquals("not serializable", sanitizeProperties(mapOf("a" to UnSerializableClass()))["a"])
     }
 
+    @Test
+    fun `bypass limits`() {
+        val input = (0..20).associateBy { "$it" }
+        assertEquals(input.size, sanitizeProperties(input, true).size)
+    }
+
+    @Test
+    fun testPropertiesNormalization() {
+        val sourceMap: MutableMap<String, Any> = HashMap()
+        sourceMap[""] = "Empty key"
+        sourceMap["EmptyValue"] = ""
+        sourceMap["NullValue"] = ""
+        for (i in 1..9) {
+            sourceMap["Key$i"] = "Value$i"
+        }
+        val resultMap = sanitizeProperties(sourceMap)
+        assertTrue(
+            "Unexpected normalized map size.",
+            resultMap.size <= PropertyUtils.MAX_PROPERTY_SIZE
+        )
+        resultMap.entries.stream()
+            .peek { (key): Map.Entry<String, Any> ->
+                assertNotNull(
+                    "Unexpected normalized map key: NULL.",
+                    key
+                )
+            }
+            .peek { (_, value): Map.Entry<String, Any> ->
+                assertNotNull(
+                    "Unexpected normalized map value: NULL.",
+                    value
+                )
+            }
+    }
+
     private class SerializableClass : java.io.Serializable
     private class UnSerializableClass
 }