Merge pull request #1142 from embrace-io/move-otel-module

Move OpenTelemetry module
embrace-io · Jul 29, 2024 · 9f9d877 · 9f9d877
2 parents 2f37751 + 4515c07
commit 9f9d877
Show file tree

Hide file tree

Showing 34 changed files with 277 additions and 217 deletions.
diff --git a/embrace-android-api/api/embrace-android-api.api b/embrace-android-api/api/embrace-android-api.api
@@ -15,6 +15,23 @@ public abstract interface annotation class io/embrace/android/embracesdk/annotat
 public abstract interface annotation class io/embrace/android/embracesdk/annotation/StartupActivity : java/lang/annotation/Annotation {
 }
 
+public abstract interface class io/embrace/android/embracesdk/internal/InternalTracingApi {
+	public abstract fun addSpanAttribute (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Z
+	public abstract fun addSpanEvent (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;Ljava/util/Map;)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;Ljava/lang/String;Ljava/util/Map;Ljava/util/List;)Z
+	public abstract fun recordSpan (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;Ljava/util/List;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public abstract fun startSpan (Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;)Ljava/lang/String;
+	public abstract fun stopSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/ErrorCode;Ljava/lang/Long;)Z
+}
+
+public final class io/embrace/android/embracesdk/internal/InternalTracingApi$DefaultImpls {
+	public static synthetic fun addSpanEvent$default (Lio/embrace/android/embracesdk/internal/InternalTracingApi;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;Ljava/util/Map;ILjava/lang/Object;)Z
+	public static synthetic fun recordCompletedSpan$default (Lio/embrace/android/embracesdk/internal/InternalTracingApi;Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;Ljava/lang/String;Ljava/util/Map;Ljava/util/List;ILjava/lang/Object;)Z
+	public static synthetic fun recordSpan$default (Lio/embrace/android/embracesdk/internal/InternalTracingApi;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;Ljava/util/List;Lkotlin/jvm/functions/Function0;ILjava/lang/Object;)Ljava/lang/Object;
+	public static synthetic fun startSpan$default (Lio/embrace/android/embracesdk/internal/InternalTracingApi;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Long;ILjava/lang/Object;)Ljava/lang/String;
+	public static synthetic fun stopSpan$default (Lio/embrace/android/embracesdk/internal/InternalTracingApi;Ljava/lang/String;Lio/embrace/android/embracesdk/spans/ErrorCode;Ljava/lang/Long;ILjava/lang/Object;)Z
+}
+
 public abstract interface class io/embrace/android/embracesdk/spans/EmbraceSpan {
 	public abstract fun addAttribute (Ljava/lang/String;Ljava/lang/String;)Z
 	public abstract fun addEvent (Ljava/lang/String;)Z
@@ -73,3 +90,37 @@ public final class io/embrace/android/embracesdk/spans/ErrorCode : java/lang/Enu
 	public static fun values ()[Lio/embrace/android/embracesdk/spans/ErrorCode;
 }
 
+public abstract interface class io/embrace/android/embracesdk/spans/TracingApi {
+	public abstract fun createSpan (Ljava/lang/String;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public abstract fun createSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public abstract fun getSpan (Ljava/lang/String;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public abstract fun isTracingAvailable ()Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJ)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/EmbraceSpan;)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;Lio/embrace/android/embracesdk/spans/EmbraceSpan;)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;Lio/embrace/android/embracesdk/spans/EmbraceSpan;Ljava/util/Map;Ljava/util/List;)Z
+	public abstract fun recordCompletedSpan (Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;)Z
+	public abstract fun recordSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;Ljava/util/Map;Ljava/util/List;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public abstract fun recordSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public abstract fun recordSpan (Ljava/lang/String;Ljava/util/Map;Ljava/util/List;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public abstract fun recordSpan (Ljava/lang/String;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public abstract fun startSpan (Ljava/lang/String;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public abstract fun startSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public abstract fun startSpan (Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;Ljava/lang/Long;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+}
+
+public final class io/embrace/android/embracesdk/spans/TracingApi$DefaultImpls {
+	public static fun createSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;JJ)Z
+	public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/EmbraceSpan;)Z
+	public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;)Z
+	public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/ErrorCode;Lio/embrace/android/embracesdk/spans/EmbraceSpan;)Z
+	public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;)Z
+	public static fun recordSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public static fun recordSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;Ljava/util/Map;Ljava/util/List;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public static fun recordSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;Lkotlin/jvm/functions/Function0;)Ljava/lang/Object;
+	public static fun startSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+	public static fun startSpan (Lio/embrace/android/embracesdk/spans/TracingApi;Ljava/lang/String;Lio/embrace/android/embracesdk/spans/EmbraceSpan;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
+}
+
diff --git a/...embracesdk/internal/InternalTracingApi.kt → ...embracesdk/internal/InternalTracingApi.kt b/...embracesdk/internal/InternalTracingApi.kt → ...embracesdk/internal/InternalTracingApi.kt
diff --git a/...ce/android/embracesdk/spans/TracingApi.kt → ...ce/android/embracesdk/spans/TracingApi.kt b/...ce/android/embracesdk/spans/TracingApi.kt → ...ce/android/embracesdk/spans/TracingApi.kt
diff --git a/embrace-android-core/build.gradle.kts b/embrace-android-core/build.gradle.kts
@@ -6,6 +6,16 @@ description = "Embrace Android SDK: Core"
 
 android {
     namespace = "io.embrace.android.embracesdk.core"
+    defaultConfig {
+        // For library projects only, the BuildConfig.VERSION_NAME and BuildConfig.VERSION_CODE properties have been removed from the generated BuildConfig class
+        //
+        // https://developer.android.com/studio/releases/gradle-plugin#version_properties_removed_from_buildconfig_class_in_library_projects
+        buildConfigField("String", "VERSION_NAME", "\"${version}\"")
+        buildConfigField("String", "VERSION_CODE", "\"${53}\"")
+    }
+    buildFeatures {
+        buildConfig = true
+    }
 }
 
 apiValidation.validationDisabled = true
