Merge pull request #2629 from DataDog/aleksandr-gringauz/RUM-9508/logs-scenarios-heavy-4

RUM-9508: LogsHeavyTraffic scenario for android benchmarks

Author: aleksandr-gringauz

sample/benchmark/src/main/java/com/datadog/benchmark/sample/MainActivity.kt

@@ -10,11 +10,11 @@ import android.app.Activity
 import android.os.Bundle
 import androidx.activity.compose.setContent
 import androidx.appcompat.app.AppCompatActivity
+import androidx.lifecycle.ViewModelProvider
 import androidx.navigation.findNavController
 import com.datadog.benchmark.DatadogBaseMeter
 import com.datadog.benchmark.sample.config.BenchmarkConfig
 import com.datadog.benchmark.sample.di.activity.BenchmarkActivityComponent
-import com.datadog.benchmark.sample.di.activity.DaggerBenchmarkActivityComponent
 import com.datadog.benchmark.sample.navigation.FragmentsNavigationManager
 import com.datadog.benchmark.sample.ui.sessionreplaycompose.MainView
 import com.datadog.sample.benchmark.R
@@ -34,20 +34,17 @@ class MainActivity : AppCompatActivity() {
     @Inject
     internal lateinit var datadogFeaturesInitializer: DatadogFeaturesInitializer
 
-    private lateinit var config: BenchmarkConfig
+    @Inject
+    internal lateinit var config: BenchmarkConfig
 
-    internal lateinit var benchmarkActivityComponent: BenchmarkActivityComponent
+    internal lateinit var viewModel: MainActivityViewModel
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
-        config = BenchmarkConfig.resolveSyntheticsBundle(intent.extras)
+        val factory = MainActivityViewModelFactory(application, this)
 
-        benchmarkActivityComponent = DaggerBenchmarkActivityComponent.factory().create(
-            deps = application.benchmarkAppComponent,
-            config = config,
-            mainActivity = this
-        )
+        viewModel = ViewModelProvider(this, factory)[MainActivityViewModel::class]
 
         benchmarkActivityComponent.inject(this)
 
@@ -82,4 +79,4 @@ class MainActivity : AppCompatActivity() {
 }
 
 internal val Activity.benchmarkActivityComponent: BenchmarkActivityComponent
-    get() = (this as MainActivity).benchmarkActivityComponent
+    get() = (this as MainActivity).viewModel.component

sample/benchmark/src/main/java/com/datadog/benchmark/sample/MainActivityViewModel.kt

@@ -0,0 +1,36 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.benchmark.sample
+
+import android.app.Application
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.ViewModelProvider
+import com.datadog.benchmark.sample.config.BenchmarkConfig
+import com.datadog.benchmark.sample.di.activity.BenchmarkActivityComponent
+import com.datadog.benchmark.sample.di.activity.DaggerBenchmarkActivityComponent
+
+internal class MainActivityViewModel(
+    val component: BenchmarkActivityComponent
+) : ViewModel()
+
+internal class MainActivityViewModelFactory(
+    private val application: Application,
+    private val activity: MainActivity
+) : ViewModelProvider.Factory {
+    @Suppress("UNCHECKED_CAST")
+    override fun <T : ViewModel> create(modelClass: Class<T>): T {
+        val config = BenchmarkConfig.resolveSyntheticsBundle(activity.intent.extras)
+
+        val benchmarkActivityComponent = DaggerBenchmarkActivityComponent.factory().create(
+            deps = application.benchmarkAppComponent,
+            config = config,
+            mainActivity = activity
+        )
+
+        return MainActivityViewModel(benchmarkActivityComponent) as T
+    }
+}

sample/benchmark/src/main/java/com/datadog/benchmark/sample/di/activity/BenchmarkActivityComponent.kt

@@ -10,7 +10,9 @@ import com.datadog.android.api.SdkCore
 import com.datadog.benchmark.sample.DatadogFeaturesInitializer
 import com.datadog.benchmark.sample.MainActivity
 import com.datadog.benchmark.sample.config.BenchmarkConfig
+import com.datadog.benchmark.sample.di.common.DispatchersModule
 import com.datadog.benchmark.sample.ui.logscustom.LogsFragment
+import com.datadog.benchmark.sample.ui.logsheavytraffic.di.LogsHeavyTrafficComponentDependencies
 import com.datadog.benchmark.sample.ui.sessionreplay.SessionReplayAppcompatFragment
 import com.datadog.benchmark.sample.ui.sessionreplay.SessionReplayMaterialFragment
 import dagger.BindsInstance
@@ -32,11 +34,12 @@ internal interface BenchmarkActivityComponentDependencies {
     modules = [
         BenchmarkActivityModule::class,
         ViewModelsModule::class,
-        DatadogActivityModule::class
+        DatadogActivityModule::class,
+        DispatchersModule::class
     ]
 )
 @BenchmarkActivityScope
-internal interface BenchmarkActivityComponent {
+internal interface BenchmarkActivityComponent : LogsHeavyTrafficComponentDependencies {
     @Component.Factory
     interface Factory {
         fun create(

sample/benchmark/src/main/java/com/datadog/benchmark/sample/di/activity/DatadogActivityModule.kt

@@ -6,6 +6,8 @@
 
 package com.datadog.benchmark.sample.di.activity
 
+import com.datadog.android.api.SdkCore
+import com.datadog.android.log.Logger
 import com.datadog.benchmark.DatadogBaseMeter
 import com.datadog.benchmark.DatadogExporterConfiguration
 import com.datadog.benchmark.DatadogSdkMeter
@@ -37,6 +39,15 @@ internal interface DatadogActivityModule {
                 DatadogVitalsMeter.create(exporterConfig)
             }
         }
+
+        @Provides
+        @BenchmarkActivityScope
+        fun provideLogger(sdkCore: SdkCore): Logger {
+            return Logger.Builder(sdkCore)
+                .setName("benchmarkLogger")
+                .setLogcatLogsEnabled(true)
+                .build()
+        }
     }
 }
 

sample/benchmark/src/main/java/com/datadog/benchmark/sample/di/activity/ViewModelsModule.kt

@@ -9,12 +9,13 @@ package com.datadog.benchmark.sample.di.activity
 import androidx.lifecycle.ViewModelProvider
 import androidx.lifecycle.viewmodel.initializer
 import androidx.lifecycle.viewmodel.viewModelFactory
-import com.datadog.android.api.SdkCore
 import com.datadog.android.log.Logger
+import com.datadog.benchmark.sample.di.common.CoroutineDispatcherQualifier
+import com.datadog.benchmark.sample.di.common.CoroutineDispatcherType
 import com.datadog.benchmark.sample.ui.logscustom.LogsScreenViewModel
 import dagger.Module
 import dagger.Provides
-import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.CoroutineDispatcher
 import javax.inject.Qualifier
 import kotlin.reflect.KClass
 
@@ -27,17 +28,14 @@ internal interface ViewModelsModule {
         @Provides
         @ViewModel(LogsScreenViewModel::class)
         fun provideLogsScreenViewModelFactory(
-            sdkCore: SdkCore
+            logger: Logger,
+            @CoroutineDispatcherQualifier(CoroutineDispatcherType.Default)
+            defaultDispatcher: CoroutineDispatcher
         ): ViewModelProvider.Factory = viewModelFactory {
             initializer {
-                val logger = Logger.Builder(sdkCore)
-                    .setName("benchmarkLogger")
-                    .setLogcatLogsEnabled(true)
-                    .build()
-
                 LogsScreenViewModel(
                     logger = logger,
-                    defaultDispatcher = Dispatchers.Default
+                    defaultDispatcher = defaultDispatcher
                 )
             }
         }

sample/benchmark/src/main/java/com/datadog/benchmark/sample/di/common/DispatchersModule.kt

@@ -0,0 +1,35 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.benchmark.sample.di.common
+
+import dagger.Module
+import dagger.Provides
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Dispatchers
+import javax.inject.Qualifier
+
+internal enum class CoroutineDispatcherType {
+    IO, Default, Main
+}
+
+@Qualifier
+internal annotation class CoroutineDispatcherQualifier(val type: CoroutineDispatcherType)
+
+@Module
+internal object DispatchersModule {
+    @Provides
+    @CoroutineDispatcherQualifier(CoroutineDispatcherType.Default)
+    fun provideDefaultDispatcher(): CoroutineDispatcher = Dispatchers.Default
+
+    @Provides
+    @CoroutineDispatcherQualifier(CoroutineDispatcherType.Main)
+    fun provideMainDispatcher(): CoroutineDispatcher = Dispatchers.Main
+
+    @Provides
+    @CoroutineDispatcherQualifier(CoroutineDispatcherType.IO)
+    fun provideIODispatcher(): CoroutineDispatcher = Dispatchers.IO
+}

sample/benchmark/src/main/java/com/datadog/benchmark/sample/navigation/FragmentsNavigationManagerImpl.kt

@@ -14,6 +14,7 @@ import androidx.navigation.fragment.fragment
 import com.datadog.benchmark.sample.config.BenchmarkConfig
 import com.datadog.benchmark.sample.config.SyntheticsScenario
 import com.datadog.benchmark.sample.ui.logscustom.LogsFragment
+import com.datadog.benchmark.sample.ui.logsheavytraffic.LogsHeavyTrafficHostFragment
 import com.datadog.benchmark.sample.ui.sessionreplay.SessionReplayAppcompatFragment
 import com.datadog.benchmark.sample.ui.sessionreplay.SessionReplayMaterialFragment
 import javax.inject.Inject
@@ -52,9 +53,9 @@ private fun createStartDestination(scenario: SyntheticsScenario?): String {
         SyntheticsScenario.Upload -> SESSION_REPLAY_METERIAL_FRAGMENT_KEY
         SyntheticsScenario.SessionReplayCompose -> error("Using fragments for SessionReplayCompose scenario")
         SyntheticsScenario.LogsCustom -> LOGS_FRAGMENT_KEY
+        SyntheticsScenario.LogsHeavyTraffic -> LOGS_HEAVY_TRAFFIC_FRAGMENT_KEY
         SyntheticsScenario.Rum, // TODO RUM-9510
-        SyntheticsScenario.Trace, // TODO RUM-9509
-        SyntheticsScenario.LogsHeavyTraffic -> SESSION_REPLAY_METERIAL_FRAGMENT_KEY // TODO RUM-9508
+        SyntheticsScenario.Trace -> SESSION_REPLAY_METERIAL_FRAGMENT_KEY // TODO RUM-9509
     }
 }
 
@@ -65,9 +66,15 @@ private fun NavGraphBuilder.navGraph(scenario: SyntheticsScenario?) {
         SyntheticsScenario.Upload -> navGraphSessionReplay()
         SyntheticsScenario.SessionReplayCompose -> error("Using fragments for SessionReplayCompose scenario")
         SyntheticsScenario.LogsCustom -> navGraphLogs()
+        SyntheticsScenario.LogsHeavyTraffic -> navGraphLogsHeavyTraffic()
         SyntheticsScenario.Rum, // TODO RUM-9510
-        SyntheticsScenario.Trace, // TODO RUM-9509
-        SyntheticsScenario.LogsHeavyTraffic -> navGraphSessionReplay() // TODO RUM-9508
+        SyntheticsScenario.Trace -> navGraphSessionReplay() // TODO RUM-9509
+    }
+}
+
+private fun NavGraphBuilder.navGraphLogsHeavyTraffic() {
+    fragment<LogsHeavyTrafficHostFragment>(route = LOGS_HEAVY_TRAFFIC_FRAGMENT_KEY) {
+        label = "logs heavy traffic fragment"
     }
 }
 
@@ -88,5 +95,6 @@ private fun NavGraphBuilder.navGraphSessionReplay() {
 }
 
 private const val LOGS_FRAGMENT_KEY = "logs_fragment"
+private const val LOGS_HEAVY_TRAFFIC_FRAGMENT_KEY = "logs_heavy_traffic_fragment"
 private const val SESSION_REPLAY_METERIAL_FRAGMENT_KEY = "fragment_session_replay_material"
 private const val SESSION_REPLAY_APPCOMPAT_FRAGMENT_KEY = "fragment_session_replay_appcompat"

sample/benchmark/src/main/java/com/datadog/benchmark/sample/ui/logscustom/LogPayloadUtils.kt renamed to sample/benchmark/src/main/java/com/datadog/benchmark/sample/ui/LogPayloadUtils.kt

@@ -4,12 +4,19 @@
  * Copyright 2016-Present Datadog, Inc.
  */
 
-@file:Suppress("StringLiteralDuplication")
+@file:Suppress("StringLiteralDuplication", "MatchingDeclarationName")
 
-package com.datadog.benchmark.sample.ui.logscustom
+package com.datadog.benchmark.sample.ui
 
+import android.util.Log
 import java.util.UUID
 
+internal enum class LogPayloadSize {
+    Small,
+    Medium,
+    Large
+}
+
 internal fun LogPayloadSize.createLogAttributes(): Map<String, Any?> {
     return when (this) {
         LogPayloadSize.Small -> SMALL_ATTRIBUTES_PAYLOAD
@@ -18,6 +25,27 @@ internal fun LogPayloadSize.createLogAttributes(): Map<String, Any?> {
     }
 }
 
+internal val ALL_LOG_LEVELS = listOf(
+    Log.ERROR,
+    Log.VERBOSE,
+    Log.ASSERT,
+    Log.WARN,
+    Log.INFO,
+    Log.DEBUG
+)
+
+internal fun Int.logStringRepresentation(): String {
+    return when (this) {
+        Log.ERROR -> "ERROR"
+        Log.VERBOSE -> "VERBOSE"
+        Log.ASSERT -> "ASSERT"
+        Log.WARN -> "WARN"
+        Log.INFO -> "INFO"
+        Log.DEBUG -> "DEBUG"
+        else -> "UNKNOWN"
+    }
+}
+
 private val MEDIUM_ATTRIBUTES_PAYLOAD = mapOf(
     "benchmark_user" to mapOf(
         "id" to UUID.randomUUID().toString(),

sample/benchmark/src/main/java/com/datadog/benchmark/sample/ui/common/DropDownMenuView.kt

@@ -0,0 +1,52 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.benchmark.sample.ui.common
+
+import androidx.compose.foundation.layout.Box
+import androidx.compose.material3.Button
+import androidx.compose.material3.DropdownMenu
+import androidx.compose.material3.DropdownMenuItem
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.Modifier
+
+@Composable
+internal fun <T> DropDownMenuView(
+    headerText: String,
+    items: List<T>,
+    textFactory: @Composable (T) -> Unit,
+    onClickAction: (T) -> Unit
+) {
+    Box {
+        var expanded by remember { mutableStateOf(false) }
+
+        Button(
+            modifier = Modifier,
+            onClick = { expanded = !expanded }
+        ) {
+            Text(headerText)
+        }
+        DropdownMenu(
+            expanded = expanded,
+            onDismissRequest = { expanded = false }
+        ) {
+            items.forEach {
+                DropdownMenuItem(
+                    text = { textFactory(it) },
+                    onClick = {
+                        onClickAction(it)
+                        expanded = false
+                    }
+                )
+            }
+        }
+    }
+}

sample/benchmark/src/main/java/com/datadog/benchmark/sample/ui/common/ExpandedItemView.kt

@@ -0,0 +1,33 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.benchmark.sample.ui.common
+
+import androidx.compose.foundation.layout.Row
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+
+@Composable
+internal fun <T> ExpandedItemView(
+    titleText: String,
+    items: List<T>,
+    headerText: String,
+    itemTextFactory: (T) -> String,
+    onClick: (T) -> Unit
+) {
+    Row(verticalAlignment = Alignment.CenterVertically) {
+        Text(text = titleText, modifier = Modifier.weight(1f))
+
+        DropDownMenuView(
+            headerText = headerText,
+            items = items,
+            textFactory = { Text(text = itemTextFactory(it)) },
+            onClickAction = { onClick(it) }
+        )
+    }
+}