RUMM-55 Add the Log threadName property

DataDog · Dec 6, 2019 · 860ebbb · 860ebbb
1 parent e5bf9bf
commit 860ebbb
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 15 deletions.
diff --git a/dd-sdk-android/src/androidTest/kotlin/com/datadog/android/internal/utils/utils.kt b/dd-sdk-android/src/androidTest/kotlin/com/datadog/android/internal/utils/utils.kt
@@ -33,7 +33,8 @@ internal fun randomLog(forge: Forge): Log {
             carrierName = forge.anAlphaNumericalString(),
             carrierId = forge.anInt()
         ),
-        loggerName = forge.anAlphabeticalString()
+        loggerName = forge.anAlphabeticalString(),
+        threadName = forge.anAlphabeticalString()
     )
 }
 

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/Logger.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/Logger.kt
@@ -379,7 +379,8 @@ private constructor(
             attributes = attributes.toMap(),
             tags = tags.toList(),
             networkInfo = networkInfoProvider?.getLatestNetworkInfos(),
-            loggerName = loggerName
+            loggerName = loggerName,
+            threadName = Thread.currentThread().name
         )
     }
 

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/Log.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/Log.kt
@@ -20,5 +20,6 @@ internal data class Log(
     val tags: List<String>,
     val throwable: Throwable?,
     val networkInfo: NetworkInfo?,
-    val loggerName: String
+    val loggerName: String,
+    val threadName: String
 )
diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/LogStrategy.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/LogStrategy.kt
@@ -32,6 +32,7 @@ internal interface LogStrategy {
 
         // THREAD RELATED TAGS
         internal const val TAG_LOGGER_NAME = "logger.name"
+        internal const val TAG_THREAD_NAME = "logger.thread_name"
 
         // ANDROID SPECIFIC TAGS
         internal const val TAG_NETWORK = "network"

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/file/LogFileWriter.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/file/LogFileWriter.kt
@@ -122,6 +122,7 @@ internal class LogFileWriter(
     ) {
         log.throwable?.let {
             jsonLog.addProperty(LogStrategy.TAG_LOGGER_NAME, log.loggerName)
+            jsonLog.addProperty(LogStrategy.TAG_THREAD_NAME, log.threadName)
             val sw = StringWriter()
             it.printStackTrace(PrintWriter(sw))
             jsonLog.addProperty(LogStrategy.TAG_ERROR_KIND, it.javaClass.simpleName)

diff --git a/dd-sdk-android/src/test/kotlin/com/datadog/android/log/LoggerFullFeaturesTest.kt b/dd-sdk-android/src/test/kotlin/com/datadog/android/log/LoggerFullFeaturesTest.kt
@@ -24,6 +24,7 @@ import fr.xgouchet.elmyr.junit5.ForgeConfiguration
 import fr.xgouchet.elmyr.junit5.ForgeExtension
 import java.io.ByteArrayOutputStream
 import java.io.PrintStream
+import java.util.concurrent.CountDownLatch
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
@@ -77,15 +78,7 @@ internal class LoggerFullFeaturesTest {
         fakeLoggerName = forge.anAlphabeticalString()
         whenever(mockNetworkInfoProvider.getLatestNetworkInfos()) doReturn fakeNetworkInfo
 
-        testedLogger = Logger.Builder()
-            .setServiceName(fakeServiceName)
-            .setLogcatLogsEnabled(true)
-            .setDatadogLogsEnabled(true)
-            .setNetworkInfoEnabled(true)
-            .setLoggerName(fakeLoggerName)
-            .withLogStrategy(mockLogStrategy)
-            .withNetworkInfoProvider(mockNetworkInfoProvider)
-            .build()
+        testedLogger = createLogger()
     }
 
     @BeforeEach
@@ -150,10 +143,36 @@ internal class LoggerFullFeaturesTest {
         verifyLogSideEffects(AndroidLog.ASSERT, "A")
     }
 
+    @Test
+    fun `the thread name will be the name of the thread from which the logger was built`() {
+        val countDownLatch = CountDownLatch(1)
+        var logger: Logger
+        Thread().start().run {
+            logger = createLogger()
+            countDownLatch.countDown()
+        }
+        countDownLatch.await()
+
+        logger.e(fakeMessage)
+        verifyLogSideEffects(AndroidLog.ERROR, "E")
+    }
+
     // endregion
 
     // region Internal
 
+    private fun createLogger(): Logger {
+        return Logger.Builder()
+            .setServiceName(fakeServiceName)
+            .setLogcatLogsEnabled(true)
+            .setDatadogLogsEnabled(true)
+            .setNetworkInfoEnabled(true)
+            .setLoggerName(fakeLoggerName)
+            .withLogStrategy(mockLogStrategy)
+            .withNetworkInfoProvider(mockNetworkInfoProvider)
+            .build()
+    }
+
     private fun verifyLogSideEffects(level: Int, logCatPrefix: String) {
         val timestamp = System.currentTimeMillis()
 
@@ -171,6 +190,7 @@ internal class LoggerFullFeaturesTest {
                 .hasTimestamp(timestamp)
                 .hasNetworkInfo(fakeNetworkInfo)
                 .hasLoggerName(fakeLoggerName)
+                .hasThreadName(Thread.currentThread().name)
         }
     }
 

diff --git a/dd-sdk-android/src/test/kotlin/com/datadog/android/log/assertj/LogAssert.kt b/dd-sdk-android/src/test/kotlin/com/datadog/android/log/assertj/LogAssert.kt
@@ -79,12 +79,22 @@ internal class LogAssert(actual: Log) :
         return this
     }
 
-    fun hasLoggerName(expected: String) {
+    fun hasLoggerName(expected: String): LogAssert {
         assertThat(actual.loggerName)
             .overridingErrorMessage(
                 "Expected log to have loggerName $expected but was ${actual.loggerName}"
             )
             .isEqualTo(expected)
+        return this
+    }
+
+    fun hasThreadName(expected: String): LogAssert {
+        assertThat(actual.threadName)
+            .overridingErrorMessage(
+                "Expected log to have threadName $expected but was ${actual.threadName}"
+            )
+            .isEqualTo(expected)
+        return this
     }
 
     companion object {

diff --git a/dd-sdk-android/src/test/kotlin/com/datadog/android/log/forge/LogForgeryFactory.kt b/dd-sdk-android/src/test/kotlin/com/datadog/android/log/forge/LogForgeryFactory.kt
@@ -28,7 +28,8 @@ internal class LogForgeryFactory : ForgeryFactory<Log> {
             attributes = forge.exhaustiveAttributes(),
             tags = forge.exhaustiveTags(),
             networkInfo = forge.getForgery(),
-            loggerName = forge.anAlphabeticalString(size = forge.aTinyInt())
+            loggerName = forge.anAlphabeticalString(),
+            threadName = forge.anAlphabeticalString()
         )
     }
 

diff --git a/dd-sdk-android/src/test/kotlin/com/datadog/android/log/internal/LogStrategyTest.kt b/dd-sdk-android/src/test/kotlin/com/datadog/android/log/internal/LogStrategyTest.kt
@@ -196,7 +196,8 @@ internal abstract class LogStrategyTest {
             ),
             throwable = ArrayIndexOutOfBoundsException(forge.anAlphabeticalString()),
             timestamp = forge.aLong(),
-            loggerName = forge.anAlphabeticalString()
+            loggerName = forge.anAlphabeticalString(),
+            threadName = forge.anAlphabeticalString()
         )
 
         testedLogWriter.writeLog(bigLog)
@@ -411,12 +412,14 @@ internal abstract class LogStrategyTest {
 
             assertThat(jsonObject)
                 .hasField(LogStrategy.TAG_LOGGER_NAME, log.loggerName)
+                .hasField(LogStrategy.TAG_THREAD_NAME, log.threadName)
                 .hasField(LogStrategy.TAG_ERROR_KIND, throwable.javaClass.simpleName)
                 .hasField(LogStrategy.TAG_ERROR_MESSAGE, throwable.message)
                 .hasField(LogStrategy.TAG_ERROR_STACK, sw.toString())
         } else {
             assertThat(jsonObject)
                 .doesNotHaveField(LogStrategy.TAG_LOGGER_NAME)
+                .doesNotHaveField(LogStrategy.TAG_THREAD_NAME)
                 .doesNotHaveField(LogStrategy.TAG_ERROR_KIND)
                 .doesNotHaveField(LogStrategy.TAG_ERROR_MESSAGE)
                 .doesNotHaveField(LogStrategy.TAG_ERROR_STACK)