Skip to content

Commit 3fdc310

Browse files
abhaysoodabhaysood
committed
chore(ios): add http_sampling_rate config
1 parent 07163f8 commit 3fdc310

17 files changed

+160
-139
lines changed

‎ios/PublicApi/Measure.swiftinterface‎

Lines changed: 10 additions & 90 deletions
Large diffs are not rendered by default.

‎ios/Sources/MeasureSDK/Swift/Config/ConfigLoader.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ struct BaseConfigLoader: ConfigLoader {
4646

4747
func loadDynamicConfig(onLoaded: @escaping (DynamicConfig) -> Void) {
4848
let cachedConfig = loadConfigFromDisk()
49-
onLoaded(cachedConfig ?? BaseDynamicConfig.default())
49+
onLoaded(cachedConfig ?? BaseDynamicConfig())
5050
refreshConfigFromServer()
5151
}
5252

‎ios/Sources/MeasureSDK/Swift/Config/ConfigProvider.swift‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ final class BaseConfigProvider: ConfigProvider {
4242
}
4343
private let defaultConfig: Config
4444
private let lockQueue = DispatchQueue(label: "sh.measure.config-provider")
45-
private var dynamicConfig: DynamicConfig = BaseDynamicConfig.default()
45+
private var dynamicConfig: DynamicConfig = BaseDynamicConfig()
4646
private var httpPatternState = HttpPatternState(
4747
disableEventPatterns: [],
4848
blocklistPatterns: [],
@@ -132,6 +132,7 @@ final class BaseConfigProvider: ConfigProvider {
132132
var anrTakeScreenshot: Bool { dynamicConfig.anrTakeScreenshot }
133133
var launchSamplingRate: Float { dynamicConfig.launchSamplingRate }
134134
var gestureClickTakeSnapshot: Bool { dynamicConfig.gestureClickTakeSnapshot }
135+
var httpSamplingRate: Float { dynamicConfig.httpSamplingRate }
135136
var httpDisableEventForUrls: [String] { dynamicConfig.httpDisableEventForUrls }
136137
var httpTrackRequestForUrls: [String] { dynamicConfig.httpTrackRequestForUrls }
137138
var httpTrackResponseForUrls: [String] { dynamicConfig.httpTrackResponseForUrls }

‎ios/Sources/MeasureSDK/Swift/Config/DefaultConfig.swift‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,30 @@ struct DefaultConfig {
2020
static let journeyEvents: [EventType] = [.lifecycleSwiftUI,
2121
.lifecycleViewController,
2222
.screenView]
23+
24+
static let maxEventsInBatch: Number = 10_000
25+
static let crashTimelineDurationSeconds: Number = 300
26+
static let anrTimelineDurationSeconds: Number = 300
27+
static let bugReportTimelineDurationSeconds: Number = 300
28+
static let traceSamplingRate: Float = 0.01
29+
static let journeySamplingRate: Float = 0.01
30+
static let screenshotMaskLevel: ScreenshotMaskLevel = .allTextAndMedia
31+
static let cpuUsageInterval: Number = 5
32+
static let memoryUsageInterval: Number = 5
33+
static let crashTakeScreenshot: Bool = true
34+
static let anrTakeScreenshot: Bool = true
35+
static let launchSamplingRate: Float = 0.01
36+
static let gestureClickTakeSnapshot: Bool = true
37+
static let httpSamplingRate: Float = 0.01
38+
static let httpDisableEventForUrls: [String] = []
39+
static let httpTrackRequestForUrls: [String] = []
40+
static let httpTrackResponseForUrls: [String] = []
41+
static let httpBlockedHeaders: [String] = [
42+
"Authorization",
43+
"Cookie",
44+
"Set-Cookie",
45+
"Proxy-Authorization",
46+
"WWW-Authenticate",
47+
"X-Api-Key",
48+
]
2349
}

‎ios/Sources/MeasureSDK/Swift/Config/DynamicConfig.swift‎

Lines changed: 67 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ protocol DynamicConfig {
5959
/// Defaults to true.
6060
var gestureClickTakeSnapshot: Bool { get }
6161

62+
/// Sampling rate for htto events.
63+
/// Defaults to 0.01%.
64+
var httpSamplingRate: Float { get }
65+
6266
/// URLs for which HTTP events should be disabled.
6367
var httpDisableEventForUrls: [String] { get }
6468

@@ -86,36 +90,72 @@ struct BaseDynamicConfig: DynamicConfig, Codable {
8690
let anrTakeScreenshot: Bool
8791
let launchSamplingRate: Float
8892
let gestureClickTakeSnapshot: Bool
93+
let httpSamplingRate: Float
8994
let httpDisableEventForUrls: [String]
9095
let httpTrackRequestForUrls: [String]
9196
let httpTrackResponseForUrls: [String]
9297
let httpBlockedHeaders: [String]
93-
94-
static func `default`() -> BaseDynamicConfig {
95-
BaseDynamicConfig(maxEventsInBatch: 10_000,
96-
crashTimelineDurationSeconds: 300,
97-
anrTimelineDurationSeconds: 300,
98-
bugReportTimelineDurationSeconds: 300,
99-
traceSamplingRate: 0.01,
100-
journeySamplingRate: 0.01,
101-
screenshotMaskLevel: .allTextAndMedia,
102-
cpuUsageInterval: 5,
103-
memoryUsageInterval: 5,
104-
crashTakeScreenshot: true,
105-
anrTakeScreenshot: true,
106-
launchSamplingRate: 0.01,
107-
gestureClickTakeSnapshot: true,
108-
httpDisableEventForUrls: [],
109-
httpTrackRequestForUrls: [],
110-
httpTrackResponseForUrls: [],
111-
httpBlockedHeaders: [
112-
"Authorization",
113-
"Cookie",
114-
"Set-Cookie",
115-
"Proxy-Authorization",
116-
"WWW-Authenticate",
117-
"X-Api-Key",
118-
])
98+
99+
init(maxEventsInBatch: Number = DefaultConfig.maxEventsInBatch,
100+
crashTimelineDurationSeconds: Number = DefaultConfig.crashTimelineDurationSeconds,
101+
anrTimelineDurationSeconds: Number = DefaultConfig.anrTimelineDurationSeconds,
102+
bugReportTimelineDurationSeconds: Number = DefaultConfig.bugReportTimelineDurationSeconds,
103+
traceSamplingRate: Float = DefaultConfig.traceSamplingRate,
104+
journeySamplingRate: Float = DefaultConfig.journeySamplingRate,
105+
screenshotMaskLevel: ScreenshotMaskLevel = DefaultConfig.screenshotMaskLevel,
106+
cpuUsageInterval: Number = DefaultConfig.cpuUsageInterval,
107+
memoryUsageInterval: Number = DefaultConfig.memoryUsageInterval,
108+
crashTakeScreenshot: Bool = DefaultConfig.crashTakeScreenshot,
109+
anrTakeScreenshot: Bool = DefaultConfig.anrTakeScreenshot,
110+
launchSamplingRate: Float = DefaultConfig.launchSamplingRate,
111+
gestureClickTakeSnapshot: Bool = DefaultConfig.gestureClickTakeSnapshot,
112+
httpSamplingRate: Float = DefaultConfig.httpSamplingRate,
113+
httpDisableEventForUrls: [String] = DefaultConfig.httpDisableEventForUrls,
114+
httpTrackRequestForUrls: [String] = DefaultConfig.httpTrackRequestForUrls,
115+
httpTrackResponseForUrls: [String] = DefaultConfig.httpTrackResponseForUrls,
116+
httpBlockedHeaders: [String] = DefaultConfig.httpBlockedHeaders
117+
) {
118+
self.maxEventsInBatch = maxEventsInBatch
119+
self.crashTimelineDurationSeconds = crashTimelineDurationSeconds
120+
self.anrTimelineDurationSeconds = anrTimelineDurationSeconds
121+
self.bugReportTimelineDurationSeconds = bugReportTimelineDurationSeconds
122+
self.traceSamplingRate = traceSamplingRate
123+
self.journeySamplingRate = journeySamplingRate
124+
self.screenshotMaskLevel = screenshotMaskLevel
125+
self.cpuUsageInterval = cpuUsageInterval
126+
self.memoryUsageInterval = memoryUsageInterval
127+
self.crashTakeScreenshot = crashTakeScreenshot
128+
self.anrTakeScreenshot = anrTakeScreenshot
129+
self.launchSamplingRate = launchSamplingRate
130+
self.gestureClickTakeSnapshot = gestureClickTakeSnapshot
131+
self.httpSamplingRate = httpSamplingRate
132+
self.httpDisableEventForUrls = httpDisableEventForUrls
133+
self.httpTrackRequestForUrls = httpTrackRequestForUrls
134+
self.httpTrackResponseForUrls = httpTrackResponseForUrls
135+
self.httpBlockedHeaders = httpBlockedHeaders
136+
}
137+
138+
init(from decoder: Decoder) throws {
139+
let c = try decoder.container(keyedBy: CodingKeys.self)
140+
141+
maxEventsInBatch = try c.decodeIfPresent(Number.self, forKey: .maxEventsInBatch) ?? DefaultConfig.maxEventsInBatch
142+
crashTimelineDurationSeconds = try c.decodeIfPresent(Number.self, forKey: .crashTimelineDurationSeconds) ?? DefaultConfig.crashTimelineDurationSeconds
143+
anrTimelineDurationSeconds = try c.decodeIfPresent(Number.self, forKey: .anrTimelineDurationSeconds) ?? DefaultConfig.anrTimelineDurationSeconds
144+
bugReportTimelineDurationSeconds = try c.decodeIfPresent(Number.self, forKey: .bugReportTimelineDurationSeconds) ?? DefaultConfig.bugReportTimelineDurationSeconds
145+
traceSamplingRate = try c.decodeIfPresent(Float.self, forKey: .traceSamplingRate) ?? DefaultConfig.traceSamplingRate
146+
journeySamplingRate = try c.decodeIfPresent(Float.self, forKey: .journeySamplingRate) ?? DefaultConfig.journeySamplingRate
147+
screenshotMaskLevel = try c.decodeIfPresent(ScreenshotMaskLevel.self, forKey: .screenshotMaskLevel) ?? DefaultConfig.screenshotMaskLevel
148+
cpuUsageInterval = try c.decodeIfPresent(Number.self, forKey: .cpuUsageInterval) ?? DefaultConfig.cpuUsageInterval
149+
memoryUsageInterval = try c.decodeIfPresent(Number.self, forKey: .memoryUsageInterval) ?? DefaultConfig.memoryUsageInterval
150+
crashTakeScreenshot = try c.decodeIfPresent(Bool.self, forKey: .crashTakeScreenshot) ?? DefaultConfig.crashTakeScreenshot
151+
anrTakeScreenshot = try c.decodeIfPresent(Bool.self, forKey: .anrTakeScreenshot) ?? DefaultConfig.anrTakeScreenshot
152+
launchSamplingRate = try c.decodeIfPresent(Float.self, forKey: .launchSamplingRate) ?? DefaultConfig.launchSamplingRate
153+
gestureClickTakeSnapshot = try c.decodeIfPresent(Bool.self, forKey: .gestureClickTakeSnapshot) ?? DefaultConfig.gestureClickTakeSnapshot
154+
httpSamplingRate = try c.decodeIfPresent(Float.self, forKey: .httpSamplingRate) ?? DefaultConfig.httpSamplingRate
155+
httpDisableEventForUrls = try c.decodeIfPresent([String].self, forKey: .httpDisableEventForUrls) ?? DefaultConfig.httpDisableEventForUrls
156+
httpTrackRequestForUrls = try c.decodeIfPresent([String].self, forKey: .httpTrackRequestForUrls) ?? DefaultConfig.httpTrackRequestForUrls
157+
httpTrackResponseForUrls = try c.decodeIfPresent([String].self, forKey: .httpTrackResponseForUrls) ?? DefaultConfig.httpTrackResponseForUrls
158+
httpBlockedHeaders = try c.decodeIfPresent([String].self, forKey: .httpBlockedHeaders) ?? DefaultConfig.httpBlockedHeaders
119159
}
120160

121161
private enum CodingKeys: String, CodingKey {
@@ -132,6 +172,7 @@ struct BaseDynamicConfig: DynamicConfig, Codable {
132172
case anrTakeScreenshot = "anr_take_screenshot"
133173
case launchSamplingRate = "launch_sampling_rate"
134174
case gestureClickTakeSnapshot = "gesture_click_take_snapshot"
175+
case httpSamplingRate = "http_sampling_rate"
135176
case httpDisableEventForUrls = "http_disable_event_for_urls"
136177
case httpTrackRequestForUrls = "http_track_request_for_urls"
137178
case httpTrackResponseForUrls = "http_track_response_for_urls"

‎ios/Sources/MeasureSDK/Swift/Events/InternalSignalCollector.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ final class BaseInternalSignalCollector: InternalSignalCollector {
173173
attachments: nil,
174174
userDefinedAttributes: serializedUserDefinedAttributes,
175175
threadName: threadName,
176-
needsReporting: false
176+
needsReporting: signalSampler.shouldSampleHttpEvent()
177177
)
178178

179179
case EventType.bugReport.rawValue:

‎ios/Sources/MeasureSDK/Swift/Events/SignalSampler.swift‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ protocol SignalSampler {
1111
func shouldTrackLaunchEvents() -> Bool
1212
func shouldSampleTrace(_ traceId: String) -> Bool
1313
func shouldTrackJourneyForSession(sessionId: String) -> Bool
14+
func shouldSampleHttpEvent() -> Bool
1415
}
1516

1617
final class BaseSignalSampler: SignalSampler {
@@ -69,6 +70,14 @@ final class BaseSignalSampler: SignalSampler {
6970

7071
return stableSamplingValue(sessionId: sessionId) < samplingRate
7172
}
73+
74+
func shouldSampleHttpEvent() -> Bool {
75+
if configProvider.enableFullCollectionMode {
76+
return true
77+
}
78+
return shouldTrack(configProvider.httpSamplingRate / 100)
79+
}
80+
7281

7382
/// Generates a stable sampling value in [0, 1] from a session ID.
7483
///

‎ios/Sources/MeasureSDK/Swift/Events/UserTriggeredEventCollector.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ final class BaseUserTriggeredEventCollector: UserTriggeredEventCollector {
178178
responseBody: shouldTrackResponseHttpBody ? responseBody : nil,
179179
client: client)
180180

181-
track(data, type: .http, needsReporting: false)
181+
track(data, type: .http, needsReporting: signalSampler.shouldSampleHttpEvent())
182182
}
183183

184184
private func track(_ data: Codable, type: EventType, userDefinedAttributes: String? = nil, needsReporting: Bool?) {
@@ -190,7 +190,7 @@ final class BaseUserTriggeredEventCollector: UserTriggeredEventCollector {
190190
attachments: nil,
191191
userDefinedAttributes: userDefinedAttributes,
192192
threadName: nil,
193-
needsReporting: needsReporting)
193+
needsReporting: signalSampler.shouldSampleHttpEvent())
194194
}
195195

196196
private func getContentType(headers: [String: String]?) -> String? {

‎ios/Sources/MeasureSDK/Swift/Http/HttpEventCollector.swift‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ final class BaseHttpEventCollector: HttpEventCollector {
2020
private let httpInterceptorCallbacks: HttpInterceptorCallbacks
2121
private let client: Client
2222
private let configProvider: ConfigProvider
23+
private let signalSampler: SignalSampler
2324
private let httpEventValidator: HttpEventValidator
2425
private var isEnabled = AtomicBool(false)
2526

@@ -30,6 +31,7 @@ final class BaseHttpEventCollector: HttpEventCollector {
3031
httpInterceptorCallbacks: HttpInterceptorCallbacks,
3132
client: Client,
3233
configProvider: ConfigProvider,
34+
signalSampler: SignalSampler,
3335
httpEventValidator: HttpEventValidator) {
3436
self.logger = logger
3537
self.signalProcessor = signalProcessor
@@ -38,6 +40,7 @@ final class BaseHttpEventCollector: HttpEventCollector {
3840
self.httpInterceptorCallbacks = httpInterceptorCallbacks
3941
self.client = client
4042
self.configProvider = configProvider
43+
self.signalSampler = signalSampler
4144
self.httpEventValidator = httpEventValidator
4245
self.httpInterceptorCallbacks.httpDataCallback = onHttpCompletion(data:)
4346
}
@@ -51,6 +54,7 @@ final class BaseHttpEventCollector: HttpEventCollector {
5154
URLSessionTaskInterceptor.shared.setHttpInterceptorCallbacks(httpInterceptorCallbacks)
5255
URLSessionTaskInterceptor.shared.setTimeProvider(timeProvider)
5356
URLSessionTaskInterceptor.shared.setConfigProvider(configProvider)
57+
URLSessionTaskInterceptor.shared.setSignalSampler(signalSampler)
5458
logger.log(level: .info, message: "HttpEventCollector enabled.", error: nil, data: nil)
5559
}
5660
}

‎ios/Sources/MeasureSDK/Swift/Http/URLSessionTaskInterceptor.swift‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ final class URLSessionTaskInterceptor {
1515
private var configProvider: ConfigProvider?
1616
private var recentRequests: [String: UInt64] = [:]
1717
private let dedupeWindowMs: UInt64 = 300
18+
private var signalSampler: SignalSampler?
1819

1920
private init() {}
2021

@@ -29,18 +30,27 @@ final class URLSessionTaskInterceptor {
2930
func setConfigProvider(_ configProvider: ConfigProvider) {
3031
self.configProvider = configProvider
3132
}
33+
34+
func setSignalSampler(_ signalSampler: SignalSampler) {
35+
self.signalSampler = signalSampler
36+
}
3237

3338
func urlSessionTask(_ task: URLSessionTask, setState state: URLSessionTask.State) { // swiftlint:disable:this function_body_length
3439
guard !MSRNetworkInterceptor.isEnabled else { return }
3540

3641
guard let httpInterceptorCallbacks = self.httpInterceptorCallbacks,
3742
let timeProvider = self.timeProvider,
3843
let configProvider = self.configProvider,
44+
let signalSampler = self.signalSampler,
3945
let url = task.currentRequest?.url?.absoluteString else { return }
4046

4147
guard configProvider.shouldTrackHttpUrl(url: url) else {
4248
return
4349
}
50+
51+
guard signalSampler.shouldTrackLaunchEvents() else {
52+
return
53+
}
4454

4555
if state == .running, taskStartTimes[task] == nil {
4656
taskStartTimes[task] = UnsignedNumber(timeProvider.millisTime)

0 commit comments

Comments
 (0)