Merge pull request #190 from statsig-io/more_logging

xinlili-statsig · web-flow · commit 826e736e01e9 · 2023-12-01T10:18:31.000-08:00
Log statsigoptions and configname
diff --git a/src/main/kotlin/com/statsig/sdk/ErrorBoundary.kt b/src/main/kotlin/com/statsig/sdk/ErrorBoundary.kt
@@ -1,5 +1,6 @@
 package com.statsig.sdk
 
+import com.google.gson.Gson
 import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.OkHttpClient
 import okhttp3.Request
@@ -27,30 +28,30 @@ internal class ErrorBoundary(private val apiKey: String, private val options: St
     }
 
     suspend fun swallow(tag: String, task: suspend () -> Unit) {
-        capture(tag, task) {
-            // no-op
-        }
+        capture(tag, task, {
+            // no op
+        })
     }
 
-    suspend fun <T> capture(tag: String, task: suspend () -> T, recover: suspend () -> T): T {
+    suspend fun <T> capture(tag: String, task: suspend () -> T, recover: suspend () -> T, configName: String? = null): T {
         return try {
             task()
         } catch (ex: Throwable) {
-            onException(tag, ex)
+            onException(tag, ex, configName)
             recover()
         }
     }
 
-    fun <T> captureSync(tag: String, task: () -> T, recover: () -> T): T {
+    fun <T> captureSync(tag: String, task: () -> T, recover: () -> T, configName: String? = null): T {
         return try {
             task()
         } catch (ex: Throwable) {
-            onException(tag, ex)
+            onException(tag, ex, configName)
             recover()
         }
     }
 
-    internal fun logException(tag: String, ex: Throwable) {
+    internal fun logException(tag: String, ex: Throwable, configName: String? = null) {
         try {
             if (options.localMode || seen.contains(ex.javaClass.name)) {
                 return
@@ -63,12 +64,14 @@ internal class ErrorBoundary(private val apiKey: String, private val options: St
             if (safeInfo.length > maxInfoLength) {
                 safeInfo = safeInfo.substring(0, maxInfoLength)
             }
-
+            val optionsCopy = Gson().toJson(options.getLoggingCopy())
             val body = """{
                 "tag": "$tag",
                 "exception": "${ex.javaClass.name}",
                 "info": "$safeInfo",
-                "statsigMetadata": ${statsigMetadata.asJson()}
+                "statsigMetadata": ${statsigMetadata.asJson()},
+                "configName": "$configName",
+                "setupOptions": $optionsCopy
             }
             """.trimIndent()
             val req =
@@ -84,7 +87,7 @@ internal class ErrorBoundary(private val apiKey: String, private val options: St
         }
     }
 
-    private fun onException(tag: String, ex: Throwable) {
+    private fun onException(tag: String, ex: Throwable, configName: String? = null) {
         if (ex is StatsigIllegalStateException ||
             ex is StatsigUninitializedException
         ) {
@@ -94,6 +97,6 @@ internal class ErrorBoundary(private val apiKey: String, private val options: St
         println("[Statsig]: An unexpected exception occurred.")
         println(ex)
 
-        logException(tag, ex)
+        logException(tag, ex, configName)
     }
 }
diff --git a/src/main/kotlin/com/statsig/sdk/StatsigLogger.kt b/src/main/kotlin/com/statsig/sdk/StatsigLogger.kt
@@ -34,6 +34,7 @@ internal class StatsigLogger(
     private val coroutineScope: CoroutineScope,
     private val network: StatsigNetwork,
     private val statsigMetadata: StatsigMetadata,
+    private val statsigOptions: StatsigOptions,
 ) {
 
     private val executor = Executors.newSingleThreadExecutor()
@@ -131,7 +132,11 @@ internal class StatsigLogger(
 
     fun logDiagnostics(context: ContextType, markers: Collection<Marker>) {
         val event = StatsigEvent(DIAGNOSTICS_EVENT)
-        event.eventMetadata = mapOf("context" to context.toString().lowercase(), "markers" to gson.toJson(markers))
+        event.eventMetadata = mapOf(
+            "context" to context.toString().lowercase(),
+            "markers" to gson.toJson(markers),
+            "statsigOptions" to gson.toJson(statsigOptions.getLoggingCopy()),
+        )
         log(event)
     }
 
diff --git a/src/main/kotlin/com/statsig/sdk/StatsigOptions.kt b/src/main/kotlin/com/statsig/sdk/StatsigOptions.kt
@@ -51,4 +51,17 @@ class StatsigOptions(
     fun getEnvironment(): MutableMap<String, String>? {
         return environment
     }
+
+    fun getLoggingCopy(): Map<String, Any> {
+        return mapOf(
+            "api" to (api ?: "DEFAULT"),
+            "initTimeoutMs" to initTimeoutMs,
+            "localMode" to localMode,
+            "disableDiagnostics" to disableDiagnostics,
+            "rulesetsSyncIntervalMs" to rulesetsSyncIntervalMs,
+            "idListsSyncIntervalMs" to idListsSyncIntervalMs,
+            "setDataStore" to (dataStore != null),
+            "setBootstrapValues" to (bootstrapValues != null),
+        )
+    }
 }
diff --git a/src/main/kotlin/com/statsig/sdk/StatsigServer.kt b/src/main/kotlin/com/statsig/sdk/StatsigServer.kt
@@ -204,7 +204,7 @@ private class StatsigServerImpl() :
         statsigJob = SupervisorJob()
         statsigScope = CoroutineScope(statsigJob + coroutineExceptionHandler)
         network = StatsigNetwork(serverSecret, options, statsigMetadata, errorBoundary)
-        logger = StatsigLogger(statsigScope, network, statsigMetadata)
+        logger = StatsigLogger(statsigScope, network, statsigMetadata, options)
         this.options = options
     }
 
@@ -244,14 +244,14 @@ private class StatsigServerImpl() :
                 logGateExposureImpl(user, gateName, result)
             }
             return@capture result.booleanValue
-        }, { return@capture false })
+        }, { return@capture false }, configName = gateName)
     }
 
     override suspend fun checkGateWithExposureLoggingDisabled(user: StatsigUser, gateName: String): Boolean {
         return errorBoundary.capture("checkGateWithExposureLoggingDisabled", {
             val result = checkGateImpl(user, gateName)
             return@capture result.booleanValue
-        }, { return@capture false })
+        }, { return@capture false }, configName = gateName)
     }
 
     private suspend fun checkGateImpl(user: StatsigUser, gateName: String): ConfigEvaluation {
@@ -298,7 +298,7 @@ private class StatsigServerImpl() :
             return@capture getDynamicConfigFromEvalResult(result, user, dynamicConfigName)
         }, {
             return@capture DynamicConfig.empty(dynamicConfigName)
-        })
+        }, configName = dynamicConfigName)
     }
 
     override suspend fun getConfigWithExposureLoggingDisabled(user: StatsigUser, dynamicConfigName: String): DynamicConfig {
@@ -311,7 +311,7 @@ private class StatsigServerImpl() :
             return@capture getDynamicConfigFromEvalResult(result, normalizedUser, dynamicConfigName)
         }, {
             return@capture DynamicConfig.empty(dynamicConfigName)
-        })
+        }, configName = dynamicConfigName)
     }
 
     override suspend fun manuallyLogConfigExposure(user: StatsigUser, configName: String) {
@@ -330,7 +330,7 @@ private class StatsigServerImpl() :
             return@capture getConfig(user, experimentName)
         }, {
             return@capture DynamicConfig.empty(experimentName)
-        })
+        }, configName = experimentName)
     }
 
     override suspend fun getExperimentWithExposureLoggingDisabled(
@@ -346,7 +346,7 @@ private class StatsigServerImpl() :
             return@capture getDynamicConfigFromEvalResult(result, user, experimentName)
         }, {
             return@capture DynamicConfig.empty(experimentName)
-        })
+        }, configName = experimentName)
     }
 
     override suspend fun getExperimentInLayerForUser(
@@ -383,23 +383,23 @@ private class StatsigServerImpl() :
             return@capture DynamicConfig.empty()
         }, {
             return@capture DynamicConfig.empty()
-        })
+        }, configName = layerName)
     }
 
     override suspend fun getLayer(user: StatsigUser, layerName: String): Layer {
         return this.errorBoundary.capture("getLayer", {
             return@capture getLayerImpl(user, layerName, false)
         }, {
             return@capture Layer.empty(layerName)
-        })
+        }, configName = layerName)
     }
 
     override suspend fun getLayerWithExposureLoggingDisabled(user: StatsigUser, layerName: String): Layer {
         return this.errorBoundary.capture("getLayerWithExposureLoggingDisabled", {
             return@capture getLayerImpl(user, layerName, true)
         }, {
             return@capture Layer.empty(layerName)
-        })
+        }, configName = layerName)
     }
 
     override fun getClientInitializeResponse(
diff --git a/src/test/java/com/statsig/sdk/DiagnosticsTest.kt b/src/test/java/com/statsig/sdk/DiagnosticsTest.kt
@@ -4,6 +4,7 @@ import com.google.gson.Gson
 import com.google.gson.GsonBuilder
 import com.google.gson.ToNumberPolicy
 import com.google.gson.reflect.TypeToken
+import junit.framework.Assert.assertEquals
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.runBlocking
 import okhttp3.mockwebserver.Dispatcher
@@ -55,6 +56,7 @@ class DiagnosticsTest {
         verifyMarker(markers[5], Marker(key = KeyType.GET_ID_LIST_SOURCES, action = ActionType.START, step = StepType.NETWORK_REQUEST))
         verifyMarker(markers[6], Marker(key = KeyType.GET_ID_LIST_SOURCES, action = ActionType.END, step = StepType.NETWORK_REQUEST))
         verifyMarker(markers[7], Marker(key = KeyType.OVERALL, action = ActionType.END))
+        assertEquals(Gson().toJson(options.getLoggingCopy()), diagnosticsEvent!!.eventMetadata!!["statsigOptions"])
     }
 
     @Test
diff --git a/src/test/java/com/statsig/sdk/ErrorBoundaryTest.kt b/src/test/java/com/statsig/sdk/ErrorBoundaryTest.kt
@@ -21,6 +21,7 @@ class ErrorBoundaryTest {
     private lateinit var boundary: ErrorBoundary
     private lateinit var server: MockWebServer
     private lateinit var statsigMetadata: StatsigMetadata
+    private lateinit var options: StatsigOptions
 
     @Before
     internal fun setup() {
@@ -33,7 +34,8 @@ class ErrorBoundaryTest {
             }
         }
         statsigMetadata = StatsigMetadata()
-        boundary = ErrorBoundary("secret-key", StatsigOptions(), statsigMetadata)
+        options = StatsigOptions(idListsSyncIntervalMs = 4000)
+        boundary = ErrorBoundary("secret-key", options, statsigMetadata)
         boundary.uri = server.url("/v1/sdk_exception").toUri()
     }
 
@@ -72,11 +74,12 @@ class ErrorBoundaryTest {
     }
 
     @Test
-    fun testLogsStatsigMetadata() = runBlocking {
+    fun testLogsStatsigMetadataAndOptions() = runBlocking {
         boundary.swallow("") { throw IOException() }
 
         val body = Gson().fromJson(server.takeRequest().body.readUtf8(), Map::class.java)
         assertEquals(body["statsigMetadata"], Gson().fromJson(statsigMetadata.asJson(), Map::class.java))
+        assertEquals(Gson().fromJson(Gson().toJson(options.getLoggingCopy()), Map::class.java), body["setupOptions"])
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ class ErrorBoundaryTest {`
`21`	`21`	`private lateinit var boundary: ErrorBoundary`
`22`	`22`	`private lateinit var server: MockWebServer`
`23`	`23`	`private lateinit var statsigMetadata: StatsigMetadata`
	`24`	`+ private lateinit var options: StatsigOptions`
`24`	`25`
`25`	`26`	`@Before`
`26`	`27`	`internal fun setup() {`
`@@ -33,7 +34,8 @@ class ErrorBoundaryTest {`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`	`statsigMetadata = StatsigMetadata()`
`36`		`- boundary = ErrorBoundary("secret-key", StatsigOptions(), statsigMetadata)`
	`37`	`+ options = StatsigOptions(idListsSyncIntervalMs = 4000)`
	`38`	`+ boundary = ErrorBoundary("secret-key", options, statsigMetadata)`
`37`	`39`	`boundary.uri = server.url("/v1/sdk_exception").toUri()`
`38`	`40`	`}`
`39`	`41`
`@@ -72,11 +74,12 @@ class ErrorBoundaryTest {`
`72`	`74`	`}`
`73`	`75`
`74`	`76`	`@Test`
`75`		`- fun testLogsStatsigMetadata() = runBlocking {`
	`77`	`+ fun testLogsStatsigMetadataAndOptions() = runBlocking {`
`76`	`78`	`boundary.swallow("") { throw IOException() }`
`77`	`79`
`78`	`80`	`val body = Gson().fromJson(server.takeRequest().body.readUtf8(), Map::class.java)`
`79`	`81`	`assertEquals(body["statsigMetadata"], Gson().fromJson(statsigMetadata.asJson(), Map::class.java))`
	`82`	`+ assertEquals(Gson().fromJson(Gson().toJson(options.getLoggingCopy()), Map::class.java), body["setupOptions"])`
`80`	`83`	`}`
`81`	`84`
`82`	`85`	`@Test`