feat: add top level fields

Also refactored crash handle classes into their own namespace.

Refactored IOneSignalOpenTelemetry properties into suspend functions,
as some values we want to add to all Otel requests were suspend.

Author: jkasten2

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/CoreModule.kt

@@ -35,15 +35,16 @@ import com.onesignal.core.internal.time.ITime
 import com.onesignal.core.internal.time.impl.Time
 import com.onesignal.debug.internal.crash.IOneSignalCrashReporter
 import com.onesignal.debug.internal.crash.OneSignalCrashHandler
-import com.onesignal.debug.internal.logging.otel.IOneSignalCrashConfigProvider
+import com.onesignal.debug.internal.logging.otel.crash.IOneSignalCrashConfigProvider
 import com.onesignal.debug.internal.logging.otel.IOneSignalOpenTelemetry
 import com.onesignal.debug.internal.logging.otel.IOneSignalOpenTelemetryCrash
 import com.onesignal.debug.internal.logging.otel.IOneSignalOpenTelemetryRemote
-import com.onesignal.debug.internal.logging.otel.OneSignalCrashConfigProvider
-import com.onesignal.debug.internal.logging.otel.OneSignalCrashReporterOtel
-import com.onesignal.debug.internal.logging.otel.OneSignalCrashUploader
+import com.onesignal.debug.internal.logging.otel.crash.OneSignalCrashConfigProvider
+import com.onesignal.debug.internal.logging.otel.crash.OneSignalCrashReporterOtel
+import com.onesignal.debug.internal.logging.otel.crash.OneSignalCrashUploader
 import com.onesignal.debug.internal.logging.otel.OneSignalOpenTelemetryCrashLocal
 import com.onesignal.debug.internal.logging.otel.OneSignalOpenTelemetryRemote
+import com.onesignal.debug.internal.logging.otel.attributes.OneSignalOtelTopLevelFields
 import com.onesignal.inAppMessages.IInAppMessagesManager
 import com.onesignal.inAppMessages.internal.MisconfiguredIAMManager
 import com.onesignal.location.ILocationManager
