WIP - Feat: OpenTelemetry crash reporting

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/application/MainApplicationKT.kt

@@ -42,6 +42,7 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.DelicateCoroutinesApi
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.delay
 import kotlinx.coroutines.launch
 
 class MainApplicationKT : MultiDexApplication() {
@@ -81,6 +82,9 @@ class MainApplicationKT : MultiDexApplication() {
             OneSignal.Notifications.requestPermission(true)
 
             Log.d(Tag.LOG_TAG, Text.ONESIGNAL_SDK_INIT)
+
+            delay(3000)
+            //throw RuntimeException("test crash 2025-11-04 18")
         }
     }
 

OneSignalSDK/build.gradle

@@ -14,7 +14,7 @@ buildscript {
         huaweiAgconnectVersion = '1.9.1.304'
         huaweiHMSPushVersion = '6.3.0.304'
         huaweiHMSLocationVersion = '4.0.0.300'
-        kotlinVersion = '1.9.25'
+        kotlinVersion = '2.2.21'
         coroutinesVersion = '1.7.3'
         kotestVersion = '5.8.0'
         ioMockVersion = '1.13.2'

OneSignalSDK/onesignal/core/build.gradle

@@ -88,6 +88,18 @@ dependencies {
         }
     }
 
+    implementation platform("io.opentelemetry:opentelemetry-bom:1.55.0")
+
+    implementation('io.opentelemetry:opentelemetry-api')
+    implementation('io.opentelemetry:opentelemetry-sdk')
+
+    implementation('io.opentelemetry:opentelemetry-exporter-otlp') // includes okhttp
+    implementation('io.opentelemetry.semconv:opentelemetry-semconv:1.37.0')
+    implementation('io.opentelemetry.contrib:opentelemetry-disk-buffering:1.51.0-alpha')
+    // TODO: Make sure by adding Android OTel that it doesn't auto send stuff to us
+
+
+
     testImplementation(project(':OneSignal:testhelpers'))
 
     testImplementation("io.kotest:kotest-runner-junit5:$kotestVersion")

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

@@ -33,6 +33,19 @@ import com.onesignal.core.internal.purchases.impl.TrackGooglePurchase
 import com.onesignal.core.internal.startup.IStartableService
 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.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.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.OneSignalOtelFieldsPerEvent
+import com.onesignal.debug.internal.logging.otel.attributes.OneSignalOtelFieldsTopLevel
 import com.onesignal.inAppMessages.IInAppMessagesManager
 import com.onesignal.inAppMessages.internal.MisconfiguredIAMManager
 import com.onesignal.location.ILocationManager
