feat: add logger with userid and clientid (#2280)

wireapp · Oct 16, 2023 · b5090d9 · b5090d9
1 parent cd9df4c
commit b5090d9
Show file tree

Hide file tree

Showing 9 changed files with 88 additions and 39 deletions.
diff --git a/.github/workflows/gradle-run-unit-tests.yml b/.github/workflows/gradle-run-unit-tests.yml
@@ -28,7 +28,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           java-version: '17'
-          distribution: 'adopt'
+          distribution: 'temurin'
           cache: gradle
 
       - name: Validate Gradle wrapper

diff --git a/app/src/beta/kotlin/com/wire/android/util/DataDogLogger.kt b/app/src/beta/kotlin/com/wire/android/util/DataDogLogger.kt
@@ -23,18 +23,25 @@ package com.wire.android.util
 import co.touchlab.kermit.LogWriter
 import co.touchlab.kermit.Severity
 import com.datadog.android.log.Logger
+import com.wire.kalium.logger.KaliumLogger
 
 object DataDogLogger : LogWriter() {
 
     private val logger = Logger.Builder()
         .setNetworkInfoEnabled(true)
-        .setLogcatLogsEnabled(true)
+        .setLogcatLogsEnabled(false) // we already use platformLogWriter() along with DataDogLogger, don't need duplicates in LogCat
         .setDatadogLogsEnabled(true)
         .setBundleWithTraceEnabled(true)
         .setLoggerName("DATADOG")
         .build()
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
-        logger.log(severity.ordinal, message, throwable)
+        val attributes = KaliumLogger.UserClientData.getFromTag(tag)?.let { userClientData ->
+            mapOf(
+                "userId" to userClientData.userId,
+                "clientId" to userClientData.clientId,
+            )
+        } ?: emptyMap<String, Any?>()
+        logger.log(severity.ordinal, message, throwable, attributes)
     }
 }
diff --git a/app/src/dev/kotlin/com/wire/android/util/DataDogLogger.kt b/app/src/dev/kotlin/com/wire/android/util/DataDogLogger.kt
@@ -23,18 +23,25 @@ package com.wire.android.util
 import co.touchlab.kermit.LogWriter
 import co.touchlab.kermit.Severity
 import com.datadog.android.log.Logger
+import com.wire.kalium.logger.KaliumLogger
 
 object DataDogLogger : LogWriter() {
 
     private val logger = Logger.Builder()
         .setNetworkInfoEnabled(true)
-        .setLogcatLogsEnabled(true)
+        .setLogcatLogsEnabled(false) // we already use platformLogWriter() along with DataDogLogger, don't need duplicates in LogCat
         .setDatadogLogsEnabled(true)
         .setBundleWithTraceEnabled(true)
         .setLoggerName("DATADOG")
         .build()
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
-        logger.log(severity.ordinal, message, throwable)
+        val attributes = KaliumLogger.UserClientData.getFromTag(tag)?.let { userClientData ->
+            mapOf(
+                "userId" to userClientData.userId,
+                "clientId" to userClientData.clientId,
+            )
+        } ?: emptyMap<String, Any?>()
+        logger.log(severity.ordinal, message, throwable, attributes)
     }
 }
diff --git a/app/src/internal/kotlin/com/wire/android/util/DataDogLogger.kt b/app/src/internal/kotlin/com/wire/android/util/DataDogLogger.kt
@@ -23,18 +23,25 @@ package com.wire.android.util
 import co.touchlab.kermit.LogWriter
 import co.touchlab.kermit.Severity
 import com.datadog.android.log.Logger
+import com.wire.kalium.logger.KaliumLogger
 
 object DataDogLogger : LogWriter() {
 
     private val logger = Logger.Builder()
         .setNetworkInfoEnabled(true)
-        .setLogcatLogsEnabled(true)
+        .setLogcatLogsEnabled(false) // we already use platformLogWriter() along with DataDogLogger, don't need duplicates in LogCat
         .setDatadogLogsEnabled(true)
         .setBundleWithTraceEnabled(true)
         .setLoggerName("DATADOG")
         .build()
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
-        logger.log(severity.ordinal, message, throwable)
+        val attributes = KaliumLogger.UserClientData.getFromTag(tag)?.let { userClientData ->
+            mapOf(
+                "userId" to userClientData.userId,
+                "clientId" to userClientData.clientId,
+            )
+        } ?: emptyMap<String, Any?>()
+        logger.log(severity.ordinal, message, throwable, attributes)
     }
 }