@@ -92,7 +93,7 @@ internal class CoreModule : IModule {
         // Purchase Tracking
         builder.register<TrackGooglePurchase>().provides<IStartableService>()
 
-        // TODO: Should be a startable service instead (but we need to wait for the app id...)
+        // Remote Crash and error logging
         builder.register<OneSignalOpenTelemetryRemote>().provides<IOneSignalOpenTelemetry>()
         builder.register<OneSignalCrashReporterOtel>().provides<IOneSignalCrashReporter>()
         builder.register<OneSignalOpenTelemetryRemote>().provides<IOneSignalOpenTelemetryRemote>()
@@ -103,6 +104,8 @@ internal class CoreModule : IModule {
         builder.register<OneSignalCrashHandler>().provides<IStartableService>()
         builder.register<OneSignalCrashUploader>().provides<IStartableService>()
 
+        builder.register<OneSignalOtelTopLevelFields>().provides<OneSignalOtelTopLevelFields>()
+
         // Register dummy services in the event they are not configured. These dummy services
         // will throw an error message if the associated functionality is attempted to be used.
         builder.register<MisconfiguredNotificationsManager>().provides<INotificationsManager>()

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/IOneSignalOpenTelemetry.kt

@@ -5,7 +5,7 @@ import io.opentelemetry.sdk.common.CompletableResultCode
 import io.opentelemetry.sdk.logs.export.LogRecordExporter
 
 internal interface IOneSignalOpenTelemetry {
-    val logger: Logger
+    suspend fun getLogger(): Logger
 
     suspend fun forceFlush(): CompletableResultCode
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalOpenTelemetry.kt

@@ -3,20 +3,58 @@ package com.onesignal.debug.internal.logging.otel
 import android.os.Build
 import androidx.annotation.RequiresApi
 import com.onesignal.core.internal.config.ConfigModelStore
+import com.onesignal.debug.internal.logging.otel.attributes.OneSignalOtelTopLevelFields
 import com.onesignal.debug.internal.logging.otel.config.OtelConfigCrashFile
 import com.onesignal.debug.internal.logging.otel.config.OtelConfigRemoteOneSignal
 import com.onesignal.debug.internal.logging.otel.config.OtelConfigShared
+import com.onesignal.debug.internal.logging.otel.crash.IOneSignalCrashConfigProvider
 import io.opentelemetry.api.logs.Logger
 import io.opentelemetry.sdk.OpenTelemetrySdk
 import io.opentelemetry.sdk.common.CompletableResultCode
 import java.util.concurrent.TimeUnit
 import kotlin.coroutines.resume
 import kotlin.coroutines.suspendCoroutine
 
+internal abstract class OneSignalOpenTelemetryBase(
+    private val _osFields: OneSignalOtelTopLevelFields
+) : IOneSignalOpenTelemetry {
+    private val lock = Any()
+    private var sdk: OpenTelemetrySdk? = null
+    protected suspend fun getSdk(): OpenTelemetrySdk {
+        val attributes = _osFields.getAttributes()
+        synchronized(lock) {
+            var localSdk = sdk
+            if (localSdk != null) {
+                return localSdk
+            }
+
+            localSdk = getSdkInstance(attributes)
+            sdk = localSdk
+            return localSdk
+        }
+    }
+
+     protected abstract fun getSdkInstance(attributes: Map<String, String>): OpenTelemetrySdk
+
+    override suspend fun forceFlush(): CompletableResultCode {
+        val sdkLoggerProvider = getSdk().sdkLoggerProvider
+        return suspendCoroutine {
+            it.resume(
+                sdkLoggerProvider.forceFlush().join(10, TimeUnit.SECONDS)
+            )
+        }
+    }
+
+    override suspend fun getLogger(): Logger =
+        getSdk().sdkLoggerProvider.loggerBuilder("loggerBuilder").build()
+}
+
 @RequiresApi(Build.VERSION_CODES.O)
 internal class OneSignalOpenTelemetryRemote(
     private val _configModelStore: ConfigModelStore,
-) : IOneSignalOpenTelemetryRemote {
+    _osFields: OneSignalOtelTopLevelFields,
+) : OneSignalOpenTelemetryBase(_osFields),
+    IOneSignalOpenTelemetryRemote {
     val extraHttpHeaders by lazy {
         mapOf(
             "OS-App-Id" to _configModelStore.model.appId,
@@ -28,53 +66,33 @@ internal class OneSignalOpenTelemetryRemote(
         OtelConfigRemoteOneSignal.HttpRecordBatchExporter.create(extraHttpHeaders)
     }
 
-    private val sdk: OpenTelemetrySdk by lazy {
+    override fun getSdkInstance(attributes: Map<String, String>): OpenTelemetrySdk =
         OpenTelemetrySdk
             .builder()
             .setLoggerProvider(
                 OtelConfigRemoteOneSignal.SdkLoggerProviderConfig.create(
-                    OtelConfigShared.ResourceConfig.create(_configModelStore.model),
+                    OtelConfigShared.ResourceConfig.create(attributes),
                     extraHttpHeaders
                 )
             ).build()
-    }
-
-    override val logger: Logger
-        get() = sdk.sdkLoggerProvider.loggerBuilder("loggerBuilder").build()
-
-    override suspend fun forceFlush(): CompletableResultCode =
-        suspendCoroutine {
-            it.resume(
-                sdk.sdkLoggerProvider.forceFlush().join(10, TimeUnit.SECONDS)
-            )
-        }
 }
 
-@RequiresApi(Build.VERSION_CODES.O)
 internal class OneSignalOpenTelemetryCrashLocal(
-    private val _configModelStore: ConfigModelStore,
     private val _crashPathProvider: IOneSignalCrashConfigProvider,
-) : IOneSignalOpenTelemetryCrash {
-    private val sdk: OpenTelemetrySdk by lazy {
+    _osFields: OneSignalOtelTopLevelFields,
+) : OneSignalOpenTelemetryBase(_osFields),
+    IOneSignalOpenTelemetryCrash {
+    override fun getSdkInstance(attributes: Map<String, String>): OpenTelemetrySdk =
         OpenTelemetrySdk
             .builder()
             .setLoggerProvider(
                 OtelConfigCrashFile.SdkLoggerProviderConfig.create(
-                    OtelConfigShared.ResourceConfig.create(_configModelStore.model),
+                    OtelConfigShared.ResourceConfig.create(
+                        attributes
+                    ),
                     _crashPathProvider.path,
                     _crashPathProvider.minFileAgeForReadMillis,
                 )
             )
             .build()
-    }
-
-    override val logger: Logger
-        get() = sdk.sdkLoggerProvider.loggerBuilder("loggerBuilder").build()
-
-    override suspend fun forceFlush(): CompletableResultCode =
-        suspendCoroutine {
-            it.resume(
-                sdk.sdkLoggerProvider.forceFlush().join(10, TimeUnit.SECONDS)
-            )
-        }
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/attributes/OneSignalOtelTopLevelFields.kt

@@ -0,0 +1,58 @@
+package com.onesignal.debug.internal.logging.otel.attributes
+
+import android.os.Build
+import com.onesignal.common.AndroidUtils
+import com.onesignal.common.OneSignalUtils
+import com.onesignal.common.OneSignalWrapper
+import com.onesignal.core.internal.application.IApplicationService
+import com.onesignal.core.internal.config.ConfigModelStore
+import com.onesignal.core.internal.device.IInstallIdService
+import com.squareup.wire.internal.toUnmodifiableMap
+
+/**
+ * Purpose: Fields to be included in every Otel request that goes out.
+ * Requirements: Only include fields that can NOT change during runtime,
+ * as these are only fetched once. (Calculated fields are ok)
+ */
+class OneSignalOtelTopLevelFields(
+    private val _applicationService: IApplicationService,
+    private val _configModelStore: ConfigModelStore,
+    private val _installIdService: IInstallIdService,
+) {
+    suspend fun getAttributes(): Map<String, String> {
+        val attributes:  MutableMap<String, String> =
+            mutableMapOf(
+                "ossdk.app_id" to _configModelStore.model.appId,
+                "ossdk.install_id" to _installIdService.getId().toString(),
+                "ossdk.sdk_base" to "android",
+                "ossdk.sdk_base_version" to OneSignalUtils.sdkVersion,
+                "ossdk.app_package_id" to
+                    _applicationService.appContext.packageName,
+                "ossdk.app_version" to
+                    (AndroidUtils.getAppVersion(_applicationService.appContext) ?: "unknown"),
+                "device.manufacturer" to Build.MANUFACTURER,
+                "device.model.identifier" to Build.MODEL,
+                "os.name" to "Android",
+                "os.version" to Build.VERSION.RELEASE,
+                "os.build_id" to Build.ID,
+            )
+
+        attributes
+            .putIfValueNotNull(
+                "ossdk.sdk_wrapper",
+                OneSignalWrapper.sdkType
+            )
+            .putIfValueNotNull(
+                "ossdk.sdk_wrapper_version",
+                OneSignalWrapper.sdkVersion
+            )
+
+        return attributes.toUnmodifiableMap()
+    }
+}
+
+internal fun <K, V> MutableMap<K, V>.putIfValueNotNull(key: K, value: V?): MutableMap<K, V> {
+    if (value != null)
+        this[key] = value
+    return this
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/config/OtelConfigCrashFile.kt

@@ -1,9 +1,6 @@
 package com.onesignal.debug.internal.logging.otel.config
 
-import android.os.Build
-import androidx.annotation.RequiresApi
 import com.onesignal.debug.internal.logging.otel.config.OtelConfigShared.LogLimitsConfig
-import com.onesignal.debug.internal.logging.otel.config.OtelConfigShared.LogLimitsConfig.logLimits
 import io.opentelemetry.contrib.disk.buffering.exporters.LogRecordToDiskExporter
 import io.opentelemetry.contrib.disk.buffering.storage.impl.FileLogRecordStorage
 import io.opentelemetry.contrib.disk.buffering.storage.impl.FileStorageConfiguration
@@ -25,7 +22,7 @@ class OtelConfigCrashFile {
                     .builder()
                     // NOTE: Only use such as small maxFileAgeForWrite for
                     // crashes, as we want to send them as soon as possible
-                    // without have to wait too long for buffers.
+                    // without having to wait too long for buffers.
                     .setMaxFileAgeForWriteMillis(2_000)
                     .setMinFileAgeForReadMillis(minFileAgeForReadMillis)
                     .setMaxFileAgeForReadMillis(72.hours.inWholeMilliseconds)

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/config/OtelConfigShared.kt

@@ -2,26 +2,29 @@ package com.onesignal.debug.internal.logging.otel.config
 
 import android.os.Build
 import androidx.annotation.RequiresApi
-import com.onesignal.core.internal.config.ConfigModel
 import io.opentelemetry.sdk.logs.LogLimits
 import io.opentelemetry.sdk.logs.LogRecordProcessor
 import io.opentelemetry.sdk.logs.export.BatchLogRecordProcessor
 import io.opentelemetry.sdk.logs.export.LogRecordExporter
 import io.opentelemetry.sdk.resources.Resource
+import io.opentelemetry.sdk.resources.ResourceBuilder
 import io.opentelemetry.semconv.ServiceAttributes
 import java.time.Duration
 
+internal fun ResourceBuilder.putAll(attributes: Map<String, String>): ResourceBuilder {
+    attributes.forEach { this.put(it.key, it.value) }
+    return this
+}
+
 internal class OtelConfigShared {
     object ResourceConfig {
-        fun create(configModel: ConfigModel): Resource =
+        fun create(attributes: Map<String, String>): Resource =
             Resource
                 .getDefault()
                 .toBuilder()
-  //            .put(ServiceAttributes.SERVICE_NAME, "OneSignalDeviceSDK")
+                //            .put(ServiceAttributes.SERVICE_NAME, "OneSignalDeviceSDK")
                 .put(ServiceAttributes.SERVICE_NAME, "OS-Android-SDK-Test")
-                .put("ossdk.app_id", configModel.appId)
-                // TODO: other fields
-                // TODO: Why not set all top level fields here? Use a top level provider
+                .putAll(attributes)
                 .build()
     }
 

…ng/otel/IOneSignalCrashConfigProvider.kt …l/crash/IOneSignalCrashConfigProvider.ktOneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/IOneSignalCrashConfigProvider.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/IOneSignalCrashConfigProvider.kt OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/IOneSignalCrashConfigProvider.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/IOneSignalCrashConfigProvider.kt

@@ -1,4 +1,4 @@
-package com.onesignal.debug.internal.logging.otel
+package com.onesignal.debug.internal.logging.otel.crash
 
 interface IOneSignalCrashConfigProvider {
     val path: String

…ing/otel/OneSignalCrashConfigProvider.kt …el/crash/OneSignalCrashConfigProvider.ktOneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashConfigProvider.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashConfigProvider.kt OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashConfigProvider.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashConfigProvider.kt

@@ -1,4 +1,4 @@
-package com.onesignal.debug.internal.logging.otel
+package com.onesignal.debug.internal.logging.otel.crash
 
 import com.onesignal.core.internal.application.IApplicationService
 import java.io.File

…gging/otel/OneSignalCrashReporterOtel.kt …otel/crash/OneSignalCrashReporterOtel.ktOneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashReporterOtel.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashReporterOtel.kt OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashReporterOtel.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashReporterOtel.kt

@@ -1,14 +1,10 @@
-package com.onesignal.debug.internal.logging.otel
+package com.onesignal.debug.internal.logging.otel.crash
 
-import android.os.Build
 import android.util.Log
-import androidx.annotation.RequiresApi
 import com.onesignal.debug.internal.crash.IOneSignalCrashReporter
+import com.onesignal.debug.internal.logging.otel.IOneSignalOpenTelemetryCrash
 import io.opentelemetry.api.common.Attributes
-import java.io.PrintWriter
-import java.io.StringWriter
 
-@RequiresApi(Build.VERSION_CODES.O)
 internal class OneSignalCrashReporterOtel(
     val _openTelemetry: IOneSignalOpenTelemetryCrash
 ) : IOneSignalCrashReporter {
@@ -18,11 +14,12 @@ internal class OneSignalCrashReporterOtel(
         private const val EXCEPTION_STACKTRACE = "exception.stacktrace"
     }
 
-    override suspend fun sendCrash(therad: Thread, throwable: Throwable) {
+    override suspend fun sendCrash(thread: Thread, throwable: Throwable) {
         Log.e("OSCrashHandling", "sendCrash TOP")
         val attributesBuilder =
             Attributes
                 .builder()
+                .put(EXCEPTION_MESSAGE, throwable.message)
                 .put(EXCEPTION_STACKTRACE, throwable.stackTraceToString())
                 .put(EXCEPTION_TYPE, throwable.javaClass.name)
                 .build()
@@ -33,22 +30,12 @@ internal class OneSignalCrashReporterOtel(
 //            message.append("Process: ").append(processName).append(", ");
 //        }
 
-        _openTelemetry.logger
+        _openTelemetry.getLogger()
             .logRecordBuilder()
             .setAllAttributes(attributesBuilder)
             .emit()
 
         _openTelemetry.forceFlush()
         Log.e("OSCrashHandling", "sendCrash BOTTOM")
     }
-
-    private fun stackTraceToString(throwable: Throwable): String {
-        val stringWriter = StringWriter(256)
-        val printWriter = PrintWriter(stringWriter)
-
-        throwable.printStackTrace(printWriter)
-        printWriter.flush()
-
-        return stringWriter.toString()
-    }
 }

…l/logging/otel/OneSignalCrashUploader.kt …ing/otel/crash/OneSignalCrashUploader.ktOneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashUploader.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashUploader.kt OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/OneSignalCrashUploader.kt renamed to OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/logging/otel/crash/OneSignalCrashUploader.kt

@@ -1,13 +1,14 @@
-package com.onesignal.debug.internal.logging.otel
+package com.onesignal.debug.internal.logging.otel.crash
 
 import com.onesignal.core.internal.startup.IStartableService
+import com.onesignal.debug.internal.logging.otel.crash.IOneSignalCrashConfigProvider
+import com.onesignal.debug.internal.logging.otel.IOneSignalOpenTelemetryRemote
 import com.onesignal.debug.internal.logging.otel.config.OtelConfigCrashFile
 import io.opentelemetry.sdk.logs.data.LogRecordData
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.runBlocking
 import java.util.concurrent.TimeUnit
 
-
 /**
  * Purpose: This reads a local crash report files created by OneSignal's
  *   crash handler and sends them to OneSignal on the app's next start.