@@ -81,6 +94,20 @@ internal class CoreModule : IModule {
         // Purchase Tracking
         builder.register<TrackGooglePurchase>().provides<IStartableService>()
 
+        // Remote Crash and error logging
+        builder.register<OneSignalOpenTelemetryRemote>().provides<IOneSignalOpenTelemetry>()
+        builder.register<OneSignalCrashReporterOtel>().provides<IOneSignalCrashReporter>()
+        builder.register<OneSignalOpenTelemetryRemote>().provides<IOneSignalOpenTelemetryRemote>()
+
+        builder.register<OneSignalOpenTelemetryCrashLocal>().provides<IOneSignalOpenTelemetryCrash>()
+        builder.register<OneSignalCrashConfigProvider>().provides<IOneSignalCrashConfigProvider>()
+
+        builder.register<OneSignalCrashHandler>().provides<OneSignalCrashHandler>()
+        builder.register<OneSignalCrashUploader>().provides<IStartableService>()
+
+        builder.register<OneSignalOtelFieldsTopLevel>().provides<OneSignalOtelFieldsTopLevel>()
+        builder.register<OneSignalOtelFieldsPerEvent>().provides<OneSignalOtelFieldsPerEvent>()
+
         // 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/core/internal/backend/IParamsBackendService.kt

@@ -36,6 +36,7 @@ class ParamsObject(
     var opRepoExecutionInterval: Long? = null,
     var influenceParams: InfluenceParamsObject,
     var fcmParams: FCMParamsObject,
+    val remoteLoggingParams: RemoteLoggingParamsObject,
 )
 
 class InfluenceParamsObject(
@@ -53,3 +54,7 @@ class FCMParamsObject(
     val appId: String? = null,
     val apiKey: String? = null,
 )
+
+class RemoteLoggingParamsObject(
+    val enable: Boolean? = null,
+)

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/backend/impl/ParamsBackendService.kt

@@ -11,6 +11,7 @@ import com.onesignal.core.internal.backend.FCMParamsObject
 import com.onesignal.core.internal.backend.IParamsBackendService
 import com.onesignal.core.internal.backend.InfluenceParamsObject
 import com.onesignal.core.internal.backend.ParamsObject
+import com.onesignal.core.internal.backend.RemoteLoggingParamsObject
 import com.onesignal.core.internal.http.CacheKeys
 import com.onesignal.core.internal.http.IHttpClient
 import com.onesignal.core.internal.http.impl.OptionalHeaders
@@ -57,6 +58,15 @@ internal class ParamsBackendService(
                 )
         }
 
+        // Process Remote Logging params
+        var remoteLoggingParams: RemoteLoggingParamsObject? = null
+        responseJson.expandJSONObject("remote_logging") {
+            remoteLoggingParams =
+                RemoteLoggingParamsObject(
+                    enable = it.safeBool("enable"),
+                )
+        }
+
         return ParamsObject(
             googleProjectNumber = responseJson.safeString("android_sender_id"),
             enterprise = responseJson.safeBool("enterp"),
@@ -75,6 +85,7 @@ internal class ParamsBackendService(
             opRepoExecutionInterval = responseJson.safeLong("oprepo_execution_interval"),
             influenceParams = influenceParams ?: InfluenceParamsObject(),
             fcmParams = fcmParams ?: FCMParamsObject(),
+            remoteLoggingParams = remoteLoggingParams ?: RemoteLoggingParamsObject(),
         )
     }
 

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/config/ConfigModel.kt

@@ -301,6 +301,9 @@ class ConfigModel : Model() {
     val fcmParams: FCMConfigModel
         get() = getAnyProperty(::fcmParams.name) { FCMConfigModel(this, ::fcmParams.name) } as FCMConfigModel
 
+    val remoteLoggingParams: RemoteLoggingConfigModel
+        get() = getAnyProperty(::remoteLoggingParams.name) { RemoteLoggingConfigModel(this, ::remoteLoggingParams.name) } as RemoteLoggingConfigModel
+
     override fun createModelForProperty(
         property: String,
         jsonObject: JSONObject,
@@ -317,6 +320,12 @@ class ConfigModel : Model() {
             return model
         }
 
+        if (property == ::remoteLoggingParams.name) {
+            val model = RemoteLoggingConfigModel(this, ::remoteLoggingParams.name)
+            model.initializeFromJson(jsonObject)
+            return model
+        }
+
         return null
     }
 }
@@ -425,3 +434,17 @@ class FCMConfigModel(parentModel: Model, parentProperty: String) : Model(parentM
             setOptStringProperty(::apiKey.name, value)
         }
 }