@@ -15,6 +25,7 @@ dependencies {
     compileOnly(project(":embrace-android-api"))
     compileOnly(platform(libs.opentelemetry.bom))
     compileOnly(libs.opentelemetry.api)
+    compileOnly(libs.opentelemetry.sdk)
     compileOnly(libs.opentelemetry.semconv)
     compileOnly(libs.opentelemetry.semconv.incubating)
     compileOnly(libs.lifecycle.common.java8)

diff --git a/...src/main/kotlin/io/embrace/android/embracesdk/internal/arch/schema/AppTerminationCause.kt b/...src/main/kotlin/io/embrace/android/embracesdk/internal/arch/schema/AppTerminationCause.kt
@@ -0,0 +1,16 @@
+package io.embrace.android.embracesdk.internal.arch.schema
+
+/**
+ * Attribute that stores the reason an app instance terminated
+ */
+public sealed class AppTerminationCause(
+    override val value: String
+) : FixedAttribute {
+    override val key: EmbraceAttributeKey = EmbraceAttributeKey(id = "termination_cause")
+
+    public object Crash : AppTerminationCause("crash")
+
+    public object UserTermination : AppTerminationCause("user_termination")
+
+    public object Unknown : AppTerminationCause("unknown")
+}
diff --git a/...internal/injection/OpenTelemetryModule.kt → ...internal/injection/OpenTelemetryModule.kt b/...internal/injection/OpenTelemetryModule.kt → ...internal/injection/OpenTelemetryModule.kt
@@ -16,72 +16,72 @@ import io.opentelemetry.api.trace.TracerProvider
 /**
  * Module that instantiates various OpenTelemetry related components
  */
-internal interface OpenTelemetryModule {
+public interface OpenTelemetryModule {
 
     /**
      * Configuration for the OpenTelemetry SDK
      */
-    val openTelemetryConfiguration: OpenTelemetryConfiguration
+    public val openTelemetryConfiguration: OpenTelemetryConfiguration
 
     /**
      * Caches span instances that are in progress or completed in the current session
      */
-    val spanRepository: SpanRepository
+    public val spanRepository: SpanRepository
 
     /**
      * Provides storage for completed spans that have not been sent off-device
      */
-    val spanSink: SpanSink
+    public val spanSink: SpanSink
 
     /**
      * An instance of the OpenTelemetry component obtained from the wrapped SDK to create spans
      */
-    val sdkTracer: Tracer
+    public val sdkTracer: Tracer
 
     /**
      * Component that manages and provides access to the current session span
      */
-    val currentSessionSpan: CurrentSessionSpan
+    public val currentSessionSpan: CurrentSessionSpan
 
     /**
      * Service to record spans
      */
-    val spanService: SpanService
+    public val spanService: SpanService
 
     /**
      * Implementation of public tracing API
      */
-    val embraceTracer: EmbraceTracer
+    public val embraceTracer: EmbraceTracer
 
     /**
      * Implementation of internal tracing API
      */
-    val internalTracer: InternalTracer
+    public val internalTracer: InternalTracer
 
     /**
      * An instance of the OpenTelemetry component obtained from the wrapped SDK to create log records
      */
-    val logger: Logger
+    public val logger: Logger
 
     /**
      * Provides storage for completed logs that have not been forwarded yet to the delivery service
      */
-    val logSink: LogSink
+    public 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 externalOpenTelemetry: OpenTelemetry
+    public val externalOpenTelemetry: OpenTelemetry
 
     /**
      * Provides [Tracer] instances for instrumentation external to the Embrace SDK to create spans
      */
-    val externalTracerProvider: TracerProvider
+    public val externalTracerProvider: TracerProvider
 
     /**
      * OpenTelemetry SDK compatible clock based on [clock]
      */
-    val openTelemetryClock: io.opentelemetry.sdk.common.Clock
+    public val openTelemetryClock: io.opentelemetry.sdk.common.Clock
 }
diff --git a/...internal/logs/EmbraceLogRecordExporter.kt → ...internal/logs/EmbraceLogRecordExporter.kt b/...internal/logs/EmbraceLogRecordExporter.kt → ...internal/logs/EmbraceLogRecordExporter.kt
@@ -9,7 +9,7 @@ import io.opentelemetry.sdk.logs.export.LogRecordExporter
 /**
  * Exports the given [LogRecordData] to a [LogSink]
  */
-internal class EmbraceLogRecordExporter(
+public class EmbraceLogRecordExporter(
     private val logSink: LogSink,
     private val externalLogRecordExporter: LogRecordExporter
 ) : LogRecordExporter {

diff --git a/...nternal/logs/EmbraceLogRecordProcessor.kt → ...nternal/logs/EmbraceLogRecordProcessor.kt b/...nternal/logs/EmbraceLogRecordProcessor.kt → ...nternal/logs/EmbraceLogRecordProcessor.kt
@@ -8,7 +8,7 @@ import io.opentelemetry.sdk.logs.export.LogRecordExporter
 /**
  * [LogRecordProcessor] that exports log records it to the given [LogRecordExporter]
  */
-internal class EmbraceLogRecordProcessor(
+public class EmbraceLogRecordProcessor(
     private val logRecordExporter: LogRecordExporter
 ) : LogRecordProcessor {
 

diff --git a/...droid/embracesdk/internal/logs/LogSink.kt → ...droid/embracesdk/internal/logs/LogSink.kt b/...droid/embracesdk/internal/logs/LogSink.kt → ...droid/embracesdk/internal/logs/LogSink.kt
@@ -8,31 +8,31 @@ import io.opentelemetry.sdk.logs.data.LogRecordData
  * A service that stores exported logs and provides access to them so they
  * can be sent off-device at the appropriate cadence.
  */
-internal interface LogSink {
+public interface LogSink {
 
     /**
      * Store [Log] objects to be sent in the nexdt batch. Implementations must support concurrent invocations.
      */
-    fun storeLogs(logs: List<LogRecordData>): CompletableResultCode
+    public fun storeLogs(logs: List<LogRecordData>): CompletableResultCode
 
     /**
      * Returns the list of currently stored [Log] objects, waiting to be sent in the next batch
      */
-    fun completedLogs(): List<Log>
+    public fun completedLogs(): List<Log>
 
     /**
      * Returns and clears the currently stored [Log] objects, to be used when the next batch is to be sent.
      * Implementations of this method must make sure the clearing and returning is atomic, i.e. logs cannot be added during this operation.
      */
-    fun flushLogs(): List<Log>
+    public fun flushLogs(): List<Log>
 
     /**
      * Return a [Log] that is to be sent immediately rather than batched
      */
-    fun pollNonbatchedLog(): Log?
+    public fun pollNonbatchedLog(): Log?
 
     /**
      * Registers a callback to be called after new logs are stored.
      */
-    fun registerLogStoredCallback(onLogsStored: () -> Unit)
+    public fun registerLogStoredCallback(onLogsStored: () -> Unit)
 }
diff --git a/...nal/opentelemetry/EmbraceAttributeKeys.kt → ...nal/opentelemetry/EmbraceAttributeKeys.kt b/...nal/opentelemetry/EmbraceAttributeKeys.kt → ...nal/opentelemetry/EmbraceAttributeKeys.kt
@@ -6,94 +6,94 @@ import io.embrace.android.embracesdk.internal.payload.ThreadInfo
 /**
  * A snapshot of the current call stack of the threads running in the app process per [ThreadInfo]
  */
-internal val embAndroidThreads = EmbraceAttributeKey("android.threads")
+public val embAndroidThreads: EmbraceAttributeKey = EmbraceAttributeKey("android.threads")
 
 /**
  * Sequence number for the number of crashes captured by Embrace on the device, reported on every crash
  */
-internal val embCrashNumber = EmbraceAttributeKey("android.crash_number")
+public val embCrashNumber: EmbraceAttributeKey = EmbraceAttributeKey("android.crash_number")
 
 /**
  * Attribute name for the exception handling type - whether it's handled or unhandled
  */
-internal val embExceptionHandling = EmbraceAttributeKey("exception_handling")
+public val embExceptionHandling: EmbraceAttributeKey = EmbraceAttributeKey("exception_handling")
 
 /**
  * Monotonically increasing sequence ID given to completed span that is expected to be sent to the server
  */
-internal val embProcessIdentifier: EmbraceAttributeKey = EmbraceAttributeKey("process_identifier")
+public val embProcessIdentifier: EmbraceAttributeKey = EmbraceAttributeKey("process_identifier")
 
 /**
  * Attribute name for the unique ID assigned to each app instance
  */
-internal val embSequenceId: EmbraceAttributeKey = EmbraceAttributeKey(id = "sequence_id", isPrivate = true)
+public val embSequenceId: EmbraceAttributeKey = EmbraceAttributeKey(id = "sequence_id", isPrivate = true)
 
 /**
  * Attribute name for the application state (foreground/background) at the time the log was recorded
  */
-internal val embState = EmbraceAttributeKey("state")
+public val embState: EmbraceAttributeKey = EmbraceAttributeKey("state")
 
 /**
  * Attribute name for whether the session is a cold start
  */
-internal val embColdStart = EmbraceAttributeKey("cold_start")
+public val embColdStart: EmbraceAttributeKey = EmbraceAttributeKey("cold_start")
 
 /**
  * Attribute name for session number (integer sequence ID)
  */
-internal val embSessionNumber = EmbraceAttributeKey("session_number")
+public val embSessionNumber: EmbraceAttributeKey = EmbraceAttributeKey("session_number")
 
 /**
  * Attribute name that indicates whether the session was ended by the SDK or an unexpected termination
  */
-internal val embCleanExit = EmbraceAttributeKey("clean_exit")
+public val embCleanExit: EmbraceAttributeKey = EmbraceAttributeKey("clean_exit")
 
 /**
  * Attribute name that indicates whether the session was terminated
  */
-internal val embTerminated = EmbraceAttributeKey("terminated")
+public val embTerminated: EmbraceAttributeKey = EmbraceAttributeKey("terminated")
 
 /**
  * Attribute name that represents last known time that the session existed (nanoseconds since epoch)
  */
-internal val embHeartbeatTimeUnixNano = EmbraceAttributeKey("heartbeat_time_unix_nano")
+public val embHeartbeatTimeUnixNano: EmbraceAttributeKey = EmbraceAttributeKey("heartbeat_time_unix_nano")
 
 /**
  * Attribute name that identifies the crash report tied to the session
  */
-internal val embCrashId = EmbraceAttributeKey("crash_id")
+public val embCrashId: EmbraceAttributeKey = EmbraceAttributeKey("crash_id")
 
 /**
  * Attribute name that identifies the session start type
  */
-internal val embSessionStartType = EmbraceAttributeKey("session_start_type")
+public val embSessionStartType: EmbraceAttributeKey = EmbraceAttributeKey("session_start_type")
 
 /**
  * Attribute name that identifies the session end type
  */
-internal val embSessionEndType = EmbraceAttributeKey("session_end_type")
+public val embSessionEndType: EmbraceAttributeKey = EmbraceAttributeKey("session_end_type")
 
 /**
  * Attribute name that identifies the startup duration
  */
-internal val embSessionStartupDuration = EmbraceAttributeKey("startup_duration")
+public val embSessionStartupDuration: EmbraceAttributeKey = EmbraceAttributeKey("startup_duration")
 
 /**
  * Attribute name that identifies the startup threshold
  */
-internal val embSessionStartupThreshold = EmbraceAttributeKey("threshold")
+public val embSessionStartupThreshold: EmbraceAttributeKey = EmbraceAttributeKey("threshold")
 
 /**
  * Attribute name that identifies the SDK duration
  */
-internal val embSdkStartupDuration = EmbraceAttributeKey("sdk_startup_duration")
+public val embSdkStartupDuration: EmbraceAttributeKey = EmbraceAttributeKey("sdk_startup_duration")
 
 /**
  * Attribute name that identifies the error log count in a session
  */
-internal val embErrorLogCount = EmbraceAttributeKey("error_log_count")
+public val embErrorLogCount: EmbraceAttributeKey = EmbraceAttributeKey("error_log_count")
 
 /**
  * Attribute name that identifies the number of free bytes on disk
  */
-internal val embFreeDiskBytes = EmbraceAttributeKey("disk_free_bytes")
+public val embFreeDiskBytes: EmbraceAttributeKey = EmbraceAttributeKey("disk_free_bytes")