Memfault BORT SDK 4.19.0 (Build 2345299)

Author: Memfault Inc.

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Memfault Bort Changelog
 
+## v4.19.0 - August 13, 2024
+
+### :rocket: New Features
+
+- Added support for automatically collecting the phone's IMEI number as a
+  metric: `phone.imei`.
+- Updates the Stable Hours algorithm. By default, only ANRs, non-WTF app
+  crashes, kernel panics, and tombstones count as "crashes" for the purposes of
+  the algorithm. It is now also possible to exclude these crashes from the
+  algorithm if desired (please reach out to customer support for more
+  information).
+
+### :chart_with_upwards_trend: Improvements
+
+- Fixed a bug in the battery per-hour charge and discharge calculations where
+  the wrong denominator was being used.
+- Fixed a bug in the SDK where heartbeats after reboots could fail to process.
+- Fixed a bug in the SDK where batterystats collection could fail
+  inconsistently.
+- Added the device serial and override to the diagnostics content provider.
+- Disables metrics handling in more places if Bort is also disabled.
+
+### :house: Internal
+
+- Added more internal metrics to detect how often the Bort app restarts.
+- Cleaned up spurious Bort logs.
+- Fixed bug when tracking Bort's own battery usage.
+
 ## v4.18.0 - July 1, 2024
 
 ### :rocket: New Features
@@ -993,7 +1021,7 @@ documentation.
   provided, the `dumpstate.memfault.requestid` system property is set to the
   value provided. Additionally, a BroadcastReceiver can be specified to which
   the status of the bug report request will be reported by Bort. See
-  https://mflt.io/android-bort-sdk for details.
+  <https://mflt.io/android-bort-sdk> for details.
   > NOTE: in order to use this feature, the AOSP system image has to be updated
   > (merely updating MemfaultBort.apk is not sufficient, because this feature
   > also involved a change in the MemfaultDumpstateRunner system component).
@@ -1025,13 +1053,13 @@ documentation.
 - Have you ever wondered how the metrics in your device timelines are trending
   across your whole fleet? With the 3.0.0 version of Bort, now you can view
   visualizations of these metrics aggregated across all your devices! See
-  https://mflt.io/fleet-wide-metrics for details.
+  <https://mflt.io/fleet-wide-metrics> for details.
 - The aforementioned "experimental" data source is now ready for prime time! It
   can be used to collect traces and metrics, with additional data sources coming
-  in future SDK releases. See https://mflt.io/memfault-caliper for details.
+  in future SDK releases. See <https://mflt.io/memfault-caliper> for details.
 - Reboot events were added in an earlier version of the SDK but didn't make it
   into the changelog. Let's call that a 3.0 feature too! See
-  https://mflt.io/android-reboot-reasons to learn more.
+  <https://mflt.io/android-reboot-reasons> to learn more.
 
 ## v2.9.1 - December 3, 2020
 
@@ -1317,7 +1345,7 @@ documentation.
   it, add an intent filter with the launcher category to an activity in the
   `AndroidManifest`.
 
-```
+```xml
 <intent-filter>
   <action android:name="android.intent.action.MAIN" />
   <category android:name="android.intent.category.LAUNCHER" />

MemfaultDumpster/ContinuousLogcat.cpp

