-
-
Notifications
You must be signed in to change notification settings - Fork 435
/
SentryOkHttpInterceptor.kt
224 lines (196 loc) · 8.43 KB
/
SentryOkHttpInterceptor.kt
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
package io.sentry.android.okhttp
import io.sentry.BaggageHeader
import io.sentry.Breadcrumb
import io.sentry.Hint
import io.sentry.HttpStatusCodeRange
import io.sentry.HubAdapter
import io.sentry.IHub
import io.sentry.ISpan
import io.sentry.IntegrationName
import io.sentry.SentryIntegrationPackageStorage
import io.sentry.SentryOptions.DEFAULT_PROPAGATION_TARGETS
import io.sentry.SpanDataConvention
import io.sentry.SpanStatus
import io.sentry.TypeCheckHint.OKHTTP_REQUEST
import io.sentry.TypeCheckHint.OKHTTP_RESPONSE
import io.sentry.util.PropagationTargetsUtils
import io.sentry.util.TracingUtils
import io.sentry.util.UrlUtils
import okhttp3.Interceptor
import okhttp3.Request
import okhttp3.Response
import java.io.IOException
/**
* The Sentry's [SentryOkHttpInterceptor], it will automatically add a breadcrumb and start a span
* out of the active span bound to the scope for each HTTP Request.
* If [captureFailedRequests] is enabled, the SDK will capture HTTP Client errors as well.
*
* @param hub The [IHub], internal and only used for testing.
* @param beforeSpan The [ISpan] can be customized or dropped with the [BeforeSpanCallback].
* @param captureFailedRequests The SDK will only capture HTTP Client errors if it is enabled,
* Defaults to false.
* @param failedRequestStatusCodes The SDK will only capture HTTP Client errors if the HTTP Response
* status code is within the defined ranges.
* @param failedRequestTargets The SDK will only capture HTTP Client errors if the HTTP Request URL
* is a match for any of the defined targets.
*/
class SentryOkHttpInterceptor(
private val hub: IHub = HubAdapter.getInstance(),
private val beforeSpan: BeforeSpanCallback? = null,
private val captureFailedRequests: Boolean = false,
private val failedRequestStatusCodes: List<HttpStatusCodeRange> = listOf(
HttpStatusCodeRange(HttpStatusCodeRange.DEFAULT_MIN, HttpStatusCodeRange.DEFAULT_MAX)
),
private val failedRequestTargets: List<String> = listOf(DEFAULT_PROPAGATION_TARGETS)
) : Interceptor, IntegrationName {
constructor() : this(HubAdapter.getInstance())
constructor(hub: IHub) : this(hub, null)
constructor(beforeSpan: BeforeSpanCallback) : this(HubAdapter.getInstance(), beforeSpan)
init {
addIntegrationToSdkVersion()
SentryIntegrationPackageStorage.getInstance()
.addPackage("maven:io.sentry:sentry-android-okhttp", BuildConfig.VERSION_NAME)
}
override fun intercept(chain: Interceptor.Chain): Response {
var request = chain.request()
val urlDetails = UrlUtils.parse(request.url.toString())
val url = urlDetails.urlOrFallback
val method = request.method
val span: ISpan?
val okHttpEvent: SentryOkHttpEvent?
if (SentryOkHttpEventListener.eventMap.containsKey(chain.call())) {
// read the span from the event listener
okHttpEvent = SentryOkHttpEventListener.eventMap[chain.call()]
span = okHttpEvent?.callRootSpan
} else {
// read the span from the bound scope
okHttpEvent = null
span = hub.span?.startChild("http.client", "$method $url")
}
span?.spanContext?.origin = TRACE_ORIGIN
urlDetails.applyToSpan(span)
val isFromEventListener = okHttpEvent != null
var response: Response? = null
var code: Int? = null
try {
val requestBuilder = request.newBuilder()
TracingUtils.traceIfAllowed(
hub,
request.url.toString(),
request.headers(BaggageHeader.BAGGAGE_HEADER),
span
)?.let { tracingHeaders ->
requestBuilder.addHeader(tracingHeaders.sentryTraceHeader.name, tracingHeaders.sentryTraceHeader.value)
tracingHeaders.baggageHeader?.let {
requestBuilder.removeHeader(BaggageHeader.BAGGAGE_HEADER)
requestBuilder.addHeader(it.name, it.value)
}
}
request = requestBuilder.build()
response = chain.proceed(request)
code = response.code
span?.setData(SpanDataConvention.HTTP_STATUS_CODE_KEY, code)
span?.status = SpanStatus.fromHttpStatusCode(code)
// OkHttp errors (4xx, 5xx) don't throw, so it's safe to call within this block.
// breadcrumbs are added on the finally block because we'd like to know if the device
// had an unstable connection or something similar
if (shouldCaptureClientError(request, response)) {
// If we capture the client error directly, it could be associated with the
// currently running span by the backend. In case the listener is in use, that is
// an inner span. So, if the listener is in use, we let it capture the client
// error, to shown it in the http root call span in the dashboard.
if (isFromEventListener && okHttpEvent != null) {
okHttpEvent.setClientErrorResponse(response)
} else {
SentryOkHttpUtils.captureClientError(hub, request, response)
}
}
return response
} catch (e: IOException) {
span?.apply {
this.throwable = e
this.status = SpanStatus.INTERNAL_ERROR
}
throw e
} finally {
finishSpan(span, request, response, isFromEventListener)
// The SentryOkHttpEventListener will send the breadcrumb itself if used for this call
if (!isFromEventListener) {
sendBreadcrumb(request, code, response)
}
}
}
private fun sendBreadcrumb(request: Request, code: Int?, response: Response?) {
val breadcrumb = Breadcrumb.http(request.url.toString(), request.method, code)
request.body?.contentLength().ifHasValidLength {
breadcrumb.setData("http.request_content_length", it)
}
val hint = Hint().also { it.set(OKHTTP_REQUEST, request) }
response?.let {
it.body?.contentLength().ifHasValidLength { responseBodySize ->
breadcrumb.setData(SpanDataConvention.HTTP_RESPONSE_CONTENT_LENGTH_KEY, responseBodySize)
}
hint[OKHTTP_RESPONSE] = it
}
hub.addBreadcrumb(breadcrumb, hint)
}
private fun finishSpan(span: ISpan?, request: Request, response: Response?, isFromEventListener: Boolean) {
if (span == null) {
return
}
if (beforeSpan != null) {
val result = beforeSpan.execute(span, request, response)
if (result == null) {
// span is dropped
span.spanContext.sampled = false
} else {
// The SentryOkHttpEventListener will finish the span itself if used for this call
if (!isFromEventListener) {
span.finish()
}
}
} else {
// The SentryOkHttpEventListener will finish the span itself if used for this call
if (!isFromEventListener) {
span.finish()
}
}
}
private fun Long?.ifHasValidLength(fn: (Long) -> Unit) {
if (this != null && this != -1L) {
fn.invoke(this)
}
}
private fun shouldCaptureClientError(request: Request, response: Response): Boolean {
// return if the feature is disabled or its not within the range
if (!captureFailedRequests || !containsStatusCode(response.code)) {
return false
}
// return if its not a target match
if (!PropagationTargetsUtils.contain(failedRequestTargets, request.url.toString())) {
return false
}
return true
}
private fun containsStatusCode(statusCode: Int): Boolean {
for (item in failedRequestStatusCodes) {
if (item.isInRange(statusCode)) {
return true
}
}
return false
}
/**
* The BeforeSpan callback
*/
fun interface BeforeSpanCallback {
/**
* Mutates or drops span before being added
*
* @param span the span to mutate or drop
* @param request the HTTP request executed by okHttp
* @param response the HTTP response received by okHttp
*/
fun execute(span: ISpan, request: Request, response: Response?): ISpan?
}
}