Instrumentation api ehnancement (#1645)

* AndroidInstrumentation changes

* Clean up

* Clean up session id getter

* Enhancing rum init

* Rebase from main

Author: LikeTheSalad

agent-api/api/agent-api.api

@@ -1,8 +1,9 @@
 public abstract interface class io/opentelemetry/android/OpenTelemetryRum {
 	public abstract fun emitEvent (Ljava/lang/String;Ljava/lang/String;Lio/opentelemetry/api/common/Attributes;)V
 	public static synthetic fun emitEvent$default (Lio/opentelemetry/android/OpenTelemetryRum;Ljava/lang/String;Ljava/lang/String;Lio/opentelemetry/api/common/Attributes;ILjava/lang/Object;)V
+	public abstract fun getClock ()Lio/opentelemetry/sdk/common/Clock;
 	public abstract fun getOpenTelemetry ()Lio/opentelemetry/api/OpenTelemetry;
-	public abstract fun getRumSessionId ()Ljava/lang/String;
+	public abstract fun getSessionProvider ()Lio/opentelemetry/android/session/SessionProvider;
 	public abstract fun shutdown ()V
 }
 

agent-api/build.gradle.kts

@@ -15,5 +15,6 @@ android {
 
 dependencies {
     api(platform(libs.opentelemetry.platform.alpha))
-    api(libs.opentelemetry.api)
+    api(libs.opentelemetry.sdk)
+    api(project(":session"))
 }

agent-api/src/main/java/io/opentelemetry/android/OpenTelemetryRum.kt

@@ -5,8 +5,10 @@
 
 package io.opentelemetry.android
 
+import io.opentelemetry.android.session.SessionProvider
 import io.opentelemetry.api.OpenTelemetry
 import io.opentelemetry.api.common.Attributes
+import io.opentelemetry.sdk.common.Clock
 
 /**
  * Entrypoint for the OpenTelemetry Real User Monitoring library for Android.
@@ -19,11 +21,14 @@ interface OpenTelemetryRum {
     val openTelemetry: OpenTelemetry
 
     /**
-     * Get the client session ID associated with this instance of the RUM instrumentation library.
-     * Note: this value will change throughout the lifetime of an application instance, so it is
-     * recommended that you do not cache this value, but always retrieve it from here when needed.
+     * Get the [SessionProvider] associated with this instance.
      */
-    fun getRumSessionId(): String
+    val sessionProvider: SessionProvider
+
+    /**
+     * Get the [Clock] used by this instance for time-related operations.
+     */
+    val clock: Clock
 
     /**
      * Emits an event with the specified name, body, and attributes.

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

@@ -5,17 +5,15 @@
 
 package io.opentelemetry.android
 
+import io.opentelemetry.android.session.SessionProvider
 import io.opentelemetry.api.OpenTelemetry
 import io.opentelemetry.api.common.Attributes
-import io.opentelemetry.api.trace.TraceId
+import io.opentelemetry.sdk.common.Clock
 
 internal object NoopOpenTelemetryRum : OpenTelemetryRum {
     override val openTelemetry: OpenTelemetry = OpenTelemetry.noop()
-
-    override fun getRumSessionId(): String {
-        // RUM session.id has the same format as traceId
-        return TraceId.getInvalid()
-    }
+    override val sessionProvider: SessionProvider = SessionProvider.getNoop()
+    override val clock: Clock = Clock.getDefault()
 
     override fun emitEvent(
         eventName: String,

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

@@ -10,21 +10,21 @@ import io.opentelemetry.api.OpenTelemetry
 import io.opentelemetry.api.common.Attributes
 import io.opentelemetry.api.logs.Logger
 import io.opentelemetry.sdk.OpenTelemetrySdk
+import io.opentelemetry.sdk.common.Clock
 
 internal class OpenTelemetryRumImpl(
     private val openTelemetrySdk: OpenTelemetrySdk,
-    private val sessionProvider: SessionProvider,
-    private val onShutdown: Runnable,
+    override val sessionProvider: SessionProvider,
+    override val clock: Clock,
 ) : OpenTelemetryRum {
+    var onShutdown: Runnable = Runnable {}
     private val logger: Logger =
         openTelemetrySdk.logsBridge
             .loggerBuilder("io.opentelemetry.rum.events")
             .build()
 
     override val openTelemetry: OpenTelemetry = openTelemetrySdk
 
-    override fun getRumSessionId(): String = sessionProvider.getSessionId()
-
     override fun emitEvent(
         eventName: String,
         body: String,

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

@@ -5,13 +5,13 @@
 
 package io.opentelemetry.android
 
+import android.app.Application
 import android.content.Context
 import android.util.Log
 import io.opentelemetry.android.common.RumConstants
 import io.opentelemetry.android.config.OtelRumConfig
 import io.opentelemetry.android.instrumentation.AndroidInstrumentation
 import io.opentelemetry.android.instrumentation.AndroidInstrumentationLoader
-import io.opentelemetry.android.instrumentation.InstallationContext
 import io.opentelemetry.android.session.SessionProvider
 import io.opentelemetry.sdk.OpenTelemetrySdk
 import io.opentelemetry.sdk.common.Clock
@@ -55,8 +55,7 @@ class SdkPreconfiguredRumBuilder internal constructor(
      * @return A new [io.opentelemetry.android.OpenTelemetryRum] instance.
      */
     fun build(): OpenTelemetryRum {
-        val ctx = InstallationContext(context, sdk, sessionProvider, clock)
-        if (ctx.application == null) {
+        if ((context as? Application) == null) {
             Log.w(
                 RumConstants.OTEL_RUM_LOG_TAG,
                 "Cannot retrieve applicationContext. This indicates the OpenTelemetry SDK was " +
@@ -67,18 +66,18 @@ class SdkPreconfiguredRumBuilder internal constructor(
         }
 
         val enabledInstrumentations = getEnabledInstrumentations()
-        val onShutdown: () -> Unit = {
+        val openTelemetryRum = OpenTelemetryRumImpl(sdk, sessionProvider, clock)
+        openTelemetryRum.onShutdown = Runnable {
             for (instrumentation in enabledInstrumentations) {
-                instrumentation.uninstall(ctx)
+                instrumentation.uninstall(context, openTelemetryRum)
             }
             sdk.shutdown()
             onShutdown.run()
         }
-        val openTelemetryRum = OpenTelemetryRumImpl(sdk, sessionProvider, onShutdown)
 
         // Install instrumentations
         for (instrumentation in enabledInstrumentations) {
-            instrumentation.install(ctx)
+            instrumentation.install(context, openTelemetryRum)
         }
 
         // Install crash flush handler after instrumentations so it wraps any

core/src/test/java/io/opentelemetry/android/OpenTelemetryRumBuilderTest.kt

@@ -138,7 +138,7 @@ class OpenTelemetryRumBuilderTest {
             .await()
             .atMost(Duration.ofSeconds(5))
             .untilAsserted {
-                val sessionId = openTelemetryRum.getRumSessionId()
+                val sessionId = openTelemetryRum.sessionProvider.getSessionId()
                 openTelemetryRum
                     .openTelemetry
                     .getTracer("test")
@@ -193,7 +193,7 @@ class OpenTelemetryRumBuilderTest {
             .hasAttributesSatisfyingExactly(
                 OpenTelemetryAssertions.equalTo(
                     SessionIncubatingAttributes.SESSION_ID,
-                    openTelemetryRum.getRumSessionId(),
+                    openTelemetryRum.sessionProvider.getSessionId(),
                 ),
                 OpenTelemetryAssertions.equalTo(SCREEN_NAME_KEY, CUR_SCREEN_NAME),
                 OpenTelemetryAssertions.equalTo(AttributeKey.stringKey("mega"), "hit"),
@@ -307,8 +307,8 @@ class OpenTelemetryRumBuilderTest {
         (builder.instrumentationLoader as AndroidInstrumentationLoaderImpl).registerForTest(classpathInstrumentation)
         builder.build()
 
-        verify(exactly = 1) { localInstrumentation.install(any()) }
-        verify(exactly = 1) { classpathInstrumentation.install(any()) }
+        verify(exactly = 1) { localInstrumentation.install(any(), any()) }
+        verify(exactly = 1) { classpathInstrumentation.install(any(), any()) }
     }
 
     @Test
@@ -332,8 +332,8 @@ class OpenTelemetryRumBuilderTest {
         (builder.instrumentationLoader as AndroidInstrumentationLoaderImpl).registerForTest(classpathInstrumentation)
         builder.build()
 
-        verify(exactly = 1) { localInstrumentation.install(any()) }
-        verify(exactly = 0) { classpathInstrumentation.install(any()) }
+        verify(exactly = 1) { localInstrumentation.install(any(), any()) }
+        verify(exactly = 0) { classpathInstrumentation.install(any(), any()) }
     }
 
     @Test
@@ -467,7 +467,7 @@ class OpenTelemetryRumBuilderTest {
                 OpenTelemetryAssertions.equalTo(SCREEN_NAME_KEY, CUR_SCREEN_NAME),
                 OpenTelemetryAssertions.equalTo(
                     SessionIncubatingAttributes.SESSION_ID,
-                    rum.getRumSessionId(),
+                    rum.sessionProvider.getSessionId(),
                 ),
             ).hasSeverity(Severity.FATAL3)
     }
@@ -631,7 +631,7 @@ class OpenTelemetryRumBuilderTest {
             .hasAttributes(
                 Attributes
                     .builder()
-                    .put(SessionIncubatingAttributes.SESSION_ID, rum.getRumSessionId())
+                    .put(SessionIncubatingAttributes.SESSION_ID, rum.sessionProvider.getSessionId())
                     .put("someGlobalKey", "someGlobalValue")
                     .put("localAttrKey", "localAttrValue")
                     .put(SCREEN_NAME_KEY, CUR_SCREEN_NAME)

core/src/test/java/io/opentelemetry/android/OpenTelemetryRumNoopTest.kt

@@ -14,7 +14,7 @@ internal class OpenTelemetryRumNoopTest {
     fun testNoopOpenTelemetryRum() {
         val noop = RumBuilder.noop()
         assertEquals(OpenTelemetry.noop(), noop.openTelemetry)
-        assertEquals("00000000000000000000000000000000", noop.getRumSessionId())
+        assertEquals("", noop.sessionProvider.getSessionId())
 
         // assert no exceptions thrown
         noop.emitEvent("event")

core/src/test/java/io/opentelemetry/android/instrumentation/AndroidInstrumentationLoaderImplTest.kt

@@ -25,7 +25,7 @@ class AndroidInstrumentationLoaderImplTest {
         assertThat(instrumentation).isNotNull()
         assertThat(checkNotNull(instrumentation).installed).isFalse()
 
-        instrumentation.install(mockk())
+        instrumentation.install(mockk(), mockk(relaxed = true))
 
         assertThat(checkNotNull(loader.getByType(TestAndroidInstrumentation::class.java)).installed).isTrue()
     }

core/src/test/java/io/opentelemetry/android/instrumentation/TestAndroidInstrumentation.kt

@@ -5,17 +5,26 @@
 
 package io.opentelemetry.android.instrumentation
 
+import android.content.Context
+import io.opentelemetry.android.OpenTelemetryRum
+
 class TestAndroidInstrumentation : AndroidInstrumentation {
     override val name: String = "test"
 
     var installed = false
         private set
 
-    override fun install(ctx: InstallationContext) {
+    override fun install(
+        context: Context,
+        openTelemetryRum: OpenTelemetryRum,
+    ) {
         installed = true
     }
 
-    override fun uninstall(ctx: InstallationContext) {
+    override fun uninstall(
+        context: Context,
+        openTelemetryRum: OpenTelemetryRum,
+    ) {
         installed = false
     }
 }