Increase beacon flush timeout interval to 2 minutes and also configurable (#101)

Author: Hongyan Jiang

Changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.9.6
+- increase timeoutInterval for beacon flushing URLRequest to 2 minutes and also configurable
+
 ## 1.9.5
 - check network/battery condition before beacon flush to avoid beacon accidentally get deleted
 

Dev/InstanaAgentExample/AppDelegate.swift

@@ -33,13 +33,15 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 //        options.trustDeviceTiming = true
 //        options.perfConfig = InstanaPerformanceConfig(enableAppStartTimeReport: false, enableAnrReport: true, anrThreshold: 5.0, enableLowMemoryReport: true, enableAppStateDetection: false)
 //        options.enableW3CHeaders = true
+//        options.timeoutInterval = 60.0
         if !Instana.setup(key: InstanaKey, reportingURL: InstanaURL, options: options) {
             os_log("Instana setup failed", log: myLog, type: .error)
         }
 
         let headerFilterReg = try! NSRegularExpression(pattern: "Content-Type", options: .caseInsensitive)
         Instana.setCaptureHeaders(matching: [headerFilterReg])
 
+        Instana.setUser(id: "testUserId1", email: "test1@ibm.com", name:"testUserName1")
         return true
     }
 

Dev/InstanaAgentExample/JSONViewController.swift

