Telemetry Metrics (#214)

Telemetry to record some basic usage data for the purpose of guiding development towards features that get used.  Must be enabled to send data.

Author: MichaelGHSeg

.gitignore

@@ -14,3 +14,4 @@
 .cxx
 local.properties
 .idea
+/core/bin

android/src/androidTest/java/com/segment/analytics/ExampleInstrumentedTest.kt

@@ -2,6 +2,7 @@ package com.segment.analytics
 
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.segment.analytics.kotlin.core.Telemetry
 
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -15,6 +16,10 @@ import org.junit.Assert.*
  */
 @RunWith(AndroidJUnit4::class)
 class ExampleInstrumentedTest {
+    init {
+        Telemetry.enable = false
+    }
+
     @Test
     fun useAppContext() {
         // Context of the app under test.

android/src/test/java/com/segment/analytics/kotlin/android/AndroidAnalyticsKtTest.kt

@@ -1,11 +1,16 @@
 package com.segment.analytics.kotlin.android
 
+import com.segment.analytics.kotlin.core.Telemetry
 import org.junit.jupiter.api.Assertions.*
 
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
 
 internal class AndroidAnalyticsKtTest {
+    init {
+        Telemetry.enable = false
+    }
+
     @Test
     fun `jvm initializer in android platform should failed`() {
         val exception =  assertThrows<Exception> {

android/src/test/java/com/segment/analytics/kotlin/android/AndroidContextCollectorTests.kt

@@ -31,6 +31,10 @@ class AndroidContextCollectorTests {
     private val testDispatcher = UnconfinedTestDispatcher()
     private val testScope = TestScope(testDispatcher)
 
+    init {
+        Telemetry.enable = false
+    }
+
     @Before
     fun setUp() {
         appContext = spyk(InstrumentationRegistry.getInstrumentation().targetContext)

android/src/test/java/com/segment/analytics/kotlin/android/AndroidLifecyclePluginTests.kt

@@ -41,6 +41,7 @@ class AndroidLifecyclePluginTests {
     private val testScope = TestScope(testDispatcher)
 
     init {
+        Telemetry.enable = false
         val packageInfo = PackageInfo()
         packageInfo.versionCode = 100
         packageInfo.versionName = "1.0.0"

android/src/test/java/com/segment/analytics/kotlin/android/EventsFileTests.kt

@@ -7,6 +7,7 @@ import com.segment.analytics.kotlin.core.emptyJsonObject
 import com.segment.analytics.kotlin.core.utilities.EncodeDefaultsJson
 import com.segment.analytics.kotlin.core.utilities.EventsFileManager
 import com.segment.analytics.kotlin.core.utilities.SegmentInstant
+import com.segment.analytics.kotlin.core.Telemetry
 import io.mockk.every
 import io.mockk.mockkObject
 import kotlinx.coroutines.test.runTest
@@ -32,6 +33,7 @@ class EventsFileTests {
     private val directory = File("/tmp/analytics-android-test/")
 
     init {
+        Telemetry.enable = false
         mockkObject(SegmentInstant)
         every { SegmentInstant.now() } returns Date(0).toInstant().toString()
     }

android/src/test/java/com/segment/analytics/kotlin/android/StorageTests.kt

@@ -9,6 +9,7 @@ import com.segment.analytics.kotlin.core.Configuration
 import com.segment.analytics.kotlin.core.Settings
 import com.segment.analytics.kotlin.core.Storage
 import com.segment.analytics.kotlin.core.System
+import com.segment.analytics.kotlin.core.Telemetry
 import com.segment.analytics.kotlin.core.TrackEvent
 import com.segment.analytics.kotlin.core.UserInfo
 import com.segment.analytics.kotlin.core.emptyJsonObject
@@ -43,6 +44,10 @@ class StorageTests {
         private lateinit var androidStorage: AndroidStorage
         private var mockContext: Context = mockContext()
 
+        init {
+            Telemetry.enable = false
+        }
+
         @BeforeEach
         fun setup() = runTest  {
             clearPersistentStorage()

core/src/main/java/com/segment/analytics/kotlin/core/Analytics.kt

@@ -93,9 +93,11 @@ open class Analytics protected constructor(
         object : CoroutineConfiguration {
             override val store = Store()
             val exceptionHandler = CoroutineExceptionHandler { _, t ->
-                Analytics.segmentLog(
-                    "Caught Exception in Analytics Scope: ${t}"
-                )
+                reportErrorWithMetrics(null, t,"Caught Exception in Analytics Scope",
+                    Telemetry.INVOKE_ERROR_METRIC, t.stackTraceToString()) {
+                    it["error"] = t.toString()
+                    it["message"] = "Exception in Analytics Scope"
+                }
             }
             override val analyticsScope = CoroutineScope(SupervisorJob() + exceptionHandler)
             override val analyticsDispatcher: CloseableCoroutineDispatcher =
@@ -114,6 +116,14 @@ open class Analytics protected constructor(
         add(ContextPlugin())
         add(UserInfoPlugin())
 
+        Telemetry.increment(Telemetry.INVOKE_METRIC) {
+            it["message"] = "configured"
+            it["apihost"] = configuration.apiHost
+            it["cdnhost"] = configuration.cdnHost
+            it["flush"] =
+                "at:${configuration.flushAt} int:${configuration.flushInterval} pol:${configuration.flushPolicies.count()}"
+        }
+
         // Setup store
         analyticsScope.launch(analyticsDispatcher) {
             store.also {
@@ -123,6 +133,7 @@ open class Analytics protected constructor(
 
                 // subscribe to store after state is provided
                 storage.subscribeToStore()
+                Telemetry.subscribe(store)
             }
 
             if (configuration.autoAddSegmentDestination) {

core/src/main/java/com/segment/analytics/kotlin/core/Errors.kt

@@ -10,6 +10,16 @@ fun Analytics.reportInternalError(error: Throwable) {
     Analytics.reportInternalError(error)
 }
 
+fun reportErrorWithMetrics(analytics: Analytics?, error: Throwable,
+                           message: String, metric:String,
+                           log: String, buildTags: (MutableMap<String, String>) -> Unit) {
+    analytics?.configuration?.errorHandler?.invoke(error)
+    var fullMessage = message
+    error.message?.let { fullMessage += ": $it"}
+    Analytics.segmentLog(fullMessage)
+    Telemetry.error(metric, log, buildTags)
+}
+
 fun Analytics.Companion.reportInternalError(error: Throwable) {
     error.message?.let {
         Analytics.segmentLog(it)

core/src/main/java/com/segment/analytics/kotlin/core/HTTPClient.kt

@@ -34,7 +34,12 @@ class HTTPClient(
             URL(url)
         } catch (e: MalformedURLException) {
             val error = IOException("Attempted to use malformed url: $url", e)
-            Analytics.reportInternalError(error)
+            reportErrorWithMetrics(null, e,"Attempted to use malformed url: $url",
+                Telemetry.INVOKE_ERROR_METRIC, e.stackTraceToString()) {
+                it["error"] = e.toString()
+                it["writekey"] = writeKey
+                it["message"] = "Malformed url"
+            }
             throw error
         }
         val connection = requestedURL.openConnection() as HttpURLConnection
@@ -105,7 +110,7 @@ internal fun HttpURLConnection.createPostConnection(): Connection {
                         inputStream?.close()
                     }
                     throw HTTPException(
-                        responseCode, connection.responseMessage, responseBody
+                        responseCode, connection.responseMessage, responseBody, connection.headerFields
                     )
                 }
             } finally {
@@ -119,7 +124,8 @@ internal fun HttpURLConnection.createPostConnection(): Connection {
 internal class HTTPException(
     val responseCode: Int,
     val responseMessage: String,
-    val responseBody: String?
+    val responseBody: String?,
+    val responseHeaders: MutableMap<String, MutableList<String>>
 ) :
     IOException("HTTP $responseCode: $responseMessage. Response: ${responseBody ?: "No response"}") {
     fun is4xx(): Boolean {