RUMM-3508 Add the additionalProperties capability to telemetry debug …

…logs
DataDog · Aug 14, 2023 · 3377375 · 3377375
1 parent 3d566c0
commit 3377375
Show file tree

Hide file tree

Showing 33 changed files with 462 additions and 146 deletions.
diff --git a/dd-sdk-android-core/api/apiSurface b/dd-sdk-android-core/api/apiSurface
@@ -42,8 +42,8 @@ interface com.datadog.android.api.InternalLogger
     - USER
     - MAINTAINER
     - TELEMETRY
-  fun log(Level, Target, () -> String, Throwable? = null, Boolean = false)
-  fun log(Level, List<Target>, () -> String, Throwable? = null, Boolean = false)
+  fun log(Level, Target, () -> String, Throwable? = null, Boolean = false, Map<String, Any?>? = null)
+  fun log(Level, List<Target>, () -> String, Throwable? = null, Boolean = false, Map<String, Any?>? = null)
   companion object 
     val UNBOUND: InternalLogger
 interface com.datadog.android.api.SdkCore

diff --git a/dd-sdk-android-core/api/dd-sdk-android-core.api b/dd-sdk-android-core/api/dd-sdk-android-core.api
@@ -75,17 +75,17 @@ public final class com/datadog/android/_InternalProxy$_TelemetryProxy {
 
 public abstract interface class com/datadog/android/api/InternalLogger {
 	public static final field Companion Lcom/datadog/android/api/InternalLogger$Companion;
-	public abstract fun log (Lcom/datadog/android/api/InternalLogger$Level;Lcom/datadog/android/api/InternalLogger$Target;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;Z)V
-	public abstract fun log (Lcom/datadog/android/api/InternalLogger$Level;Ljava/util/List;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;Z)V
+	public abstract fun log (Lcom/datadog/android/api/InternalLogger$Level;Lcom/datadog/android/api/InternalLogger$Target;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;)V
+	public abstract fun log (Lcom/datadog/android/api/InternalLogger$Level;Ljava/util/List;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;)V
 }
 
 public final class com/datadog/android/api/InternalLogger$Companion {
 	public final fun getUNBOUND ()Lcom/datadog/android/api/InternalLogger;
 }
 
 public final class com/datadog/android/api/InternalLogger$DefaultImpls {
-	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Lcom/datadog/android/api/InternalLogger$Target;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZILjava/lang/Object;)V
-	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Ljava/util/List;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZILjava/lang/Object;)V
+	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Lcom/datadog/android/api/InternalLogger$Target;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;ILjava/lang/Object;)V
+	public static synthetic fun log$default (Lcom/datadog/android/api/InternalLogger;Lcom/datadog/android/api/InternalLogger$Level;Ljava/util/List;Lkotlin/jvm/functions/Function0;Ljava/lang/Throwable;ZLjava/util/Map;ILjava/lang/Object;)V
 }
 
 public final class com/datadog/android/api/InternalLogger$Level : java/lang/Enum {

diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/InternalLogger.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/InternalLogger.kt
@@ -66,13 +66,15 @@ interface InternalLogger {
      * @param throwable an optional throwable error
      * @param onlyOnce whether only one instance of the message should be sent per lifetime of the
      * logger (default is `false`)
+     * @param additionalProperties additional properties to add to the log
      */
     fun log(
         level: Level,
         target: Target,
         messageBuilder: () -> String,
         throwable: Throwable? = null,
-        onlyOnce: Boolean = false
+        onlyOnce: Boolean = false,
+        additionalProperties: Map<String, Any?>? = null
     )
 
     /**
@@ -83,13 +85,15 @@ interface InternalLogger {
      * @param throwable an optional throwable error
      * @param onlyOnce whether only one instance of the message should be sent per lifetime of the
      * logger (default is `false`, onlyOnce applies to each target independently)
+     * @param additionalProperties additional properties to add to the log
      */
     fun log(
         level: Level,
         targets: List<Target>,
         messageBuilder: () -> String,
         throwable: Throwable? = null,
-        onlyOnce: Boolean = false
+        onlyOnce: Boolean = false,
+        additionalProperties: Map<String, Any?>? = null
     )
 
     companion object {

diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/SdkInternalLogger.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/SdkInternalLogger.kt
@@ -53,7 +53,8 @@ internal class SdkInternalLogger(
         target: InternalLogger.Target,
         messageBuilder: () -> String,
         throwable: Throwable?,
-        onlyOnce: Boolean
+        onlyOnce: Boolean,
+        additionalProperties: Map<String, Any?>?
     ) {
         when (target) {
             InternalLogger.Target.USER -> logToUser(level, messageBuilder, throwable, onlyOnce)
@@ -68,7 +69,8 @@ internal class SdkInternalLogger(
                 level,
                 messageBuilder,
                 throwable,
-                onlyOnce
+                onlyOnce,
+                additionalProperties
             )
         }
     }
@@ -78,10 +80,11 @@ internal class SdkInternalLogger(
         targets: List<InternalLogger.Target>,
         messageBuilder: () -> String,
         throwable: Throwable?,
-        onlyOnce: Boolean
+        onlyOnce: Boolean,
+        additionalProperties: Map<String, Any?>?
     ) {
         targets.forEach {
-            log(level, it, messageBuilder, throwable)
+            log(level, it, messageBuilder, throwable, onlyOnce, additionalProperties)
         }
     }
 
@@ -148,7 +151,8 @@ internal class SdkInternalLogger(
         level: InternalLogger.Level,
         messageBuilder: () -> String,
         error: Throwable?,
-        onlyOnce: Boolean
+        onlyOnce: Boolean,
+        additionalProperties: Map<String, Any?>?
     ) {
         val rumFeature = sdkCore?.getFeature(Feature.RUM_FEATURE_NAME) ?: return
         val message = messageBuilder()
@@ -166,14 +170,20 @@ internal class SdkInternalLogger(
             error != null
         ) {
             mapOf(
-                "type" to "telemetry_error",
-                "message" to message,
-                "throwable" to error
+                TYPE_KEY to "telemetry_error",
+                MESSAGE_KEY to message,
+                THROWABLE_KEY to error
+            )
+        } else if (!additionalProperties.isNullOrEmpty()) {
+            mapOf(
+                TYPE_KEY to "telemetry_debug",
+                MESSAGE_KEY to message,
+                ADDITIONAL_PROPERTIES_KEY to additionalProperties
             )
         } else {
             mapOf(
-                "type" to "telemetry_debug",
-                "message" to message
+                TYPE_KEY to "telemetry_debug",
+                MESSAGE_KEY to message
             )
         }
         rumFeature.sendEvent(telemetryEvent)
@@ -201,6 +211,10 @@ internal class SdkInternalLogger(
     companion object {
         internal const val SDK_LOG_TAG = "DD_LOG"
         internal const val DEV_LOG_TAG = "Datadog"
+        private const val MESSAGE_KEY = "message"
+        private const val TYPE_KEY = "type"
+        private const val THROWABLE_KEY = "throwable"
+        private const val ADDITIONAL_PROPERTIES_KEY = "additionalProperties"
     }
 
     // endregion

diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/DatadogTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/DatadogTest.kt
@@ -409,7 +409,8 @@ internal class DatadogTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 isNull(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             val actualMessage = firstValue()
             val filteredActualMessage = actualMessage

diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/SdkInternalLoggerTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/SdkInternalLoggerTest.kt
@@ -282,6 +282,72 @@ internal class SdkInternalLoggerTest {
             )
     }
 
+    @Test
+    fun `𝕄 send telemetry log 𝕎 log { TELEMETRY target, additional properties + info or debug }`(
+        @StringForgery fakeMessage: String,
+        forge: Forge
+    ) {
+        // Given
+        val fakeAdditionalProperties = forge.aMap {
+            forge.anAlphabeticalString() to forge.aNullable { anAlphabeticalString() }
+        }
+        val mockLambda: () -> String = mock()
+        whenever(mockLambda.invoke()) doReturn fakeMessage
+        val fakeLevel = forge.anElementFrom(InternalLogger.Level.INFO, InternalLogger.Level.DEBUG)
+        val mockRumFeatureScope = mock<FeatureScope>()
+        whenever(mockSdkCore.getFeature(Feature.RUM_FEATURE_NAME)) doReturn mockRumFeatureScope
+
+        // When
+        testedInternalLogger.log(
+            fakeLevel,
+            InternalLogger.Target.TELEMETRY,
+            mockLambda,
+            null,
+            additionalProperties = fakeAdditionalProperties
+        )
+
+        // Then
+        verify(mockRumFeatureScope)
+            .sendEvent(
+                mapOf(
+                    "type" to "telemetry_debug",
+                    "message" to fakeMessage,
+                    "additionalProperties" to fakeAdditionalProperties
+                )
+            )
+    }
+
+    @Test
+    fun `𝕄 send telemetry log 𝕎 log { TELEMETRY target, additional prop empty + info or debug }`(
+        @StringForgery fakeMessage: String,
+        forge: Forge
+    ) {
+        // Given
+        val mockLambda: () -> String = mock()
+        whenever(mockLambda.invoke()) doReturn fakeMessage
+        val fakeLevel = forge.anElementFrom(InternalLogger.Level.INFO, InternalLogger.Level.DEBUG)
+        val mockRumFeatureScope = mock<FeatureScope>()
+        whenever(mockSdkCore.getFeature(Feature.RUM_FEATURE_NAME)) doReturn mockRumFeatureScope
+
+        // When
+        testedInternalLogger.log(
+            fakeLevel,
+            InternalLogger.Target.TELEMETRY,
+            mockLambda,
+            null,
+            additionalProperties = emptyMap()
+        )
+
+        // Then
+        verify(mockRumFeatureScope)
+            .sendEvent(
+                mapOf(
+                    "type" to "telemetry_debug",
+                    "message" to fakeMessage
+                )
+            )
+    }
+
     @Test
     fun `𝕄 send telemetry log 𝕎 log { TELEMETRY target, no throwable + warn or error }`(
         @StringForgery fakeMessage: String,

diff --git a/...android-core/src/test/kotlin/com/datadog/android/core/configuration/HostsSanitizerTest.kt b/...android-core/src/test/kotlin/com/datadog/android/core/configuration/HostsSanitizerTest.kt
@@ -136,7 +136,8 @@ internal class HostsSanitizerTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 isNull(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(allValues.map { it() })
                 .containsExactlyInAnyOrderElementsOf(expectedMessages)
@@ -171,7 +172,8 @@ internal class HostsSanitizerTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 isNull(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(allValues.map { it() })
                 .containsExactlyInAnyOrderElementsOf(expectedMessages)
@@ -256,7 +258,8 @@ internal class HostsSanitizerTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 isNull(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(allValues.map { it() })
                 .containsExactlyInAnyOrderElementsOf(expectedMessages)
@@ -289,7 +292,8 @@ internal class HostsSanitizerTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 any<MalformedURLException>(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(allValues.map { it() })
                 .containsExactlyInAnyOrderElementsOf(expectedMessages)

diff --git a/...d-core/src/test/kotlin/com/datadog/android/core/constraints/DatadogDataConstraintsTest.kt b/...d-core/src/test/kotlin/com/datadog/android/core/constraints/DatadogDataConstraintsTest.kt
@@ -373,7 +373,8 @@ internal class DatadogDataConstraintsTest {
                 eq(InternalLogger.Target.USER),
                 capture(),
                 isNull(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
 
             assertThat(allValues.map { it() })

diff --git a/.../src/test/kotlin/com/datadog/android/core/internal/persistence/ConsentAwareStorageTest.kt b/.../src/test/kotlin/com/datadog/android/core/internal/persistence/ConsentAwareStorageTest.kt
@@ -280,7 +280,8 @@ internal class ConsentAwareStorageTest {
             eq(listOf(InternalLogger.Target.MAINTAINER, InternalLogger.Target.TELEMETRY)),
             any(),
             isA<RejectedExecutionException>(),
-            eq(false)
+            eq(false),
+            eq(null)
         )
     }
 

diff --git a/...om/datadog/android/core/internal/persistence/file/batch/PlainBatchFileReaderWriterTest.kt b/...om/datadog/android/core/internal/persistence/file/batch/PlainBatchFileReaderWriterTest.kt
@@ -189,7 +189,8 @@ internal class PlainBatchFileReaderWriterTest {
                 eq(listOf(InternalLogger.Target.MAINTAINER, InternalLogger.Target.TELEMETRY)),
                 capture(),
                 any(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(firstValue())
                 .isEqualTo(PlainBatchFileReaderWriter.ERROR_WRITE.format(Locale.US, file.path))
@@ -221,7 +222,8 @@ internal class PlainBatchFileReaderWriterTest {
                 eq(listOf(InternalLogger.Target.MAINTAINER, InternalLogger.Target.TELEMETRY)),
                 capture(),
                 any(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(firstValue())
                 .isEqualTo(PlainBatchFileReaderWriter.ERROR_WRITE.format(Locale.US, file.path))
@@ -253,7 +255,8 @@ internal class PlainBatchFileReaderWriterTest {
                 eq(listOf(InternalLogger.Target.MAINTAINER, InternalLogger.Target.TELEMETRY)),
                 capture(),
                 any(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(firstValue())
                 .isEqualTo(PlainBatchFileReaderWriter.ERROR_READ.format(Locale.US, file.path))
@@ -279,7 +282,8 @@ internal class PlainBatchFileReaderWriterTest {
                 eq(listOf(InternalLogger.Target.MAINTAINER, InternalLogger.Target.TELEMETRY)),
                 capture(),
                 any(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(firstValue())
                 .isEqualTo(PlainBatchFileReaderWriter.ERROR_READ.format(Locale.US, file.path))
@@ -384,7 +388,8 @@ internal class PlainBatchFileReaderWriterTest {
                 eq(InternalLogger.Target.MAINTAINER),
                 capture(),
                 any(),
-                eq(false)
+                eq(false),
+                eq(null)
             )
             assertThat(firstValue())
                 .isEqualTo(PlainBatchFileReaderWriter.ERROR_FAILED_META_PARSE)