@@ -27,7 +27,8 @@ class JSONViewController: UIViewController {
     override func viewDidAppear(_ animated: Bool) {
         super.viewDidAppear(animated)
 //        Instana.setView(name: "JSONView")
-        searchTextField.text = "https://www.ibm.com/de-de?abc=123&password=ps"
+//        searchTextField.text = "https://www.ibm.com/de-de?abc=123&password=ps"
+        searchTextField.text = "https://www.example.com"
     }
 
     @IBAction func loadJSON() {

Dev/InstanaAgentExample/TopRatedViewController.swift

@@ -23,6 +23,7 @@ class TopRatedViewController: UITableViewController {
     }
 
     override func viewWillAppear(_ animated: Bool) {
+        super.viewWillAppear(animated)
         tableView.reloadData()
     }
 

Dev/ObjectiveCAppExample/AppDelegate.m

@@ -29,10 +29,17 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     [perfConfig setAnrThreshold: 5.0];
     [perfConfig setEnableAnrReport: true];
 
+    // note: explicitly get user permission before setting enableCrashReporting to true
+
+    // example 2
+    options = [[InstanaSetupOptions alloc] init];
+    options.enableCrashReporting = true;
+    options.queryTrackedDomainList = queryTrackedDomainList;
+    options.perfConfig = perfConfig;
     options.trustDeviceTiming = true;
     options.enableW3CHeaders = true;
 
-//    note: explicitly get user permission before setting enableCrashReporting to true
+    // example 3
     options = [[InstanaSetupOptions alloc] initWithHttpCaptureConfig: 0
                                            collectionEnabled: true
                                            enableCrashReporting: true
@@ -47,7 +54,11 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
                                            rateLimits: 0
                                            perfConfig: perfConfig
                                            trustDeviceTiming: false
-                                           enableW3CHeaders: true];
+                                           enableW3CHeaders: true
+                                           deleteOldBeacons: false
+                                           maxBeaconResendTries: 0 // no retry beacon send on failure
+                                           timeoutInterval: 60.0
+                                           ];
      */
 
     (void)[Instana setupWithKey: @"INSTANA_REPORTING_KEY"

InstanaAgent.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   #
 
   s.name         = "InstanaAgent"
-  s.version      = "1.9.5"
+  s.version      = "1.9.6"
   s.summary      = "Instana iOS agent."
 
   # This description is used to generate tags and improve search results.

Sources/InstanaAgent/Beacons/BeaconFlusher.swift

@@ -152,10 +152,10 @@ class BeaconFlusher {
         return retryStep < config.maxRetries
     }
 
-    private func retry() {
-        retryStep += 1
-        queue.asyncAfter(deadline: .now() + .milliseconds(retryDelayMilliseconds(for: retryStep)), execute: flush)
-    }
+//    private func retry() {
+//        retryStep += 1
+//        queue.asyncAfter(deadline: .now() + .milliseconds(retryDelayMilliseconds(for: retryStep)), execute: flush)
+//    }
 
     private func complete() {
         if !errors.isEmpty, !sentBeacons.isEmpty {
@@ -213,6 +213,10 @@ class BeaconFlusher {
         urlRequest.httpMethod = "POST"
         urlRequest.addValue("text/plain", forHTTPHeaderField: "Content-Type")
 
+        // Default timeout interval 1 minute from URLRequest is too short for some networks.
+        // Increase the interval to 2 minutes by default and also make it configurable to the app.
+        urlRequest.timeoutInterval = config.timeoutInterval
+
         let data = beacons.data(using: .utf8)
 
         if config.gzipReport, let gzippedData = try? data?.gzipped(level: .bestCompression) {

Sources/InstanaAgent/Beacons/Reporter.swift

@@ -189,7 +189,7 @@ public class Reporter {
             return true
         }
 
-        let maxFlushingTimeAllowed = 100.0 // in seconds
+        let maxFlushingTimeAllowed = session.configuration.timeoutInterval + 100.0 // in seconds
 
         let diff = Date().timeIntervalSince1970 - lastFlushStartTime!
         if diff > maxFlushingTimeAllowed {

Sources/InstanaAgent/Configuration/Defines.swift

@@ -4,6 +4,12 @@
 
 import Foundation
 
+// Default network timeout interval for posting beacons to Instana backend
+public let defaultTimeoutInterval = 120.0 // default to 2 minutes
+
+// Default beacon send failure retry times
+public let defaultMaxBeaconResendTries = 2
+
 // Default user_session_id refresh time interval as negative number means never refresh
 // ie. keep the same user_session_id forever
 public let defaultUsiRefreshTimeIntervalInHrs: Double = -1.0

Sources/InstanaAgent/Configuration/InstanaConfiguraton.swift

@@ -76,7 +76,8 @@ class InstanaConfiguration {
     var trustDeviceTiming: Bool?
     var enableW3CHeaders: Bool?
     var deleteOldBeacons: Bool
-    var maxBeaconResendTries: Int = 3
+    var maxBeaconResendTries: Int
+    var timeoutInterval: TimeInterval
     var enableAppStateDetection: Bool?
     var reporterSendDebounce: Instana.Types.Seconds
     var reporterSendLowBatteryDebounce: Instana.Types.Seconds
@@ -101,6 +102,7 @@ class InstanaConfiguration {
                   enableW3CHeaders: Bool? = nil,
                   deleteOldBeacons: Bool,
                   maxBeaconResendTries: Int,
+                  timeoutInterval: TimeInterval,
                   hybridAgentId: String?,
                   hybridAgentVersion: String?) {
         self.reportingURL = reportingURL
@@ -142,6 +144,7 @@ class InstanaConfiguration {
         self.enableW3CHeaders = enableW3CHeaders
         self.deleteOldBeacons = deleteOldBeacons
         self.maxBeaconResendTries = maxBeaconResendTries
+        self.timeoutInterval = timeoutInterval
         configRateLimit(rateLimits)
     }
 
@@ -187,6 +190,7 @@ class InstanaConfiguration {
                           enableW3CHeaders: Bool? = nil,
                           deleteOldBeacons: Bool,
                           maxBeaconResendTries: Int,
+                          timeoutInterval: TimeInterval,
                           hybridAgentId: String? = nil,
                           hybridAgentVersion: String? = nil)
         -> InstanaConfiguration {
@@ -201,6 +205,7 @@ class InstanaConfiguration {
                   enableW3CHeaders: enableW3CHeaders,
                   deleteOldBeacons: deleteOldBeacons,
                   maxBeaconResendTries: maxBeaconResendTries,
+                  timeoutInterval: timeoutInterval,
                   hybridAgentId: hybridAgentId,
                   hybridAgentVersion: hybridAgentVersion)
     }