support trust device time configuration (#82)

Author: Hongyan Jiang

Changelog.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## 1.9.0
+- add `trustDeviceTiming` configuration option for backend to trust the device timing
 - enable app launch time monitoring by default, other performance monitoring off
 
 ## 1.8.9

Dev/InstanaAgentExample/AppDelegate.swift

@@ -30,6 +30,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         options.queryTrackedDomainList = queryTrackedDomainList
 //        options.dropBeaconReporting = true
 //        options.rateLimits = .MID_LIMITS
+//        options.trustDeviceTiming = true
 //        options.perfConfig = InstanaPerformanceConfig(enableAnrReport: true, anrThreshold: 5.0, enableLowMemoryReport: true)
         if !Instana.setup(key: InstanaKey, reportingURL: InstanaURL, options: options) {
             os_log("Instana setup failed", log: myLog, type: .error)

Dev/ObjectiveCAppExample/AppDelegate.m

@@ -41,7 +41,9 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
                                            debugAllScreenNames: false
                                            queryTrackedDomainList: queryTrackedDomainList
                                            dropBeaconReporting: false
-                                           perfConfig: perfConfig];
+                                           rateLimits: 0
+                                           perfConfig: perfConfig
+                                           trustDeviceTiming: false];
      */
 
     (void)[Instana setupWithKey: @"INSTANA_REPORTING_KEY"

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeacon.swift

@@ -457,6 +457,17 @@ struct CoreBeacon: Codable {
      */
     var umb: String?
 
+    /**
+     * Trust Device Timing
+     *
+     * Helps the backend determine whether to trust the device's time.
+     * 1 means trust, nil means not trust.
+     * nil is the default value.
+     *
+     * For example: 1
+     */
+    var tdt: String?
+
     /**
      * Crash Timestamp
      *

Sources/InstanaAgent/Beacons/CoreBeacon/CoreBeaconFactory.swift

@@ -42,6 +42,7 @@ class CoreBeaconFactory {
                                                timestamp: beacon.timestamp,
                                                sid: session.id, usi: session.usi,
                                                id: beacon.id, mobileFeatures: mobileFeatures,
+                                               trustDeviceTiming: conf.trustDeviceTiming,
                                                hybridAgentId: conf.hybridAgentId,
                                                hybridAgentVersion: conf.hybridAgentVersion)
         cbeacon.append(properties)
@@ -280,6 +281,7 @@ extension CoreBeacon {
                               usi: UUID?,
                               id: String,
                               mobileFeatures: String?,
+                              trustDeviceTiming: Bool? = nil,
                               hybridAgentId: String?,
                               hybridAgentVersion: String?,
                               connection: NetworkUtility.ConnectionType = InstanaSystemUtils.networkUtility.connectionType,
@@ -307,6 +309,7 @@ extension CoreBeacon {
                    vh: String(Int(InstanaSystemUtils.screenSize.height)),
                    cn: connection.cellular.carrierName,
                    ct: connection.description,
-                   ect: ect?.description ?? connection.cellular.description)
+                   ect: ect?.description ?? connection.cellular.description,
+                   tdt: trustDeviceTiming.map { $0 ? "1" : nil } ?? nil)
     }
 }

Sources/InstanaAgent/Configuration/InstanaConfiguraton.swift

@@ -73,6 +73,7 @@ class InstanaConfiguration {
     var slowSendInterval: Instana.Types.Seconds
     var usiRefreshTimeIntervalInHrs: Double
     var anrThreshold: Double?
+    var trustDeviceTiming: Bool?
     var reporterSendDebounce: Instana.Types.Seconds
     var reporterSendLowBatteryDebounce: Instana.Types.Seconds
     var maxRetries: Int
@@ -92,6 +93,7 @@ class InstanaConfiguration {
                   usiRefreshTimeIntervalInHrs: Double,
                   rateLimits: RateLimits?,
                   perfConfig: InstanaPerformanceConfig? = nil,
+                  trustDeviceTiming: Bool? = nil,
                   hybridAgentId: String?,
                   hybridAgentVersion: String?) {
         self.reportingURL = reportingURL
@@ -127,6 +129,7 @@ class InstanaConfiguration {
         preQueueUsageTime = Defaults.preQueueUsageTime
         reporterRateLimits = Defaults.reporterRateLimits
         configRateLimit(rateLimits)
+        self.trustDeviceTiming = trustDeviceTiming
     }
 
     /**
@@ -167,6 +170,7 @@ class InstanaConfiguration {
                           usiRefreshTimeIntervalInHrs: Double = defaultUsiRefreshTimeIntervalInHrs,
                           rateLimits: RateLimits? = nil,
                           perfConfig: InstanaPerformanceConfig? = nil,
+                          trustDeviceTiming: Bool? = nil,
                           hybridAgentId: String? = nil,
                           hybridAgentVersion: String? = nil)
         -> InstanaConfiguration {
@@ -177,6 +181,7 @@ class InstanaConfiguration {
                   usiRefreshTimeIntervalInHrs: usiRefreshTimeIntervalInHrs,
                   rateLimits: rateLimits,
                   perfConfig: perfConfig,
+                  trustDeviceTiming: trustDeviceTiming,
                   hybridAgentId: hybridAgentId,
                   hybridAgentVersion: hybridAgentVersion)
     }

Sources/InstanaAgent/Instana.swift

@@ -102,6 +102,7 @@ import Foundation
         var dropBeaconReporting: Bool = false
         var rateLimits: RateLimits?
         var perfConfig: InstanaPerformanceConfig?
+        var trustDeviceTiming: Bool?
 
         if let options = options {
             httpCaptureConfig = options.httpCaptureConfig
@@ -132,6 +133,7 @@ import Foundation
             dropBeaconReporting = options.dropBeaconReporting
             rateLimits = options.rateLimits
             perfConfig = options.perfConfig
+            trustDeviceTiming = options.trustDeviceTiming
         }
 
         var hybridAgentId: String?
@@ -149,6 +151,7 @@ import Foundation
                                                   usiRefreshTimeIntervalInHrs: usiRefreshTimeIntervalInHrs,
                                                   rateLimits: rateLimits,
                                                   perfConfig: perfConfig,
+                                                  trustDeviceTiming: trustDeviceTiming,
                                                   hybridAgentId: hybridAgentId,
                                                   hybridAgentVersion: hybridAgentVersion)
         let session = InstanaSession(configuration: config, propertyHandler: InstanaPropertyHandler(),

Sources/InstanaAgent/InstanaSetupOptions.swift

@@ -27,6 +27,12 @@ import Foundation
 
     @objc public var perfConfig: InstanaPerformanceConfig?
 
+    /**
+     * When enabled, the backend will consider the device's (beacon creation) time as the actual time, rather than updating it to the ingestion time
+     * (the time the beacon arrived at the server). If the beacon is received after 30 minutes, the ingestion time will be used instead.
+     */
+    @objc public var trustDeviceTiming: Bool = false
+
     /// Instana custom configuration for setup.
     ///
     /// - Parameters:
@@ -47,7 +53,8 @@ import Foundation
          queryTrackedDomainList: [NSRegularExpression]? = nil,
          dropBeaconReporting: Bool = false,
          rateLimits: RateLimits = .DEFAULT_LIMITS,
-         perfConfig: InstanaPerformanceConfig? = nil) {
+         perfConfig: InstanaPerformanceConfig? = nil,
+         trustDeviceTiming: Bool = false) {
         self.httpCaptureConfig = httpCaptureConfig
         self.collectionEnabled = collectionEnabled
         self.enableCrashReporting = enableCrashReporting
@@ -61,6 +68,7 @@ import Foundation
         self.dropBeaconReporting = dropBeaconReporting
         self.rateLimits = rateLimits
         self.perfConfig = perfConfig
+        self.trustDeviceTiming = trustDeviceTiming
         super.init()
     }
 

Tests/InstanaAgentTests/Beacons/CoreBeacon/CoreBeaconTests.swift

@@ -97,7 +97,7 @@ class CoreBeaconTests: InstanaTestCase {
         let values = Mirror(reflecting: sut).children
 
         // Then
-        XCTAssertEqual(values.count, 56)
+        XCTAssertEqual(values.count, 57)
     }
 
     func testNumberOfFields_non_nil() {
@@ -120,7 +120,7 @@ class CoreBeaconTests: InstanaTestCase {
                             "ue", "ul", "ab", "av", "p", "osn", "osv", "dma", "dmo", "ro", "vw", "vh",
                             "im", "cn", "ct", "ect", "hu", "hp", "hm", "hs", "ebs", "dbs", "trs", "d",
                             "ec", "em", "et", "agv", "cen", "cm", "h", "ast", "cid", "pst", "acs", "aws",
-                            "ahs", "mmb", "amb", "umb", "cti", "dt", "st"]
+                            "ahs", "mmb", "amb", "umb", "tdt", "cti", "dt", "st"]
         // When
         let keys = Mirror(reflecting: sut).children.compactMap {$0.label}