Added support for collecting app metrics

build.gradle

@@ -27,6 +27,7 @@ buildscript {
         classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:$dokka_android_gradle_plugin_version"
         classpath("org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version")
         classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
+        classpath "androidx.room:room-gradle-plugin:$room_version"
     }
 }
 
@@ -58,6 +59,7 @@ subprojects {
     apply plugin: 'com.android.library'
     apply plugin: 'kotlin-android'
     apply plugin: 'idea'
+    apply plugin: 'kotlin-kapt'
 
 //---------------------------------------------------------------------------//
 // Sources and classpath configurations                                      //

gradle.properties

@@ -36,6 +36,8 @@ dokka_android_gradle_plugin_version=0.9.18
 dokka_version=1.9.20
 publish_plugin_version=2.0.0
 versions_plugin_version=0.51.0
+room_version=2.6.1
+paging_version=3.3.6
 
 radar_commons_version=1.1.2
 radar_schemas_commons_version=0.8.11

plugins/radar-android-application-status/README.md

@@ -22,20 +22,27 @@ To activate this plugin, add the provider `application_status` to the Firebase R
 
 This plugin takes the following Firebase configuration parameters:
 
-| Name | Type | Default | Description |
-| ---- | ---- | ------- | ----------- |
-| `ntp_server` | string | `<empty>` | NTP server to synchronize time with. If empty, time is not synchronized and the `application_external_time` topic will not receive data. |
-| `application_status_update_rate` | int (seconds) | `300` = 5 minutes | Rate at which to send data for all application topics. |
-| `application_send_ip` | boolean | `false` | Whether to send the device IP address with the server status. |
-| `application_time_zone_update_rate` | int (seconds) | `86400` = 1 day | How often to send the current time zone. Set to `0` to disable. |
+| Name                                           | Type          | Default                 | Description                                                                                                                                              |
+|------------------------------------------------|---------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `ntp_server`                                   | string        | `<empty>`               | NTP server to synchronize time with. If empty, time is not synchronized and the `application_external_time` topic will not receive data.                 |
+| `application_status_update_rate`               | int (seconds) | `300` = 5 minutes       | Rate at which to send data for all application topics.                                                                                                   |
+| `application_send_ip`                          | boolean       | `false`                 | Whether to send the device IP address with the server status.                                                                                            |
+| `application_time_zone_update_rate`            | int (seconds) | `86400` = 1 day         | How often to send the current time zone. Set to `0` to disable.                                                                                          |
+| `application_metrics_verification_update_rate` | int (seconds) | `300` = 5 minutes       | Defines the interval for verifying that records older than application_metrics_retention_time are not present. Set to 0 to disable.                      |
+| `application_metrics_buffer_size`              | int (count)   | `100`                   | Specifies the number of records to keep in the buffer before adding them to the database. Storing records in batches significantly improves performance. |
+| `application_metrics_retention_time`           | int (seconds) | `7*86400` = 7 day       | Determines how long application metrics are retained in the database. Records older than this value are automatically deleted.                           |
+| `application_metrics_data_retention_count`     | int (seconds) | `10000` = 10000 records | Specifies the maximum number of messages to retain for application metrics in the database. When this limit is exceeded, older messages are deleted.     |
 
 This plugin produces data for the following topics: (types starts with `org.radarcns.monitor.application` prefix)
 
-| Topic | Type | Description |
-| ----- | ---- | ----------- |
-| `application_external_time` | `ApplicationExternalTime` | External NTP time. Requires `ntp_server` parameter to be set. |
-| `application_record_counts` | `ApplicationRecordCounts` | Number of records sent and in queue. |
-| `application_uptime` | `ApplicationUptime` | Time since the device booted. |
-| `application_server_status` | `ApplicationServerStatus` | Server connection status. |
-| `application_time_zone` | `ApplicationTimeZone` | Application time zone. Data is only sent on updates. |
-| `application_device_info` | `ApplicationDeviceInfo` | Device information. Data is only sent on updates. |
+| Topic                            | Type                          | Description                                                                                                                                                                        |
+|----------------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `application_external_time`      | `ApplicationExternalTime`     | External NTP time. Requires `ntp_server` parameter to be set.                                                                                                                      |
+| `application_record_counts`      | `ApplicationRecordCounts`     | Number of records sent and in queue.                                                                                                                                               |
+| `application_uptime`             | `ApplicationUptime`           | Time since the device booted.                                                                                                                                                      |
+| `application_server_status`      | `ApplicationServerStatus`     | Server connection status.                                                                                                                                                          |
+| `application_time_zone`          | `ApplicationTimeZone`         | Application time zone. Data is only sent on updates.                                                                                                                               |
+| `application_device_info`        | `ApplicationDeviceInfo`       | Device information. Data is only sent on updates.                                                                                                                                  |
+| `application_network_status`     | `ApplicationNetworkStatus`    | Represents the network connectivity status of an application, indicating whether it is connected to the internet and, if so, whether the connection is via Wi-Fi or cellular data. |
+| `application_plugin_status`      | `ApplicationPluginStatus`     | Represents the status of a plugin, indicating its current connection state.                                                                                                        |
+| `application_topic_records_sent` | `ApplicationTopicRecordsSent` | Number of records sent for the topic since the last upload                                                                                                                         |

plugins/radar-android-application-status/build.gradle

@@ -13,9 +13,31 @@ description = "Application statistics plugin for RADAR passive remote monitoring
 // Sources and classpath configurations                                      //
 //---------------------------------------------------------------------------//
 
+android {
+    buildFeatures {
+        viewBinding true
+    }
+}
+
 dependencies {
     api project(":radar-commons-android")
     implementation "androidx.localbroadcastmanager:localbroadcastmanager:$localbroadcastmanager_version"
+    implementation "androidx.appcompat:appcompat:$appcompat_version"
+    implementation "com.google.android.material:material:$material_version"
+    implementation "androidx.activity:activity:1.9.0"
+    implementation "androidx.constraintlayout:constraintlayout:$constraintlayout_version"
+    implementation "androidx.legacy:legacy-support-v4:$legacy_support_version"
+    implementation 'androidx.fragment:fragment-ktx:1.8.1'
+
+    implementation "androidx.room:room-runtime:$room_version"
+    kapt "androidx.room:room-compiler:$room_version"
+    implementation "androidx.room:room-ktx:$room_version" // For Kotlin Coroutines support
+
+}
+
+afterEvaluate {
+    tasks["dokkaJavadoc"].dependsOn(tasks.getByName("kaptReleaseKotlin"), tasks.getByName("kaptDebugKotlin"))
 }
 
 apply from: "$rootDir/gradle/publishing.gradle"
+apply plugin: 'org.jetbrains.kotlin.android'

plugins/radar-android-application-status/src/main/AndroidManifest.xml

@@ -2,8 +2,14 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <application>
-        <service android:name=".ApplicationStatusService"
-            android:exported="false"
-            android:description="@string/application_status_description" />
+        <activity
+            android:name=".ui.ApplicationMetricsActivity"
+            android:exported="false" />
+
+        <service
+            android:name=".ApplicationStatusService"
+            android:description="@string/application_status_description"
+            android:exported="false" />
     </application>
-</manifest>
+
+</manifest>

plugins/radar-android-application-status/src/main/java/org/radarbase/monitor/application/ApplicationState.kt

@@ -18,9 +18,18 @@ package org.radarbase.monitor.application
 
 import org.radarbase.android.kafka.ServerStatus
 import org.radarbase.android.source.BaseSourceState
+import org.radarbase.android.storage.entity.NetworkStatusLog
+import org.radarbase.android.storage.entity.SourceStatusLog
 import java.util.concurrent.ConcurrentHashMap
+import java.util.concurrent.atomic.AtomicInteger
 
 class ApplicationState : BaseSourceState() {
+
+    var uiManager: UserInterfaceManager? = null
+
+    val sourceStatusBufferCount: AtomicInteger = AtomicInteger(0)
+    val networkStatusBufferCount: AtomicInteger = AtomicInteger(0)
+
     @set:Synchronized
     var serverStatus: ServerStatus? = null
         @Synchronized get() = field ?: ServerStatus.DISCONNECTED
@@ -29,10 +38,43 @@ class ApplicationState : BaseSourceState() {
     var recordsSent = 0L
         private set
 
+    val metricsCountPerTopic: MutableMap<String, Long> = ConcurrentHashMap()
     val cachedRecords: MutableMap<String, Long> = ConcurrentHashMap()
+    val recordsSentPerTopic: MutableMap<String, Long> = ConcurrentHashMap()
+    private val sourceStatusBuffer: MutableList<SourceStatusLog> = mutableListOf()
+    private val networkStatusBuffer: MutableList<NetworkStatusLog> = mutableListOf()
+
+    fun addSourceStatus(status: SourceStatusLog) {
+        sourceStatusBuffer.add(status)
+    }
+
+    fun clearSourceStatuses() {
+        sourceStatusBuffer.clear()
+    }
+
+    fun clearNetworkStatuses() {
+        networkStatusBuffer.clear()
+    }
+
+    fun getSourceStatuses(): List<SourceStatusLog> {
+        return sourceStatusBuffer
+    }
+
+    fun addNetworkStatus(status: NetworkStatusLog) {
+        networkStatusBuffer.add(status)
+    }
+
+    fun getNetworkStatuses(): List<NetworkStatusLog> {
+        return networkStatusBuffer
+    }
 
     @Synchronized
     fun addRecordsSent(nRecords: Long) {
         recordsSent += nRecords
     }
+
+    interface UserInterfaceManager {
+        fun sendSourceStatus()
+        fun sendNetworkStatus()
+    }
 }