@@ -217,7 +217,7 @@ void ContinuousLogcat::run() {
     // don't block when the buffer ends (equivalent to logcat -d), this does not prevent blocking in wrapping scenarios
     int log_mode = ANDROID_LOG_NONBLOCK;
 
-    // if we are not doing an inmmediate dump, use wrapping behavior
+    // if we are not doing an immediate dump, use wrapping behavior
     if (!dump_after_intr) {
       log_mode |= ANDROID_LOG_WRAP;
     }

MemfaultPackages/bort-ota-lib/src/main/java/com/memfault/bort/ota/lib/PeriodicSoftwareUpdateWorker.kt

@@ -17,6 +17,7 @@ import com.memfault.bort.shared.runAndTrackExceptions
 import dagger.assisted.Assisted
 import dagger.assisted.AssistedInject
 import java.util.concurrent.TimeUnit
+import kotlin.time.toJavaDuration
 
 /**
  * A periodic worker that triggers an update check.
@@ -54,7 +55,7 @@ class PeriodicSoftwareUpdateWorker @AssistedInject constructor(
                     JitterDelayProvider(
                         jitterDelayConfiguration = { JitterDelayProvider.ApplyJitter.APPLY },
                         devMode = DEV_MODE_DISABLED,
-                    ).randomJitterDelay(),
+                    ).randomJitterDelay().toJavaDuration(),
                 )
             }.build()
 

MemfaultPackages/bort-shared/src/main/java/com/memfault/bort/settings/FetchedSettings.kt

@@ -270,6 +270,9 @@ data class FetchedSettings(
     @Serializable(with = DurationAsMillisecondsLong::class)
     val metricsCollectionInterval: BoxedDuration,
 
+    @SerialName("metrics.operational_crashes_exclusions")
+    val metricsOperationalCrashesExclusions: List<String> = listOf(),
+
     @SerialName("metrics.data_source_enabled")
     val metricsDataSourceEnabled: Boolean,
 
@@ -294,6 +297,9 @@ data class FetchedSettings(
     @SerialName("network.collection_transmit_threshold_kb")
     val networkCollectionTransmitThresholdKb: Long = 1_000L,
 
+    @SerialName("metrics.record_imei")
+    val metricsRecordImei: Boolean = false,
+
     @SerialName("metrics.reporter_collection_interval_ms")
     @Serializable(with = DurationAsMillisecondsLong::class)
     val metricsReporterCollectionInterval: BoxedDuration = 10.minutes.boxed(),

MemfaultPackages/bort-shared/src/main/java/com/memfault/bort/shared/JitterDelayProvider.kt

@@ -2,10 +2,11 @@ package com.memfault.bort.shared
 
 import com.memfault.bort.DevMode
 import com.memfault.bort.shared.JitterDelayProvider.ApplyJitter.APPLY
-import java.time.Duration
-import java.time.Duration.ZERO
 import javax.inject.Inject
 import kotlin.random.Random
+import kotlin.time.Duration
+import kotlin.time.Duration.Companion.milliseconds
+import kotlin.time.Duration.Companion.minutes
 
 /**
  * Generate a random jittery delay for server calls.
@@ -14,13 +15,11 @@ class JitterDelayProvider @Inject constructor(
     private val jitterDelayConfiguration: JitterDelayConfiguration,
     private val devMode: DevMode,
 ) {
-    // Uses Java's Duration type: Kotlin's Duration is an inline class which causes a crash when a return value is
-    // accessed from another module.
-    fun randomJitterDelay(maxDelay: Duration = MAX_JITTER_DELAY): Duration =
+    fun randomJitterDelay(maxDelay: Duration = DEFAULT_JITTER_DELAY): Duration =
         if (!devMode.isEnabled() && jitterDelayConfiguration.applyJitter() == APPLY) {
-            Duration.ofMillis(Random.nextLong(0, maxDelay.toMillis()))
+            Random.nextLong(0, maxDelay.inWholeMilliseconds).milliseconds
         } else {
-            ZERO
+            Duration.ZERO
         }
 
     enum class ApplyJitter {
@@ -29,7 +28,7 @@ class JitterDelayProvider @Inject constructor(
     }
 
     companion object {
-        private const val MAX_JITTER_DELAY_MINUTES: Long = 15
-        private val MAX_JITTER_DELAY = Duration.ofMinutes(MAX_JITTER_DELAY_MINUTES)
+        private const val DEFAULT_JITTER_DELAY_MINUTES: Long = 15
+        private val DEFAULT_JITTER_DELAY = DEFAULT_JITTER_DELAY_MINUTES.minutes
     }
 }

MemfaultPackages/bort/src/main/AndroidManifest.xml

@@ -28,6 +28,10 @@
     <uses-permission
         android:name="android.permission.WRITE_SECURE_SETTINGS"
         tools:ignore="ProtectedPermissions" />
+    <!-- Read IMEI -->
+    <uses-permission
+        android:name="android.permission.READ_PRIVILEGED_PHONE_STATE"
+        tools:ignore="ProtectedPermissions" />
 
     <permission
         android:name="com.memfault.bort.permission.CONTROL"

MemfaultPackages/bort/src/main/java/com/memfault/bort/clientserver/MarBatchingTask.kt

@@ -51,7 +51,6 @@ import kotlin.time.Duration
 import kotlin.time.Duration.Companion.ZERO
 import kotlin.time.Duration.Companion.minutes
 import kotlin.time.toJavaDuration
-import kotlin.time.toKotlinDuration
 
 /**
  * Can be either periodic or one-time.
@@ -193,10 +192,10 @@ class PeriodicMarUploadRequester @Inject constructor(
 ) : PeriodicWorkRequester() {
     override suspend fun startPeriodic(justBooted: Boolean, settingsChanged: Boolean) {
         // Jitter is based on the mar batching period.
-        val maxJitterDelay = httpApiSettings.batchedMarUploadPeriod.toJavaDuration()
+        val maxJitterDelay = httpApiSettings.batchedMarUploadPeriod
         val jitter: Duration
         val bootDelay = if (justBooted) 5.minutes else ZERO
-        jitter = bootDelay + jitterDelayProvider.randomJitterDelay(maxDelay = maxJitterDelay).toKotlinDuration()
+        jitter = bootDelay + jitterDelayProvider.randomJitterDelay(maxDelay = maxJitterDelay)
         MarBatchingTask.schedulePeriodicMarBatching(
             context = application,
             period = httpApiSettings.batchedMarUploadPeriod,

MemfaultPackages/bort/src/main/java/com/memfault/bort/diagnostics/BortDiagnosticsProvider.kt

@@ -7,6 +7,8 @@ import android.database.DatabaseUtils
 import android.database.MatrixCursor
 import android.net.Uri
 import com.memfault.bort.DevMode
+import com.memfault.bort.DeviceInfoProvider
+import com.memfault.bort.OverrideSerial
 import com.memfault.bort.ProjectKeySyspropName
 import com.memfault.bort.requester.PeriodicWorkRequester.PeriodicWorkManager
 import com.memfault.bort.settings.AllowProjectKeyChange
@@ -35,6 +37,8 @@ class BortDiagnosticsProvider : ContentProvider() {
         fun bortErrors(): BortErrors
         fun periodicWorkManager(): PeriodicWorkManager
         fun bortJobReporter(): BortJobReporter
+        fun deviceInfoProvider(): DeviceInfoProvider
+        fun overrideSerial(): OverrideSerial
     }
 
     val entryPoint: DiagnosticsProviderEntryPoint by lazy {
@@ -72,6 +76,8 @@ class BortDiagnosticsProvider : ContentProvider() {
                 cursor.addRow(arrayOf("bort_error", it.toString()))
             }
             addJobStatus(cursor)
+            cursor.addRow(arrayOf("device_serial", entryPoint.deviceInfoProvider().getDeviceInfo().deviceSerial))
+            cursor.addRow(arrayOf("override_serial", entryPoint.overrideSerial().overriddenSerial))
         }
         Logger.d("Bort Diagnostics:")
         Logger.d(DatabaseUtils.dumpCursorToString(cursor))

MemfaultPackages/bort/src/main/java/com/memfault/bort/dropbox/AnrUploadingEntryProcessorDelegate.kt

@@ -2,6 +2,7 @@ package com.memfault.bort.dropbox
 
 import android.os.DropBoxManager
 import com.memfault.bort.parsers.AnrParser
+import com.memfault.bort.settings.OperationalCrashesExclusions
 import com.memfault.bort.shared.Logger
 import com.memfault.bort.tokenbucket.Anr
 import com.memfault.bort.tokenbucket.TokenBucketStore
@@ -10,6 +11,7 @@ import javax.inject.Inject
 
 class AnrUploadingEntryProcessorDelegate @Inject constructor(
     @Anr private val tokenBucketStore: TokenBucketStore,
+    private val operationalCrashesExclusions: OperationalCrashesExclusions,
 ) : UploadingEntryProcessorDelegate {
     override val tags = listOf(
         "data_app_anr",
@@ -31,5 +33,6 @@ class AnrUploadingEntryProcessorDelegate @Inject constructor(
         EntryInfo(entry.tag)
     }
 
-    override fun isCrash(tag: String): Boolean = true
+    override fun isCrash(entry: DropBoxManager.Entry, entryFile: File): Boolean =
+        entry.tag !in operationalCrashesExclusions()
 }

MemfaultPackages/bort/src/main/java/com/memfault/bort/dropbox/JavaExceptionUploadingEntryProcessorDelegate.kt

@@ -2,6 +2,7 @@ package com.memfault.bort.dropbox
 
 import android.os.DropBoxManager
 import com.memfault.bort.parsers.JavaExceptionParser
+import com.memfault.bort.settings.OperationalCrashesExclusions
 import com.memfault.bort.tokenbucket.JavaException
 import com.memfault.bort.tokenbucket.TokenBucketStore
 import com.memfault.bort.tokenbucket.Wtf
@@ -14,6 +15,7 @@ class JavaExceptionUploadingEntryProcessorDelegate @Inject constructor(
     @JavaException private val javaExceptionTokenBucketStore: TokenBucketStore,
     @Wtf private val wtfTokenBucketStore: TokenBucketStore,
     @WtfTotal private val wtfTotalTokenBucketStore: TokenBucketStore,
+    private val operationalCrashesExclusions: OperationalCrashesExclusions,
 ) : UploadingEntryProcessorDelegate {
     override val tags = listOf(
         "data_app_crash",
@@ -52,7 +54,13 @@ class JavaExceptionUploadingEntryProcessorDelegate @Inject constructor(
             EntryInfo(entry.tag)
         }
 
-    override fun isCrash(tag: String): Boolean = !isWtf(tag)
+    override fun isCrash(entry: DropBoxManager.Entry, entryFile: File): Boolean {
+        if (entry.tag in operationalCrashesExclusions()) {
+            return false
+        }
+
+        return !isWtf(entry.tag)
+    }
 
     companion object {
         private fun isWtf(tag: String): Boolean = tag.endsWith("wtf")