Memfault BORT SDK 4.17.0 (Build 2186875)

Author: Memfault Inc.

CHANGELOG.md

@@ -1,5 +1,39 @@
 # Memfault Bort Changelog
 
+## v4.17.0 - June 24, 2024
+
+### :rocket: New Features
+
+- Support for the new [Session](https://mflt.io/android-sessions) metrics. This
+  enables Memfault to be used for more product-specific use cases by associating
+  metrics to product functionality.
+  - The latest reporting-lib on each platform have been updated to start, end,
+    and record metrics to sessions (reporting-lib 1.5 has been published to
+    Maven with Sessions support).
+  - Every session will automatically include relevant `sync_successful`,
+    `sync_failure`, `memfault_sync_successful`, `memfault_sync_failure`,
+    `connectivity_expected_time_ms` and `connectivity_connected_time_ms` Device
+    Vitals metrics. `operational_crashes` will also be automatically recorded,
+    even if the value is 0.
+- Support for new Daily Heartbeats has been added. This enables support for
+  daily metric aggregations to supplement or replace Hourly Heartbeats for lower
+  upload frequency use cases. Please contact us for more information.
+  - Daily Heartbeats will contain every metric that Hourly Heartbeats do,
+    besides batterystats at the moment.
+
+### :chart_with_upwards_trend: Improvements
+
+- The `structuredlogd` metrics database has been replaced by a Room database
+  inside the Bort app. This move allows us to more quickly iterate on
+  improvements to how metrics are persisted. The `structuredlogd` service now
+  forwards all calls to the Bort app for backwards compatibility.
+- Bort Lite's serial can be overridden using by sending an
+  `INTENT_ACTION_OVERRIDE_SERIAL` intent with an `INTENT_EXTRA_SERIAL` string
+  extra.
+- DropBox is now queried when Bort starts in Dev Mode.
+- A bug was fixed where Device information would be incorrectly cached until
+  Bort restarted.
+
 ## v4.16.0 - May 28, 2024
 
 ### :rocket: New Features

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

@@ -32,6 +32,7 @@ class FallbackOtaSettings @Inject constructor(
             deviceInfoSettings = bundledSdkSettings.deviceInfoSettings(),
             dumpsterClient = dumpsterClient,
             application = application,
+            overrideSerial = NoOpOverrideSerial,
         )
     }
     private val deviceInfo by lazy { runBlocking { deviceInfoProvider.getDeviceInfo() } }

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

