Added some cleanup for IPs and memory addresses in telemetry errors

Author: MichaelGHSeg

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

@@ -170,6 +170,22 @@ object Telemetry: Subscriber {
         addRemoteMetric(metric, tags)
     }
 
+    fun cleanErrorValue(value: String): String {
+        var cleanedValue = value
+        // Remove IPs
+        cleanedValue = cleanedValue.replace(Regex("\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}[\\d._:port]*"), "_IP")
+        // Remove IPv6
+        cleanedValue = cleanedValue.replace(Regex("[0-9a-fA-F]{2,4}(:[0-9a-fA-F]{0,4}){2,8}[\\d._:port]*"), "_IP")
+        // Remove hex values
+        cleanedValue = cleanedValue.replace(Regex("0x[0-9a-fA-F]+"), "0x00")
+        // Remove hex values that don't have 0x of at least 6 characters
+        cleanedValue = cleanedValue.replace(Regex("[0-9a-fA-F]{6,}"), "0x00")
+        // What even?  Mangled library names probably, e.g. a5.b:_some_error_etc
+        cleanedValue = cleanedValue.replace(Regex("^[a-z][a-z0-9]\\.[a-z]:"), "")
+
+        return cleanedValue
+    }
+
     /**
      * Logs an error metric with the specified tags and log data.
      *
@@ -186,6 +202,10 @@ object Telemetry: Subscriber {
         if (tags.isEmpty()) return
         if (Math.random() > sampleRate) return
 
+        if (tags.containsKey("error")) {
+            tags["error"] = cleanErrorValue(tags["error"]!!)
+        }
+
         var filteredTags = if(sendWriteKeyOnError) {
             tags.toMap()
         } else {

core/src/test/kotlin/com/segment/analytics/kotlin/core/TelemetryTest.kt

@@ -239,4 +239,79 @@ class TelemetryTest {
         }
         assertTrue(TelemetryQueueSize() == Telemetry.maxQueueSize)
     }
-}
+
+    @Test
+    fun `Test error tags are cleaned`() {
+        Telemetry.enable = true
+        Telemetry.start()
+        Telemetry.error(Telemetry.INVOKE_ERROR_METRIC, "error log") {
+            it["error"] = "foo_192.168.0.1:8080"
+        }
+        assertEquals(1, TelemetryQueueSize())
+        val queueField: Field = Telemetry::class.java.getDeclaredField("queue")
+        queueField.isAccessible = true
+        val queueValue: ConcurrentLinkedQueue<*> = queueField.get(Telemetry) as ConcurrentLinkedQueue<*>
+        val metric = queueValue.peek() as RemoteMetric
+        assertEquals("foo__IP", metric.tags["error"])
+    }
+
+    @Test
+    fun `Test error tags are cleaned for IPv6`() {
+        Telemetry.enable = true
+        Telemetry.start()
+        Telemetry.error(Telemetry.INVOKE_ERROR_METRIC, "error log") {
+            it["error"] = "foo_2001:0db8:85a3:0000:0000:8a2e:0370:7334"
+        }
+        assertEquals(1, TelemetryQueueSize())
+        val queueField: Field = Telemetry::class.java.getDeclaredField("queue")
+        queueField.isAccessible = true
+        val queueValue: ConcurrentLinkedQueue<*> = queueField.get(Telemetry) as ConcurrentLinkedQueue<*>
+        val metric = queueValue.peek() as RemoteMetric
+        assertEquals("foo__IP", metric.tags["error"])
+    }
+
+    @Test
+    fun `Test error tags are cleaned for hex values`() {
+        Telemetry.enable = true
+        Telemetry.start()
+        Telemetry.error(Telemetry.INVOKE_ERROR_METRIC, "error log") {
+            it["error"] = "foo_0x1234567890abcdef_bar"
+        }
+        assertEquals(1, TelemetryQueueSize())
+        val queueField: Field = Telemetry::class.java.getDeclaredField("queue")
+        queueField.isAccessible = true
+        val queueValue: ConcurrentLinkedQueue<*> = queueField.get(Telemetry) as ConcurrentLinkedQueue<*>
+        val metric = queueValue.peek() as RemoteMetric
+        assertEquals("foo_0x00_bar", metric.tags["error"])
+    }
+
+    @Test
+    fun `Test error tags are cleaned for sneaky hex values`() {
+        Telemetry.enable = true
+        Telemetry.start()
+        Telemetry.error(Telemetry.INVOKE_ERROR_METRIC, "error log") {
+            it["error"] = "address_deadbeef_face"
+        }
+        assertEquals(1, TelemetryQueueSize())
+        val queueField: Field = Telemetry::class.java.getDeclaredField("queue")
+        queueField.isAccessible = true
+        val queueValue: ConcurrentLinkedQueue<*> = queueField.get(Telemetry) as ConcurrentLinkedQueue<*>
+        val metric = queueValue.peek() as RemoteMetric
+        assertEquals("address_0x00_face", metric.tags["error"])
+    }
+
+    @Test
+    fun `Test error tags are cleaned for mangled library names`() {
+        Telemetry.enable = true
+        Telemetry.start()
+        Telemetry.error(Telemetry.INVOKE_ERROR_METRIC, "error log") {
+            it["error"] = "a5.b:_some_error_etc"
+        }
+        assertEquals(1, TelemetryQueueSize())
+        val queueField: Field = Telemetry::class.java.getDeclaredField("queue")
+        queueField.isAccessible = true
+        val queueValue: ConcurrentLinkedQueue<*> = queueField.get(Telemetry) as ConcurrentLinkedQueue<*>
+        val metric = queueValue.peek() as RemoteMetric
+        assertEquals("_some_error_etc", metric.tags["error"])
+    }
+}