+
+class RemoteLoggingConfigModel(
+    parentModel: Model,
+    parentProperty: String,
+) : Model(parentModel, parentProperty) {
+    /**
+     * Do we send OneSignal related logs to OneSignal's server.
+     */
+    var enable: Boolean?
+        get() = getOptBooleanProperty(::enable.name) { null }
+        set(value) {
+            setOptBooleanProperty(::enable.name, value)
+        }
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/config/impl/ConfigModelStoreListener.kt

@@ -103,6 +103,8 @@ internal class ConfigModelStoreListener(
                     params.influenceParams.isIndirectEnabled?.let { config.influenceParams.isIndirectEnabled = it }
                     params.influenceParams.isUnattributedEnabled?.let { config.influenceParams.isUnattributedEnabled = it }
 
+                    params.remoteLoggingParams.enable?.let { config.remoteLoggingParams.enable = it }
+
                     _configModelStore.replace(config, ModelChangeTags.HYDRATE)
                     success = true
                 } catch (ex: BackendException) {

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/http/impl/HttpClient.kt

@@ -26,6 +26,9 @@ import java.net.UnknownHostException
 import java.util.Scanner
 import javax.net.ssl.HttpsURLConnection
 
+internal const val HTTP_SDK_VERSION_HEADER_KEY = "SDK-Version"
+internal val HTTP_SDK_VERSION_HEADER_VALUE = "onesignal/android/${OneSignalUtils.sdkVersion}"
+
 internal class HttpClient(
     private val _connectionFactory: IHttpConnectionFactory,
     private val _prefs: IPreferencesService,
@@ -131,7 +134,7 @@ internal class HttpClient(
                     con.useCaches = false
                     con.connectTimeout = timeout
                     con.readTimeout = timeout
-                    con.setRequestProperty("SDK-Version", "onesignal/android/" + OneSignalUtils.sdkVersion)
+                    con.setRequestProperty(HTTP_SDK_VERSION_HEADER_KEY, HTTP_SDK_VERSION_HEADER_VALUE)
 
                     if (OneSignalWrapper.sdkType != null && OneSignalWrapper.sdkVersion != null) {
                         con.setRequestProperty("SDK-Wrapper", "onesignal/${OneSignalWrapper.sdkType}/${OneSignalWrapper.sdkVersion}")

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/time/ITime.kt

@@ -10,4 +10,9 @@ interface ITime {
      * current time and midnight, January 1, 1970 UTC).
      */
     val currentTimeMillis: Long
+
+    /**
+     * Returns how long the app has been running.
+     */
+    val processUptimeMillis: Long
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/time/impl/Time.kt

@@ -1,8 +1,14 @@
 package com.onesignal.core.internal.time.impl
 
+import android.os.Build
+import android.os.SystemClock
+import androidx.annotation.RequiresApi
 import com.onesignal.core.internal.time.ITime
 
 internal class Time : ITime {
     override val currentTimeMillis: Long
         get() = System.currentTimeMillis()
+    override val processUptimeMillis: Long
+        @RequiresApi(Build.VERSION_CODES.N)
+        get() = SystemClock.uptimeMillis() - android.os.Process.getStartUptimeMillis()
 }

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/crash/IOneSignalCrashReporter.kt

@@ -0,0 +1,5 @@
+package com.onesignal.debug.internal.crash
+
+internal interface IOneSignalCrashReporter {
+    suspend fun saveCrash(thread: Thread, throwable: Throwable)
+}

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/debug/internal/crash/OneSignalCrashHandler.kt

@@ -0,0 +1,64 @@
+package com.onesignal.debug.internal.crash
+
+import kotlinx.coroutines.runBlocking
+
+/**
+ * Purpose: Writes any crashes involving OneSignal to a file where they can
+ *          later be send to OneSignal to help improve reliability.
+ * NOTE: For future refactors, code is written assuming this is a singleton
+ */
+internal class OneSignalCrashHandler(
+    private val _crashReporter: IOneSignalCrashReporter,
+) : Thread.UncaughtExceptionHandler {
+    private var existingHandler: Thread.UncaughtExceptionHandler? = null
+    private val seenThrowables: MutableList<Throwable> = mutableListOf()
+
+    init {
+        existingHandler = Thread.getDefaultUncaughtExceptionHandler()
+        Thread.setDefaultUncaughtExceptionHandler(this)
+    }
+
+    override fun uncaughtException(thread: Thread, throwable: Throwable) {
+        // Ensure we never attempt to process the same throwable instance
+        // more than once. This would only happen if there was another crash
+        // handler and was faulty in a specific way.
+        synchronized(seenThrowables) {
+            if (seenThrowables.contains(throwable)) {
+                return
+            }
+            seenThrowables.add(throwable)
+        }
+
+        // TODO: Catch anything we may throw and print only to logcat
+        // TODO: Also send a stop command to OneSignalCrashUploader,
+        //   give a bit of time to finish and then call existingHandler.
+        //   * This way the app doesn't have to open a 2nd time to get the
+        //     crash report and should help prevent duplicated reports.
+        if (!isOneSignalAtFault(throwable)) {
+            existingHandler?.uncaughtException(thread, throwable)
+            return
+        }
+
+        /**
+         * NOTE: The order and running sequentially is important as:
+         * The existingHandler.uncaughtException can immediately terminate the
+         * process, either directly (if this is Android's
+         * KillApplicationHandler) OR the app's handler / 3rd party SDK (either
+         * directly or more likely, by it calling Android's
+         * KillApplicationHandler).
+         * Given this, we can't parallelize the existingHandler work with ours.
+         * The safest thing is to try to finish our work as fast as possible
+         * (including ensuring our logging write buffers are flushed) then call
+         * the existingHandler so any crash handlers the app also has gets the
+         * crash even too.
+         *
+         * NOTE: addShutdownHook() isn't a workaround as it doesn't fire for
+         * Process.killProcess, which KillApplicationHandler calls.
+         */
+        runBlocking { _crashReporter.saveCrash(thread, throwable) }
+        existingHandler?.uncaughtException(thread, throwable)
+    }
+}
+
+internal fun isOneSignalAtFault(throwable: Throwable): Boolean =
+    throwable.stackTrace.any { it.className.startsWith("com.onesignal") }

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

@@ -0,0 +1,17 @@
+package com.onesignal.debug.internal.logging.otel
+
+import io.opentelemetry.api.logs.LogRecordBuilder
+import io.opentelemetry.sdk.common.CompletableResultCode
+import io.opentelemetry.sdk.logs.export.LogRecordExporter
+
+internal interface IOneSignalOpenTelemetry {
+    suspend fun getLogger(): LogRecordBuilder
+
+    suspend fun forceFlush(): CompletableResultCode
+}
+
+internal interface IOneSignalOpenTelemetryCrash : IOneSignalOpenTelemetry
+
+internal interface IOneSignalOpenTelemetryRemote : IOneSignalOpenTelemetry {
+    val logExporter: LogRecordExporter
+}