Use app.screen.name and allow opt-in for older semconv (#1819)

* set up config and helper to map to old semconv

* use `app.screen.name` over `screen.name` with compat flag.

* add test

* wire up to DSL

* wire up to DSL

* use method

Author: breedx-splk

android-agent/api/android-agent.api

@@ -69,10 +69,17 @@ public final class io/opentelemetry/android/agent/dsl/OpenTelemetryConfiguration
 	public final fun httpExport (Lkotlin/jvm/functions/Function1;)V
 	public final fun instrumentations (Lkotlin/jvm/functions/Function1;)V
 	public final fun resource (Lkotlin/jvm/functions/Function1;)V
+	public final fun semanticConventions (Lkotlin/jvm/functions/Function1;)V
 	public final fun session (Lkotlin/jvm/functions/Function1;)V
 	public final fun setClock (Lio/opentelemetry/sdk/common/Clock;)V
 }
 
+public final class io/opentelemetry/android/agent/dsl/SemanticConventionsConfiguration {
+	public fun <init> ()V
+	public final fun getUseLatestExperimental ()Z
+	public final fun setUseLatestExperimental (Z)V
+}
+
 public final class io/opentelemetry/android/agent/dsl/SessionConfiguration {
 	public final fun getBackgroundInactivityTimeout-UwyO8pc ()J
 	public final fun getMaxLifetime-UwyO8pc ()J

android-agent/src/main/kotlin/io/opentelemetry/android/agent/dsl/OpenTelemetryConfiguration.kt

@@ -31,6 +31,8 @@ class OpenTelemetryConfiguration internal constructor(
     internal val exportConfig = HttpExportConfiguration()
     internal val sessionConfig = SessionConfiguration()
     internal val instrumentations = InstrumentationConfiguration(rumConfig, instrumentationLoader)
+
+    internal val semanticConventions = SemanticConventionsConfiguration()
     internal var resourceAction: ResourceBuilder.() -> Unit = {}
 
     /**
@@ -68,6 +70,13 @@ class OpenTelemetryConfiguration internal constructor(
         instrumentations.action()
     }
 
+    /**
+     * Configures semantic conventions.
+     */
+    fun semanticConventions(action: SemanticConventionsConfiguration.() -> Unit) {
+        semanticConventions.action()
+    }
+
     /**
      * Configures session behavior.
      */

android-agent/src/main/kotlin/io/opentelemetry/android/agent/dsl/SemanticConventionsConfiguration.kt

@@ -0,0 +1,26 @@
+package io.opentelemetry.android.agent.dsl
+
+import io.opentelemetry.android.common.internal.SemconvCompat
+
+/**
+ * Type-safe DSL configuration of semantic conventions behaviors.
+ */
+@OpenTelemetryDslMarker
+class SemanticConventionsConfiguration {
+
+    /**
+     * Determines if the latest available experimental semantic conventions should
+     * be used. If set to false, the old, deprecated, or nonstandard semantic convention
+     * names will continue to be used.
+     *
+     * This provides a compatibility path forward for users who need to continue using
+     * existing values until the next major version bump. This setting does NOT
+     * imply that only _stable_ semantic conventions are emitted.
+     */
+    var useLatestExperimental: Boolean = true
+        set(value){
+            field = value
+            SemconvCompat.useLatestExperimental = value
+        }
+
+}

android-agent/src/test/kotlin/io/opentelemetry/android/agent/dsl/SemanticConventionsConfigurationTest.kt

@@ -0,0 +1,59 @@
+package io.opentelemetry.android.agent.dsl
+
+import io.mockk.every
+import io.mockk.mockk
+import io.opentelemetry.android.agent.FakeClock
+import io.opentelemetry.android.agent.FakeInstrumentationLoader
+import io.opentelemetry.android.common.internal.SemconvCompat
+import io.opentelemetry.android.config.OtelRumConfig
+import io.opentelemetry.android.features.diskbuffering.DiskBufferingConfig
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+
+class SemanticConventionsConfigurationTest {
+
+    var compatState: Boolean = true
+
+    @BeforeEach
+    fun setup(){
+        compatState = SemconvCompat.useLatestExperimental
+    }
+
+    @AfterEach
+    fun restore(){
+        SemconvCompat.useLatestExperimental = compatState
+    }
+
+    @Test
+    fun `defaults to true`(){
+        val rumConfig = mockk<OtelRumConfig>()
+        every { rumConfig.setDiskBufferingConfig(any<DiskBufferingConfig>()) } returns rumConfig
+        every { rumConfig.suppressInstrumentation(any<String>()) } returns rumConfig
+        val otelConfig = OpenTelemetryConfiguration(
+            rumConfig = rumConfig,
+            instrumentationLoader = FakeInstrumentationLoader(),
+            clock = FakeClock()
+        )
+        assertThat(otelConfig.semanticConventions.useLatestExperimental).isTrue
+        assertThat(SemconvCompat.useLatestExperimental).isTrue
+    }
+
+    @Test
+    fun `can disable latest experimental semconv`(){
+        val rumConfig = mockk<OtelRumConfig>()
+        every { rumConfig.setDiskBufferingConfig(any<DiskBufferingConfig>()) } returns rumConfig
+        every { rumConfig.suppressInstrumentation(any<String>()) } returns rumConfig
+        val otelConfig = OpenTelemetryConfiguration(
+            rumConfig = rumConfig,
+            instrumentationLoader = FakeInstrumentationLoader(),
+            clock = FakeClock()
+        )
+        otelConfig.semanticConventions {
+            useLatestExperimental = false
+        }
+        assertThat(SemconvCompat.useLatestExperimental).isFalse
+    }
+
+}

common/api/common.api

@@ -2,7 +2,16 @@ public final class io/opentelemetry/android/common/RumConstants {
 	public static final field INSTANCE Lio/opentelemetry/android/common/RumConstants;
 	public static final field LAST_SCREEN_NAME_KEY Lio/opentelemetry/api/common/AttributeKey;
 	public static final field OTEL_RUM_LOG_TAG Ljava/lang/String;
-	public static final field SCREEN_NAME_KEY Lio/opentelemetry/api/common/AttributeKey;
+}
+
+public final class io/opentelemetry/android/common/internal/SemconvCompat {
+	public static final field Companion Lio/opentelemetry/android/common/internal/SemconvCompat$Companion;
+}
+
+public final class io/opentelemetry/android/common/internal/SemconvCompat$Companion {
+	public final fun getUseLatestExperimental ()Z
+	public final fun map (Ljava/lang/String;)Ljava/lang/String;
+	public final fun setUseLatestExperimental (Z)V
 }
 
 public final class io/opentelemetry/android/common/internal/features/networkattributes/CurrentNetworkAttributesExtractor {

common/src/main/java/io/opentelemetry/android/common/RumConstants.kt

@@ -12,7 +12,4 @@ object RumConstants {
 
     @JvmField
     val LAST_SCREEN_NAME_KEY: AttributeKey<String> = AttributeKey.stringKey("last.screen.name")
-
-    @JvmField
-    val SCREEN_NAME_KEY: AttributeKey<String> = AttributeKey.stringKey("screen.name")
 }

common/src/main/java/io/opentelemetry/android/common/internal/SemconvCompat.kt

@@ -0,0 +1,31 @@
+package io.opentelemetry.android.common.internal
+
+import io.opentelemetry.kotlin.semconv.AppAttributes
+import io.opentelemetry.kotlin.semconv.IncubatingApi
+
+/**
+ * Internal class used to map the latest/experimental semantic conventions
+ * to a previous value. This class is subject to change at any time, and external
+ * users are highly discouraged from using it.
+ */
+@OptIn(IncubatingApi::class)
+class SemconvCompat internal constructor() {
+
+    companion object {
+
+        var useLatestExperimental = true
+
+        fun map(key: String) : String {
+            if(useLatestExperimental){
+                return key
+            }
+            return when(key) {
+                // new -> old
+                "app.crash" -> "device.crash"
+                AppAttributes.APP_SCREEN_NAME  -> "screen.name"
+                else -> key
+            }
+        }
+
+    }
+}

common/src/test/java/io/opentelemetry/android/common/internal/SemconvCompatTest.kt

@@ -0,0 +1,37 @@
+package io.opentelemetry.android.common.internal
+
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.Test
+
+class SemconvCompatTest {
+
+    var compatState: Boolean = true
+
+    @AfterEach
+    fun setup() {
+        compatState = SemconvCompat.useLatestExperimental
+    }
+
+    @AfterEach
+    fun restore() {
+        SemconvCompat.useLatestExperimental = compatState
+    }
+
+    @Test
+    fun `test compat with legacy`() {
+        SemconvCompat.useLatestExperimental = false
+        assertThat(SemconvCompat.map("app.screen.name")).isEqualTo("screen.name")
+        assertThat(SemconvCompat.map("app.crash")).isEqualTo("device.crash")
+        assertThat(SemconvCompat.map("rando.semconv.thinger")).isEqualTo("rando.semconv.thinger")
+    }
+
+    @Test
+    fun `test compat with latest experimental`() {
+        SemconvCompat.useLatestExperimental = true
+        assertThat(SemconvCompat.map("app.screen.name")).isEqualTo("app.screen.name")
+        assertThat(SemconvCompat.map("app.crash")).isEqualTo("app.crash")
+        assertThat(SemconvCompat.map("rando.semconv.thinger")).isEqualTo("rando.semconv.thinger")
+    }
+
+}

core/src/main/java/io/opentelemetry/android/ScreenAttributesSpanProcessor.kt

@@ -5,9 +5,12 @@
 
 package io.opentelemetry.android
 
-import io.opentelemetry.android.common.RumConstants
+import io.opentelemetry.android.common.internal.SemconvCompat.Companion.map
 import io.opentelemetry.android.internal.services.visiblescreen.VisibleScreenTracker
+import io.opentelemetry.api.common.AttributeKey.stringKey
 import io.opentelemetry.context.Context
+import io.opentelemetry.kotlin.semconv.AppAttributes.APP_SCREEN_NAME
+import io.opentelemetry.kotlin.semconv.IncubatingApi
 import io.opentelemetry.sdk.trace.ReadWriteSpan
 import io.opentelemetry.sdk.trace.ReadableSpan
 import io.opentelemetry.sdk.trace.SpanProcessor
@@ -18,12 +21,13 @@ import io.opentelemetry.sdk.trace.SpanProcessor
 internal class ScreenAttributesSpanProcessor(
     private val visibleScreenTracker: VisibleScreenTracker,
 ) : SpanProcessor {
+    @OptIn(IncubatingApi::class)
     override fun onStart(
         parentContext: Context,
         span: ReadWriteSpan,
     ) {
         val currentScreen = visibleScreenTracker.currentlyVisibleScreen
-        span.setAttribute(RumConstants.SCREEN_NAME_KEY, currentScreen)
+        span.setAttribute(stringKey(map(APP_SCREEN_NAME)), currentScreen)
     }
 
     override fun isStartRequired(): Boolean = true

core/src/main/java/io/opentelemetry/android/internal/processors/ScreenAttributesLogRecordProcessor.kt

@@ -5,20 +5,24 @@
 
 package io.opentelemetry.android.internal.processors
 
-import io.opentelemetry.android.common.RumConstants
+import io.opentelemetry.android.common.internal.SemconvCompat.Companion.map
 import io.opentelemetry.android.internal.services.visiblescreen.VisibleScreenTracker
+import io.opentelemetry.api.common.AttributeKey.stringKey
 import io.opentelemetry.context.Context
+import io.opentelemetry.kotlin.semconv.AppAttributes.APP_SCREEN_NAME
+import io.opentelemetry.kotlin.semconv.IncubatingApi
 import io.opentelemetry.sdk.logs.LogRecordProcessor
 import io.opentelemetry.sdk.logs.ReadWriteLogRecord
 
 class ScreenAttributesLogRecordProcessor(
     val visibleScreenTracker: VisibleScreenTracker,
 ) : LogRecordProcessor {
+    @OptIn(IncubatingApi::class)
     override fun onEmit(
         context: Context,
         logRecord: ReadWriteLogRecord,
     ) {
         val currentScreen = visibleScreenTracker.currentlyVisibleScreen
-        logRecord.setAttribute(RumConstants.SCREEN_NAME_KEY, currentScreen)
+        logRecord.setAttribute(stringKey(map(APP_SCREEN_NAME)), currentScreen)
     }
 }