@@ -12,6 +12,7 @@ data class DeviceInfoParams(
     val androidBuildVersionKey: String,
     val androidHardwareVersionKey: String,
     val androidSerialNumberKey: String,
+    val overriddenSerialNumber: String?,
 )
 
 data class DeviceInfo(
@@ -34,7 +35,7 @@ data class DeviceInfo(
                     "${getBuildFingerprint()}::${props[settings.androidBuildVersionKey] ?: "unknown"}"
             }
             return DeviceInfo(
-                props[settings.androidSerialNumberKey] ?: getFallbackAndroidId(),
+                settings.overriddenSerialNumber ?: props[settings.androidSerialNumberKey] ?: getFallbackAndroidId(),
                 hardwareVersionFromSettingsAndSystemProperties(settings, props),
                 softwareVersion,
             )

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

@@ -20,6 +20,7 @@ class RealDeviceInfoProvider @Inject constructor(
     private val deviceInfoSettings: DeviceInfoSettings,
     private val dumpsterClient: DumpsterClient,
     private val application: Application,
+    private val overrideSerial: OverrideSerial,
 ) : DeviceInfoProvider {
     private val deviceInfo = CachedAsyncProperty {
         DeviceInfo.fromSettingsAndSystemProperties(
@@ -28,22 +29,23 @@ class RealDeviceInfoProvider @Inject constructor(
             application,
         )
     }
-    private var lastSettings = deviceInfoSettings.asParams()
+    private var lastSettings = deviceInfoSettings.asParams(overrideSerial)
     private val mutex = Mutex()
 
     override suspend fun getDeviceInfo(): DeviceInfo = mutex.withLock {
-        if (lastSettings != deviceInfoSettings.asParams()) {
+        if (lastSettings != deviceInfoSettings.asParams(overrideSerial)) {
             Logger.d("Invalidating deviceInfo")
-            lastSettings = deviceInfoSettings.asParams()
+            lastSettings = deviceInfoSettings.asParams(overrideSerial)
             deviceInfo.invalidate()
         }
         deviceInfo.get()
     }
 }
 
-private fun DeviceInfoSettings.asParams() = DeviceInfoParams(
+private fun DeviceInfoSettings.asParams(overrideSerial: OverrideSerial) = DeviceInfoParams(
     androidBuildFormat = androidBuildFormat,
     androidBuildVersionKey = androidBuildVersionKey,
     androidHardwareVersionKey = androidHardwareVersionKey,
     androidSerialNumberKey = androidSerialNumberKey,
+    overriddenSerialNumber = overrideSerial.overriddenSerial,
 )

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

@@ -0,0 +1,17 @@
+package com.memfault.bort
+
+/**
+ * Locally overridden serial number.
+ *
+ * This should only ever be used for Bort Lite (it does not affect bort-ota's fallback serial mechanism, so is not
+ * safe to use there).
+ */
+interface OverrideSerial {
+    var overriddenSerial: String?
+}
+
+val NoOpOverrideSerial = object : OverrideSerial {
+    override var overriddenSerial: String?
+        get() = null
+        set(_) = Unit
+}

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

@@ -40,6 +40,8 @@ import kotlinx.coroutines.launch
 import javax.inject.Inject
 import javax.inject.Singleton
 
+const val CONNECTIVITY_TYPE_METRIC = "connectivity.type"
+
 // Don't automatically include this in all apps using @ContributesMultibinding (it'll be included in OTA,
 // and Bort has to conditionally enable it only if UsageReporter is not installed).
 @Singleton
@@ -51,7 +53,7 @@ class ConnectivityMetrics
 ) : Scoped {
     private val connectivityMetric = Reporting.report()
         .stateTracker<ConnectivityState>(
-            name = "connectivity.type",
+            name = CONNECTIVITY_TYPE_METRIC,
             aggregations = listOf(TIME_PER_HOUR, TIME_TOTALS),
         )
     private val airplaneModeMetric = Reporting.report().boolStateTracker(name = "airplane_mode")
@@ -190,7 +192,7 @@ class ConnectivityMetrics
     }
 }
 
-private enum class ConnectivityState {
+enum class ConnectivityState {
     WIFI,
     CELLULAR,
     ETHERNET,

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

@@ -0,0 +1,16 @@
+package com.memfault.bort.json
+
+import android.util.JsonWriter
+import java.io.File
+
+inline fun File?.useJsonWriter(block: (JsonWriter?) -> Unit) {
+    if (this == null) {
+        block(null)
+    } else {
+        bufferedWriter().use { bufferedWriter ->
+            JsonWriter(bufferedWriter).use { jsonWriter ->
+                block(jsonWriter)
+            }
+        }
+    }
+}

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

@@ -384,6 +384,9 @@ data class FetchedSettings(
     @SerialName("metric_report.high_res_telemetry")
     val highResTelemetryEnabled: Boolean = true,
 
+    @SerialName("metric_report.daily_heartbeat")
+    val dailyHeartbeatEnabled: Boolean = false,
+
     @SerialName("storage.apps_size_data_source_enabled")
     val storageAppsSizeDataSourceEnabled: Boolean = true,
 

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

@@ -13,6 +13,8 @@ const val INTENT_EXTRA_BUG_REPORT_REQUEST_STATUS = "com.memfault.intent.extra.BU
 
 const val DROPBOX_ENTRY_ADDED_RECEIVER_QUALIFIED_NAME = "com.memfault.bort.receivers.DropBoxEntryAddedReceiver"
 
+const val APPLICATION_ID_MEMFAULT_STRUCTUREDLOGD = "com.memfault.structuredlogd"
+
 const val APPLICATION_ID_MEMFAULT_USAGE_REPORTER = "com.memfault.usagereporter"
 const val REPORTER_SERVICE_QUALIFIED_NAME = "$APPLICATION_ID_MEMFAULT_USAGE_REPORTER.ReporterService"
 

MemfaultPackages/bort/build.gradle

@@ -29,10 +29,8 @@ android {
         versionName loadVersionName() as String
 
         buildConfigField "Boolean", "RUNTIME_ENABLE_REQUIRED", bortProperty("RUNTIME_ENABLE_REQUIRED")
-        // This field isn't in the public bort.properties, so default to false. This will be removed
-        // in the future when the native service database is removed.
-        // This flag allows Bort Lite to use the internal metrics DB.
-        buildConfigField "Boolean", "INTERNAL_METRICS_DB", bortProperty("INTERNAL_METRICS_DB") ?: "false"
+        // This field isn't in the public bort.properties, so default to false.
+        buildConfigField "Boolean", "BORT_LITE", bortProperty("BORT_LITE") ?: "false"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"