diff --git a/app/src/main/kotlin/com/wire/android/AppLogger.kt b/app/src/main/kotlin/com/wire/android/AppLogger.kt
@@ -0,0 +1,34 @@
+/*
+ * Wire
+ * Copyright (C) 2023 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+package com.wire.android
+
+import com.wire.kalium.logger.KaliumLogLevel
+import com.wire.kalium.logger.KaliumLogger
+
+private var appLoggerConfig = KaliumLogger.Config.disabled()
+// App wide global logger, carefully initialized when our application is "onCreate"
+internal var appLogger = KaliumLogger.disabled()
+object AppLogger {
+    fun init(config: KaliumLogger.Config) {
+        appLoggerConfig = config
+        appLogger = KaliumLogger(config = config, tag = "WireAppLogger")
+    }
+    fun setLogLevel(level: KaliumLogLevel) {
+        appLoggerConfig.setLogLevel(level)
+    }
+}
diff --git a/app/src/main/kotlin/com/wire/android/WireApplication.kt b/app/src/main/kotlin/com/wire/android/WireApplication.kt
@@ -47,9 +47,6 @@ import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
-// App wide global logger, carefully initialized when our application is "onCreate"
-var appLogger: KaliumLogger = KaliumLogger.disabled()
-
 @HiltAndroidApp
 class WireApplication : Application(), Configuration.Provider {
 
@@ -131,17 +128,22 @@ class WireApplication : Application(), Configuration.Provider {
             // 1. Datadog should be initialized first
             ExternalLoggerManager.initDatadogLogger(applicationContext, globalDataStore)
             // 2. Initialize our internal logging framework
-            appLogger = KaliumLogger(
-                config = KaliumLogger.Config(
-                    severity = if (BuildConfig.PRIVATE_BUILD) KaliumLogLevel.DEBUG else KaliumLogLevel.DISABLED,
-                    tag = "WireAppLogger"
-                ),
-                DataDogLogger,
-                platformLogWriter()
-            )
+            val isLoggingEnabled = globalDataStore.isLoggingEnabled().first()
+            val config = if (isLoggingEnabled) {
+                KaliumLogger.Config.DEFAULT.apply {
+                    setLogLevel(KaliumLogLevel.VERBOSE)
+                    setLogWriterList(listOf(DataDogLogger, platformLogWriter()))
+                }
+            } else {
+                KaliumLogger.Config.disabled()
+            }
+            // 2. Initialize our internal logging framework
+            AppLogger.init(config)
+            CoreLogger.init(config)
             // 3. Initialize our internal FILE logging framework
-            enableLoggingAndInitiateFileLogging()
+            logFileWriter.start()
             // 4. Everything ready, now we can log device info
+            appLogger.i("Logger enabled")
             logDeviceInformation()
         }
     }
@@ -158,19 +160,6 @@ class WireApplication : Application(), Configuration.Provider {
         )
     }
 
-    private fun enableLoggingAndInitiateFileLogging() {
-        globalAppScope.launch {
-            if (globalDataStore.isLoggingEnabled().first()) {
-                CoreLogger.setLoggingLevel(
-                    level = KaliumLogLevel.VERBOSE,
-                    logWriters = arrayOf(DataDogLogger, platformLogWriter())
-                )
-                logFileWriter.start()
-                appLogger.i("Logger enabled")
-            }
-        }
-    }
-
     override fun onTrimMemory(level: Int) {
         super.onTrimMemory(level)
         appLogger.w(

diff --git a/app/src/main/kotlin/com/wire/android/ui/debug/UserDebugViewModel.kt b/app/src/main/kotlin/com/wire/android/ui/debug/UserDebugViewModel.kt
@@ -25,10 +25,8 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import co.touchlab.kermit.platformLogWriter
 import com.wire.android.datastore.GlobalDataStore
 import com.wire.android.di.CurrentAccount
-import com.wire.android.util.DataDogLogger
 import com.wire.android.util.EMPTY
 import com.wire.android.util.LogFileWriter
 import com.wire.kalium.logger.KaliumLogLevel
@@ -77,10 +75,10 @@ class UserDebugViewModel
         }
         if (isEnabled) {
             logFileWriter.start()
-            CoreLogger.setLoggingLevel(level = KaliumLogLevel.VERBOSE, logWriters = arrayOf(DataDogLogger, platformLogWriter()))
+            CoreLogger.setLoggingLevel(level = KaliumLogLevel.VERBOSE)
         } else {
             logFileWriter.stop()
-            CoreLogger.setLoggingLevel(level = KaliumLogLevel.DISABLED, logWriters = arrayOf(DataDogLogger, platformLogWriter()))
+            CoreLogger.setLoggingLevel(level = KaliumLogLevel.DISABLED)
         }
     }
 

diff --git a/app/src/staging/kotlin/com/wire/android/util/DataDogLogger.kt b/app/src/staging/kotlin/com/wire/android/util/DataDogLogger.kt
@@ -23,18 +23,25 @@ package com.wire.android.util
 import co.touchlab.kermit.LogWriter
 import co.touchlab.kermit.Severity
 import com.datadog.android.log.Logger
+import com.wire.kalium.logger.KaliumLogger
 
 object DataDogLogger : LogWriter() {
 
     private val logger = Logger.Builder()
         .setNetworkInfoEnabled(true)
-        .setLogcatLogsEnabled(true)
+        .setLogcatLogsEnabled(false) // we already use platformLogWriter() along with DataDogLogger, don't need duplicates in LogCat
         .setDatadogLogsEnabled(true)
         .setBundleWithTraceEnabled(true)
         .setLoggerName("DATADOG")
         .build()
 
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
-        logger.log(severity.ordinal, message, throwable)
+        val attributes = KaliumLogger.UserClientData.getFromTag(tag)?.let { userClientData ->
+            mapOf(
+                "userId" to userClientData.userId,
+                "clientId" to userClientData.clientId,
+            )
+        } ?: emptyMap<String, Any?>()
+        logger.log(severity.ordinal, message, throwable, attributes)
     }
 }
diff --git a/kalium b/kalium
+7 −5		cli/src/commonMain/kotlin/com/wire/kalium/cli/CLIApplication.kt
+2 −10		cryptography/src/commonMain/kotlin/com/wire/kalium/cryptography/CryptographyLogger.kt
+1 −1		gradle/libs.versions.toml
+146 −62		logger/src/commonMain/kotlin/com/wire/kalium/logger/KaliumLogger.kt
+12 −21		logic/src/commonMain/kotlin/com/wire/kalium/logic/CoreLogger.kt
+12 −1		logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/UserSessionScope.kt
+5 −4		monkeys/src/main/kotlin/com/wire/kalium/monkeys/MonkeyApplication.kt
+4 −10		monkeys/src/main/kotlin/com/wire/kalium/monkeys/MonkeyLogger.kt
+3 −10		network-util/src/commonMain/kotlin/com/wire/kalium/network/NetworkUtilLogger.kt
+3 −1		network/src/commonMain/kotlin/com/wire/kalium/network/KaliumHttpLogger.kt
+9 −2		network/src/commonMain/kotlin/com/wire/kalium/network/KaliumKtorCustomLogging.kt
+10 −4		network/src/commonMain/kotlin/com/wire/kalium/network/NetworkClient.kt
+2 −12		network/src/commonMain/kotlin/com/wire/kalium/network/NetworkLogger.kt
+4 −1		...ain/kotlin/com/wire/kalium/network/api/v0/authenticated/networkContainer/AuthenticatedNetworkContainerV0.kt
+4 −1		...ain/kotlin/com/wire/kalium/network/api/v2/authenticated/networkContainer/AuthenticatedNetworkContainerV2.kt
+4 −1		...ain/kotlin/com/wire/kalium/network/api/v3/authenticated/networkContainer/AuthenticatedNetworkContainerV3.kt
+4 −1		...ain/kotlin/com/wire/kalium/network/api/v4/authenticated/networkContainer/AuthenticatedNetworkContainerV4.kt
+4 −1		...ain/kotlin/com/wire/kalium/network/api/v5/authenticated/networkContainer/AuthenticatedNetworkContainerV5.kt
+19 −7		network/src/commonMain/kotlin/com/wire/kalium/network/networkContainer/AuthenticatedNetworkContainer.kt
+8 −3		network/src/commonTest/kotlin/com/wire/kalium/api/ApiTest.kt
+2 −1		network/src/commonTest/kotlin/com/wire/kalium/api/common/SessionManagerTest.kt
+2 −10		persistence/src/commonMain/kotlin/com/wire/kalium/persistence/PersistenceLogger.kt