-
-
Notifications
You must be signed in to change notification settings - Fork 315
/
SentryNetworkTracker.m
365 lines (309 loc) · 12.3 KB
/
SentryNetworkTracker.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
#import "SentryNetworkTracker.h"
#import "SentryBaggage.h"
#import "SentryBreadcrumb.h"
#import "SentryHub+Private.h"
#import "SentryLog.h"
#import "SentrySDK+Private.h"
#import "SentryScope+Private.h"
#import "SentrySerialization.h"
#import "SentryTraceContext.h"
#import "SentryTraceHeader.h"
#import "SentryTracer.h"
#import <objc/runtime.h>
@interface
SentryNetworkTracker ()
@property (nonatomic, assign) BOOL isNetworkTrackingEnabled;
@property (nonatomic, assign) BOOL isNetworkBreadcrumbEnabled;
@end
@implementation SentryNetworkTracker
+ (SentryNetworkTracker *)sharedInstance
{
static SentryNetworkTracker *instance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{ instance = [[self alloc] init]; });
return instance;
}
- (instancetype)init
{
if (self = [super init]) {
_isNetworkTrackingEnabled = NO;
_isNetworkBreadcrumbEnabled = NO;
}
return self;
}
- (void)enableNetworkTracking
{
@synchronized(self) {
_isNetworkTrackingEnabled = YES;
}
}
- (void)enableNetworkBreadcrumbs
{
@synchronized(self) {
_isNetworkBreadcrumbEnabled = YES;
}
}
- (void)disable
{
@synchronized(self) {
_isNetworkBreadcrumbEnabled = NO;
_isNetworkTrackingEnabled = NO;
}
}
- (BOOL)addHeadersForRequestWithURL:(NSURL *)URL
{
for (id targetCheck in SentrySDK.options.tracePropagationTargets) {
if ([targetCheck isKindOfClass:[NSRegularExpression class]]) {
NSString *string = URL.absoluteString;
NSUInteger numberOfMatches =
[targetCheck numberOfMatchesInString:string
options:0
range:NSMakeRange(0, [string length])];
if (numberOfMatches > 0) {
return YES;
}
} else if ([targetCheck isKindOfClass:[NSString class]]) {
if ([URL.absoluteString containsString:targetCheck]) {
return YES;
}
}
}
return NO;
}
- (void)urlSessionTaskResume:(NSURLSessionTask *)sessionTask
{
@synchronized(self) {
if (!self.isNetworkTrackingEnabled) {
return;
}
}
if (![self isTaskSupported:sessionTask])
return;
// SDK not enabled no need to continue
if (SentrySDK.options == nil) {
return;
}
NSURL *url = [[sessionTask currentRequest] URL];
if (url == nil) {
return;
}
// Don't measure requests to Sentry's backend
NSURL *apiUrl = [NSURL URLWithString:SentrySDK.options.dsn];
if ([url.host isEqualToString:apiUrl.host] && [url.path containsString:apiUrl.path]) {
return;
}
@synchronized(sessionTask) {
if (sessionTask.state == NSURLSessionTaskStateCompleted
|| sessionTask.state == NSURLSessionTaskStateCanceling) {
return;
}
__block id<SentrySpan> span;
__block id<SentrySpan> netSpan;
netSpan = objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN);
// The task already has a span. Nothing to do.
if (netSpan != nil) {
return;
}
[SentrySDK.currentHub.scope useSpan:^(id<SentrySpan> _Nullable innerSpan) {
if (innerSpan != nil) {
span = innerSpan;
netSpan = [span
startChildWithOperation:SENTRY_NETWORK_REQUEST_OPERATION
description:[NSString stringWithFormat:@"%@ %@",
sessionTask.currentRequest.HTTPMethod, url]];
}
}];
// We only create a span if there is a transaction in the scope,
// otherwise we have nothing else to do here.
if (netSpan == nil) {
SENTRY_LOG_DEBUG(@"No transaction bound to scope. Won't track network operation.");
return;
}
if ([sessionTask currentRequest] &&
[self addHeadersForRequestWithURL:sessionTask.currentRequest.URL]) {
NSString *baggageHeader = @"";
SentryTracer *tracer = [SentryTracer getTracer:span];
if (tracer != nil) {
baggageHeader = [[tracer.traceContext toBaggage]
toHTTPHeaderWithOriginalBaggage:
[SentrySerialization
decodeBaggage:sessionTask.currentRequest
.allHTTPHeaderFields[SENTRY_BAGGAGE_HEADER]]];
}
// First we check if the current request is mutable, so we could easily add a new
// header. Otherwise we try to change the current request for a new one with the extra
// header.
if ([sessionTask.currentRequest isKindOfClass:[NSMutableURLRequest class]]) {
NSMutableURLRequest *currentRequest
= (NSMutableURLRequest *)sessionTask.currentRequest;
[currentRequest setValue:[netSpan toTraceHeader].value
forHTTPHeaderField:SENTRY_TRACE_HEADER];
if (baggageHeader.length > 0) {
[currentRequest setValue:baggageHeader
forHTTPHeaderField:SENTRY_BAGGAGE_HEADER];
}
} else {
// Even though NSURLSessionTask doesn't have 'setCurrentRequest', some subclasses
// do. For those subclasses we replace the currentRequest with a mutable one with
// the additional trace header. Since NSURLSessionTask is a public class and can be
// override, we believe this is not considered a private api.
SEL setCurrentRequestSelector = NSSelectorFromString(@"setCurrentRequest:");
if ([sessionTask respondsToSelector:setCurrentRequestSelector]) {
NSMutableURLRequest *newRequest = [sessionTask.currentRequest mutableCopy];
[newRequest setValue:[netSpan toTraceHeader].value
forHTTPHeaderField:SENTRY_TRACE_HEADER];
if (baggageHeader.length > 0) {
[newRequest setValue:baggageHeader
forHTTPHeaderField:SENTRY_BAGGAGE_HEADER];
}
void (*func)(id, SEL, id param)
= (void *)[sessionTask methodForSelector:setCurrentRequestSelector];
func(sessionTask, setCurrentRequestSelector, newRequest);
}
}
} else {
SENTRY_LOG_DEBUG(@"Not adding trace_id and baggage headers for %@",
sessionTask.currentRequest.URL.absoluteString);
}
SENTRY_LOG_DEBUG(
@"SentryNetworkTracker automatically started HTTP span for sessionTask: %@",
netSpan.description);
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN, netSpan,
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
}
- (void)urlSessionTask:(NSURLSessionTask *)sessionTask setState:(NSURLSessionTaskState)newState
{
if (!self.isNetworkTrackingEnabled && !self.isNetworkBreadcrumbEnabled) {
return;
}
if (![self isTaskSupported:sessionTask]) {
return;
}
if (newState == NSURLSessionTaskStateRunning) {
return;
}
NSURL *url = [[sessionTask currentRequest] URL];
if (url == nil) {
return;
}
// Don't measure requests to Sentry's backend
NSURL *apiUrl = [NSURL URLWithString:SentrySDK.options.dsn];
if ([url.host isEqualToString:apiUrl.host] && [url.path containsString:apiUrl.path]) {
return;
}
id<SentrySpan> netSpan;
@synchronized(sessionTask) {
netSpan = objc_getAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN);
// We'll just go through once
objc_setAssociatedObject(sessionTask, &SENTRY_NETWORK_REQUEST_TRACKER_SPAN, nil,
OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
if (sessionTask.state == NSURLSessionTaskStateRunning) {
[self addBreadcrumbForSessionTask:sessionTask];
NSInteger responseStatusCode = [self urlResponseStatusCode:sessionTask.response];
if (responseStatusCode != -1) {
NSNumber *statusCode = [NSNumber numberWithInteger:responseStatusCode];
if (netSpan != nil) {
[netSpan setTagValue:[NSString stringWithFormat:@"%@", statusCode]
forKey:@"http.status_code"];
}
}
}
if (netSpan == nil) {
return;
}
[netSpan setDataValue:sessionTask.currentRequest.HTTPMethod forKey:@"method"];
[netSpan setDataValue:sessionTask.currentRequest.URL.path forKey:@"url"];
[netSpan setDataValue:@"fetch" forKey:@"type"];
[netSpan finishWithStatus:[self statusForSessionTask:sessionTask state:newState]];
SENTRY_LOG_DEBUG(@"SentryNetworkTracker finished HTTP span for sessionTask");
}
- (void)addBreadcrumbForSessionTask:(NSURLSessionTask *)sessionTask
{
if (!self.isNetworkBreadcrumbEnabled) {
return;
}
SentryLevel breadcrumbLevel = sessionTask.error != nil ? kSentryLevelError : kSentryLevelInfo;
SentryBreadcrumb *breadcrumb = [[SentryBreadcrumb alloc] initWithLevel:breadcrumbLevel
category:@"http"];
breadcrumb.type = @"http";
NSMutableDictionary<NSString *, id> *breadcrumbData = [NSMutableDictionary new];
breadcrumbData[@"url"] = sessionTask.currentRequest.URL.absoluteString;
breadcrumbData[@"method"] = sessionTask.currentRequest.HTTPMethod;
breadcrumbData[@"request_body_size"] =
[NSNumber numberWithLongLong:sessionTask.countOfBytesSent];
breadcrumbData[@"response_body_size"] =
[NSNumber numberWithLongLong:sessionTask.countOfBytesReceived];
NSInteger responseStatusCode = [self urlResponseStatusCode:sessionTask.response];
if (responseStatusCode != -1) {
NSNumber *statusCode = [NSNumber numberWithInteger:responseStatusCode];
breadcrumbData[@"status_code"] = statusCode;
breadcrumbData[@"reason"] =
[NSHTTPURLResponse localizedStringForStatusCode:responseStatusCode];
}
breadcrumb.data = breadcrumbData;
[SentrySDK addBreadcrumb:breadcrumb];
}
- (NSInteger)urlResponseStatusCode:(NSURLResponse *)response
{
if (response != nil && [response isKindOfClass:[NSHTTPURLResponse class]]) {
return ((NSHTTPURLResponse *)response).statusCode;
}
return -1;
}
- (SentrySpanStatus)statusForSessionTask:(NSURLSessionTask *)task state:(NSURLSessionTaskState)state
{
switch (state) {
case NSURLSessionTaskStateSuspended:
return kSentrySpanStatusAborted;
case NSURLSessionTaskStateCanceling:
return kSentrySpanStatusCancelled;
case NSURLSessionTaskStateCompleted:
return task.error != nil
? kSentrySpanStatusUnknownError
: [self spanStatusForHttpResponseStatusCode:[self urlResponseStatusCode:task.response]];
case NSURLSessionTaskStateRunning:
break;
}
return kSentrySpanStatusUndefined;
}
- (BOOL)isTaskSupported:(NSURLSessionTask *)task
{
// Since streams are usually created to stay connected we don't measure this type of data
// transfer.
return [task isKindOfClass:[NSURLSessionDataTask class]] ||
[task isKindOfClass:[NSURLSessionDownloadTask class]] ||
[task isKindOfClass:[NSURLSessionUploadTask class]];
}
// https://develop.sentry.dev/sdk/event-payloads/span/
- (SentrySpanStatus)spanStatusForHttpResponseStatusCode:(NSInteger)statusCode
{
if (statusCode >= 200 && statusCode < 300) {
return kSentrySpanStatusOk;
}
switch (statusCode) {
case 400:
return kSentrySpanStatusInvalidArgument;
case 401:
return kSentrySpanStatusUnauthenticated;
case 403:
return kSentrySpanStatusPermissionDenied;
case 404:
return kSentrySpanStatusNotFound;
case 409:
return kSentrySpanStatusAborted;
case 429:
return kSentrySpanStatusResourceExhausted;
case 500:
return kSentrySpanStatusInternalError;
case 501:
return kSentrySpanStatusUnimplemented;
case 503:
return kSentrySpanStatusUnavailable;
case 504:
return kSentrySpanStatusDeadlineExceeded;
}
return kSentrySpanStatusUndefined;
}
@end