-
-
Notifications
You must be signed in to change notification settings - Fork 427
/
SentryOkHttpInterceptor.kt
257 lines (220 loc) · 9.18 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
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
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.SentryEvent
import io.sentry.SpanStatus
import io.sentry.TypeCheckHint.OKHTTP_REQUEST
import io.sentry.TypeCheckHint.OKHTTP_RESPONSE
import io.sentry.exception.ExceptionMechanismException
import io.sentry.exception.SentryHttpClientException
import io.sentry.protocol.Mechanism
import io.sentry.util.HttpUtils
import io.sentry.util.PropagationTargetsUtils
import okhttp3.Headers
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(".*")
) : Interceptor {
constructor() : this(HubAdapter.getInstance())
constructor(hub: IHub) : this(hub, null)
constructor(beforeSpan: BeforeSpanCallback) : this(HubAdapter.getInstance(), beforeSpan)
override fun intercept(chain: Interceptor.Chain): Response {
var request = chain.request()
val url = request.url.toString()
val method = request.method
// read transaction from the bound scope
val span = hub.span?.startChild("http.client", "$method $url")
var response: Response? = null
var code: Int? = null
try {
val requestBuilder = request.newBuilder()
if (span != null &&
PropagationTargetsUtils.contain(hub.options.tracePropagationTargets, request.url.toString())
) {
span.toSentryTrace().let {
requestBuilder.addHeader(it.name, it.value)
}
span.toBaggageHeader(request.headers(BaggageHeader.BAGGAGE_HEADER))?.let {
requestBuilder.removeHeader(BaggageHeader.BAGGAGE_HEADER)
requestBuilder.addHeader(it.name, it.value)
}
}
request = requestBuilder.build()
response = chain.proceed(request)
code = response.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
captureEvent(request, response)
return response
} catch (e: IOException) {
span?.apply {
this.throwable = e
this.status = SpanStatus.INTERNAL_ERROR
}
throw e
} finally {
finishSpan(span, request, response)
val breadcrumb = Breadcrumb.http(request.url.toString(), request.method, code)
request.body?.contentLength().ifHasValidLength {
breadcrumb.setData("request_body_size", it)
}
val hint = Hint()
.also { it.set(OKHTTP_REQUEST, request) }
response?.let {
it.body?.contentLength().ifHasValidLength { responseBodySize ->
breadcrumb.setData("response_body_size", responseBodySize)
}
hint[OKHTTP_RESPONSE] = it
}
hub.addBreadcrumb(breadcrumb, hint)
}
}
private fun finishSpan(span: ISpan?, request: Request, response: Response?) {
if (span != null) {
if (beforeSpan != null) {
val result = beforeSpan.execute(span, request, response)
if (result == null) {
// span is dropped
span.spanContext.sampled = false
} else {
span.finish()
}
} else {
span.finish()
}
}
}
private fun Long?.ifHasValidLength(fn: (Long) -> Unit) {
if (this != null && this != -1L) {
fn.invoke(this)
}
}
private fun captureEvent(request: Request, response: Response) {
// return if the feature is disabled or its not within the range
if (!captureFailedRequests || !containsStatusCode(response.code)) {
return
}
// not possible to get a parameterized url, but we remove at least the
// query string and the fragment.
// url example: https://api.github.com/users/getsentry/repos/#fragment?query=query
// url will be: https://api.github.com/users/getsentry/repos/
// ideally we'd like a parameterized url: https://api.github.com/users/{user}/repos/
// but that's not possible
var requestUrl = request.url.toString()
val query = request.url.query
if (!query.isNullOrEmpty()) {
requestUrl = requestUrl.replace("?$query", "")
}
val urlFragment = request.url.fragment
if (!urlFragment.isNullOrEmpty()) {
requestUrl = requestUrl.replace("#$urlFragment", "")
}
// return if its not a target match
if (!PropagationTargetsUtils.contain(failedRequestTargets, requestUrl)) {
return
}
val mechanism = Mechanism().apply {
type = "SentryOkHttpInterceptor"
}
val exception = SentryHttpClientException(
"HTTP Client Error with status code: ${response.code}"
)
val mechanismException = ExceptionMechanismException(mechanism, exception, Thread.currentThread(), true)
val event = SentryEvent(mechanismException)
val hint = Hint()
hint.set(OKHTTP_REQUEST, request)
hint.set(OKHTTP_RESPONSE, response)
val sentryRequest = io.sentry.protocol.Request().apply {
url = requestUrl
// Cookie is only sent if isSendDefaultPii is enabled
cookies = if (hub.options.isSendDefaultPii) request.headers["Cookie"] else null
method = request.method
queryString = query
headers = getHeaders(request.headers)
fragment = urlFragment
request.body?.contentLength().ifHasValidLength {
bodySize = it
}
}
val sentryResponse = io.sentry.protocol.Response().apply {
// Set-Cookie is only sent if isSendDefaultPii is enabled due to PII
cookies = if (hub.options.isSendDefaultPii) response.headers["Set-Cookie"] else null
headers = getHeaders(response.headers)
statusCode = response.code
response.body?.contentLength().ifHasValidLength {
bodySize = it
}
}
event.request = sentryRequest
event.contexts.setResponse(sentryResponse)
hub.captureEvent(event, hint)
}
private fun containsStatusCode(statusCode: Int): Boolean {
for (item in failedRequestStatusCodes) {
if (item.isInRange(statusCode)) {
return true
}
}
return false
}
private fun getHeaders(requestHeaders: Headers): MutableMap<String, String>? {
// Headers are only sent if isSendDefaultPii is enabled due to PII
if (!hub.options.isSendDefaultPii) {
return null
}
val headers = mutableMapOf<String, String>()
for (i in 0 until requestHeaders.size) {
val name = requestHeaders.name(i)
// header is only sent if isn't sensitive
if (HttpUtils.containsSensitiveHeader(name)) {
continue
}
val value = requestHeaders.value(i)
headers[name] = value
}
return headers
}
/**
* 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?
}
}