Merge pull request #2330 from embrace-io/otel-sdk-wrapper

Move otel out of core module

Author: fractalwrench

embrace-android-core/build.gradle.kts

@@ -36,7 +36,6 @@ dependencies {
 
     compileOnly(platform(libs.opentelemetry.bom))
     compileOnly(libs.opentelemetry.api)
-    compileOnly(libs.opentelemetry.sdk)
     compileOnly(libs.opentelemetry.semconv)
     compileOnly(libs.opentelemetry.semconv.incubating)
     implementation(libs.lifecycle.runtime)

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

@@ -82,7 +82,7 @@ class EssentialServiceModuleImpl(
 
     override val logWriter: LogWriter by singleton {
         LogWriterImpl(
-            logger = openTelemetryModule.logger,
+            logger = openTelemetryModule.otelSdkWrapper.logger,
             sessionIdTracker = sessionIdTracker,
             processStateService = processStateService,
             clock = initModule.clock,

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

@@ -5,23 +5,18 @@ import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.config.behavior.SensitiveKeysBehavior
 import io.embrace.android.embracesdk.internal.otel.config.OtelSdkConfig
 import io.embrace.android.embracesdk.internal.otel.logs.LogSink
+import io.embrace.android.embracesdk.internal.otel.sdk.OtelSdkWrapper
 import io.embrace.android.embracesdk.internal.otel.spans.SpanRepository
 import io.embrace.android.embracesdk.internal.otel.spans.SpanService
 import io.embrace.android.embracesdk.internal.otel.spans.SpanSink
 import io.embrace.android.embracesdk.internal.spans.CurrentSessionSpan
 import io.embrace.android.embracesdk.internal.spans.EmbraceTracer
 import io.embrace.android.embracesdk.internal.spans.InternalTracer
 import io.embrace.opentelemetry.kotlin.Clock
-import io.embrace.opentelemetry.kotlin.ExperimentalApi
-import io.embrace.opentelemetry.kotlin.OpenTelemetry
-import io.embrace.opentelemetry.kotlin.aliases.OtelJavaOpenTelemetry
-import io.embrace.opentelemetry.kotlin.logging.Logger
-import io.embrace.opentelemetry.kotlin.tracing.Tracer
 
 /**
  * Module that instantiates various OpenTelemetry related components
  */
-@OptIn(ExperimentalApi::class)
 interface OpenTelemetryModule {
 
     /**
@@ -39,11 +34,6 @@ interface OpenTelemetryModule {
      */
     val spanSink: SpanSink
 
-    /**
-     * An instance of the OpenTelemetry component obtained from the wrapped SDK to create spans
-     */
-    val sdkTracer: Tracer
-
     /**
      * Component that manages and provides access to the current session span
      */
@@ -64,27 +54,15 @@ interface OpenTelemetryModule {
      */
     val internalTracer: InternalTracer
 
-    /**
-     * An instance of the OpenTelemetry component obtained from the wrapped SDK to create log records
-     */
-    val logger: Logger
-
     /**
      * Provides storage for completed logs that have not been forwarded yet to the delivery service
      */
     val logSink: LogSink
 
     /**
-     * Provides an [OpenTelemetry] instance that can be used by instrumentation libraries to record telemetry as if it were using the
-     * Embrace APIs. Currently, only the APIs related [Tracer] have operational implementations. Every other method will return no-op
-     * implementations that records no data.
-     */
-    val openTelemetryJava: OtelJavaOpenTelemetry
-
-    /**
-     * Provides an OpenTelemetry instance that provides a Kotlin API.
+     * Provides a wrapper around commonly used OTel APIs in the SDK.
      */
-    val openTelemetryKotlin: OpenTelemetry
+    val otelSdkWrapper: OtelSdkWrapper
 
     /**
      * OpenTelemetry SDK compatible clock based on the internal Embrace clock instance

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

@@ -5,8 +5,6 @@ import io.embrace.android.embracesdk.internal.config.behavior.REDACTED_LABEL
 import io.embrace.android.embracesdk.internal.config.behavior.SensitiveKeysBehavior
 import io.embrace.android.embracesdk.internal.otel.config.OtelSdkConfig
 import io.embrace.android.embracesdk.internal.otel.impl.EmbClock
-import io.embrace.android.embracesdk.internal.otel.impl.EmbOtelJavaOpenTelemetry
-import io.embrace.android.embracesdk.internal.otel.impl.EmbOtelJavaTracerProvider
 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
@@ -24,11 +22,6 @@ import io.embrace.android.embracesdk.internal.spans.EmbraceTracer
 import io.embrace.android.embracesdk.internal.spans.InternalTracer
 import io.embrace.android.embracesdk.internal.utils.EmbTrace
 import io.embrace.opentelemetry.kotlin.ExperimentalApi
-import io.embrace.opentelemetry.kotlin.OpenTelemetry
-import io.embrace.opentelemetry.kotlin.aliases.OtelJavaOpenTelemetry
-import io.embrace.opentelemetry.kotlin.aliases.OtelJavaTracerProvider
-import io.embrace.opentelemetry.kotlin.logging.Logger
-import io.embrace.opentelemetry.kotlin.tracing.Tracer
 
 @OptIn(ExperimentalApi::class)
 internal class OpenTelemetryModuleImpl(
@@ -63,12 +56,13 @@ internal class OpenTelemetryModuleImpl(
         )
     }
 
-    private val otelSdkWrapper: OtelSdkWrapper by lazy {
+    override val otelSdkWrapper: OtelSdkWrapper by lazy {
         EmbTrace.trace("otel-sdk-wrapper-init") {
             try {
                 OtelSdkWrapper(
                     otelClock = openTelemetryClock,
-                    configuration = otelSdkConfig
+                    configuration = otelSdkConfig,
+                    spanService = spanService
                 )
             } catch (exc: NoClassDefFoundError) {
                 throw LinkageError(
@@ -81,10 +75,6 @@ internal class OpenTelemetryModuleImpl(
         }
     }
 
-    override val sdkTracer: Tracer by lazy {
-        otelSdkWrapper.sdkTracer
-    }
-
     private var sensitiveKeysBehavior: SensitiveKeysBehavior? = null
 
     override fun applyConfiguration(sensitiveKeysBehavior: SensitiveKeysBehavior, bypassValidation: Boolean) {
@@ -100,7 +90,7 @@ internal class OpenTelemetryModuleImpl(
 
     private val embraceSpanFactory: EmbraceSpanFactory by singleton {
         EmbraceSpanFactoryImpl(
-            tracer = sdkTracer,
+            tracer = otelSdkWrapper.sdkTracer,
             openTelemetryClock = openTelemetryClock,
             spanRepository = spanRepository,
             dataValidator = dataValidator,
@@ -144,36 +134,10 @@ internal class OpenTelemetryModuleImpl(
         )
     }
 
-    override val logger: Logger by lazy {
-        EmbTrace.trace("otel-logger-init") {
-            otelSdkWrapper.kotlinApi.loggerProvider.getLogger(
-                name = otelSdkConfig.sdkName
-            )
-        }
-    }
-
     override val logSink: LogSink by lazy {
         LogSinkImpl()
     }
 
-    override val openTelemetryJava: OtelJavaOpenTelemetry by lazy {
-        EmbOtelJavaOpenTelemetry(
-            traceProviderSupplier = { externalTracerProvider }
-        )
-    }
-
-    override val openTelemetryKotlin: OpenTelemetry by lazy {
-        otelSdkWrapper.kotlinApi
-    }
-
-    private val externalTracerProvider: OtelJavaTracerProvider by lazy {
-        EmbOtelJavaTracerProvider(
-            sdkTracerProvider = otelSdkWrapper.kotlinApi.tracerProvider,
-            spanService = spanService,
-            clock = openTelemetryClock,
-        )
-    }
-
     fun redactionFunction(key: String, value: String): String {
         return if (sensitiveKeysBehavior?.isSensitiveKey(key) == true) {
             REDACTED_LABEL

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

@@ -1,15 +1,4 @@
 package io.embrace.android.embracesdk.internal.injection
 
-import android.content.Context
-import io.embrace.android.embracesdk.internal.logging.EmbLogger
-
-/**
- * Function that returns an instance of [OpenTelemetryModule]. Matches the signature of the constructor for [OpenTelemetryModuleImpl]
- */
-typealias OpenTelemetryModuleSupplier = (
-    context: Context,
-    logger: EmbLogger,
-) -> OpenTelemetryModule
-
 fun createOpenTelemetryModule(initModule: InitModule): OpenTelemetryModule =
     OpenTelemetryModuleImpl(initModule)

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/injection/OpenTelemetryModuleImplTest.kt

@@ -1,27 +1,19 @@
 package io.embrace.android.embracesdk.internal.injection
 
-import io.embrace.android.embracesdk.internal.otel.impl.EmbOtelJavaOpenTelemetry
 import io.embrace.android.embracesdk.internal.otel.logs.LogSinkImpl
 import io.embrace.android.embracesdk.internal.otel.spans.EmbraceSpanService
 import io.embrace.android.embracesdk.internal.otel.spans.SpanSinkImpl
 import io.embrace.android.embracesdk.internal.spans.CurrentSessionSpanImpl
-import io.embrace.opentelemetry.kotlin.ExperimentalApi
-import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertTrue
 import org.junit.Test
 
 internal class OpenTelemetryModuleImplTest {
-    @OptIn(ExperimentalApi::class)
     @Test
     fun testInitModuleImplDefaults() {
         val openTelemetryModule: OpenTelemetryModule = OpenTelemetryModuleImpl(InitModuleImpl())
         assertTrue(openTelemetryModule.spanSink is SpanSinkImpl)
         assertTrue(openTelemetryModule.spanService is EmbraceSpanService)
         assertTrue(openTelemetryModule.currentSessionSpan is CurrentSessionSpanImpl)
         assertTrue(openTelemetryModule.logSink is LogSinkImpl)
-        assertTrue(openTelemetryModule.openTelemetryJava is EmbOtelJavaOpenTelemetry)
-        assertNotNull(openTelemetryModule.logger)
-        assertNotNull(openTelemetryModule.sdkTracer)
-        assertNotNull(openTelemetryModule.openTelemetryKotlin)
     }
 }

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/spans/CurrentSessionSpanImplTests.kt

@@ -64,7 +64,7 @@ internal class CurrentSessionSpanImplTests {
         telemetryService = initModule.telemetryService
         openTelemetryClock = initModule.openTelemetryModule.openTelemetryClock
         currentSessionSpan = initModule.openTelemetryModule.currentSessionSpan as CurrentSessionSpanImpl
-        tracer = initModule.openTelemetryModule.sdkTracer
+        tracer = initModule.openTelemetryModule.otelSdkWrapper.sdkTracer
         spanService = initModule.openTelemetryModule.spanService
         spanService.initializeService(clock.now())
     }

embrace-android-otel/src/main/kotlin/io/embrace/android/embracesdk/internal/otel/sdk/OtelSdkWrapper.kt

@@ -6,14 +6,20 @@ import io.embrace.android.embracesdk.internal.otel.config.OtelSdkConfig
 import io.embrace.android.embracesdk.internal.otel.config.getMaxTotalAttributeCount
 import io.embrace.android.embracesdk.internal.otel.config.getMaxTotalEventCount
 import io.embrace.android.embracesdk.internal.otel.config.getMaxTotalLinkCount
+import io.embrace.android.embracesdk.internal.otel.impl.EmbOtelJavaOpenTelemetry
+import io.embrace.android.embracesdk.internal.otel.impl.EmbOtelJavaTracerProvider
 import io.embrace.android.embracesdk.internal.otel.logs.DefaultLogRecordProcessor
 import io.embrace.android.embracesdk.internal.otel.spans.DefaultSpanProcessor
+import io.embrace.android.embracesdk.internal.otel.spans.SpanService
 import io.embrace.android.embracesdk.internal.utils.EmbTrace
 import io.embrace.opentelemetry.kotlin.Clock
 import io.embrace.opentelemetry.kotlin.ExperimentalApi
 import io.embrace.opentelemetry.kotlin.OpenTelemetry
 import io.embrace.opentelemetry.kotlin.OpenTelemetryInstance
+import io.embrace.opentelemetry.kotlin.aliases.OtelJavaOpenTelemetry
+import io.embrace.opentelemetry.kotlin.aliases.OtelJavaTracerProvider
 import io.embrace.opentelemetry.kotlin.kotlinApi
+import io.embrace.opentelemetry.kotlin.logging.Logger
 import io.embrace.opentelemetry.kotlin.tracing.Tracer
 
 /**
@@ -25,6 +31,7 @@ import io.embrace.opentelemetry.kotlin.tracing.Tracer
 class OtelSdkWrapper(
     otelClock: Clock,
     configuration: OtelSdkConfig,
+    spanService: SpanService,
     limits: OtelLimitsConfig = InstrumentedConfigImpl.otelLimits,
 ) {
     init {
@@ -41,6 +48,15 @@ class OtelSdkWrapper(
         }
     }
 
+    val logger: Logger by lazy {
+        EmbTrace.trace("otel-logger-init") {
+            kotlinApi.loggerProvider.getLogger(
+                name = configuration.sdkName,
+                version = configuration.sdkVersion,
+            )
+        }
+    }
+
     val kotlinApi: OpenTelemetry by lazy {
         OpenTelemetryInstance.kotlinApi(
             loggerProvider = {
@@ -67,4 +83,18 @@ class OtelSdkWrapper(
             clock = otelClock
         )
     }
+
+    val openTelemetryJava: OtelJavaOpenTelemetry by lazy {
+        EmbOtelJavaOpenTelemetry(
+            traceProviderSupplier = { externalTracerProvider }
+        )
+    }
+
+    private val externalTracerProvider: OtelJavaTracerProvider by lazy {
+        EmbOtelJavaTracerProvider(
+            sdkTracerProvider = kotlinApi.tracerProvider,
+            spanService = spanService,
+            clock = otelClock,
+        )
+    }
 }

embrace-android-otel/src/test/kotlin/io/embrace/android/embracesdk/internal/otel/sdk/OpenTelemetrySdkTest.kt

@@ -5,6 +5,7 @@ import io.embrace.android.embracesdk.fakes.FakeClock
 import io.embrace.android.embracesdk.fakes.FakeOtelJavaLogRecordExporter
 import io.embrace.android.embracesdk.fakes.FakeOtelJavaSpanExporter
 import io.embrace.android.embracesdk.fakes.FakeOtelKotlinClock
+import io.embrace.android.embracesdk.fakes.FakeSpanService
 import io.embrace.android.embracesdk.internal.SystemInfo
 import io.embrace.android.embracesdk.internal.otel.config.OtelSdkConfig
 import io.embrace.android.embracesdk.internal.otel.logs.LogSink
@@ -47,7 +48,8 @@ internal class OpenTelemetrySdkTest {
 
         sdk = OtelSdkWrapper(
             otelClock = FakeOtelKotlinClock(FakeClock()),
-            configuration = configuration
+            configuration = configuration,
+            spanService = FakeSpanService()
         )
     }
 

embrace-android-otel/src/test/kotlin/io/embrace/android/embracesdk/internal/otel/spans/EmbraceSpanServiceTest.kt

@@ -4,6 +4,7 @@ import io.embrace.android.embracesdk.arch.assertIsTypePerformance
 import io.embrace.android.embracesdk.fakes.FakeClock
 import io.embrace.android.embracesdk.fakes.FakeEmbraceSpanFactory
 import io.embrace.android.embracesdk.fakes.FakeOtelKotlinClock
+import io.embrace.android.embracesdk.fakes.FakeSpanService
 import io.embrace.android.embracesdk.internal.SystemInfo
 import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.otel.config.OtelSdkConfig
@@ -51,6 +52,7 @@ internal class EmbraceSpanServiceTest {
         val otelSdkWrapper = OtelSdkWrapper(
             otelClock = fakeClock,
             configuration = otelSdkConfig,
+            spanService = FakeSpanService()
         )
         val dataValidator = DataValidator()