-
-
Notifications
You must be signed in to change notification settings - Fork 444
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
1,295 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
sentry-android-okhttp/src/main/java/io/sentry/android/okhttp/SentryOkHttpEvent.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| package io.sentry.android.okhttp | ||
|
|
||
| import io.sentry.Breadcrumb | ||
| import io.sentry.Hint | ||
| import io.sentry.IHub | ||
| import io.sentry.ISpan | ||
| import io.sentry.SpanStatus | ||
| import io.sentry.TypeCheckHint | ||
| import io.sentry.util.UrlUtils | ||
| import okhttp3.Call | ||
| import okhttp3.Response | ||
| import java.net.URL | ||
|
|
||
| private val uuidRegex by lazy { Regex("[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}") } | ||
|
|
||
| internal class SentryOkHttpEvent(private val hub: IHub, private val call: Call) { | ||
| private val eventSpans: MutableMap<String, ISpan> = HashMap() | ||
| private val breadcrumb: Breadcrumb | ||
| internal val callRootSpan: ISpan? | ||
| private var response: Response? = null | ||
|
|
||
| init { | ||
| val urlDetails = UrlUtils.parse(call.request().url.toString()) | ||
| val url = urlDetails.urlOrFallback | ||
| val trimmedUrl: String = trimUrl(url) | ||
| val host: String = call.request().url.host | ||
| val encodedPath: String = call.request().url.encodedPath | ||
| val method: String = call.request().method | ||
|
|
||
| // We start the call span that will contain all the others | ||
| callRootSpan = hub.span?.startChild("http.client", "$method $url") | ||
|
|
||
| // We setup a breadcrumb with all meaningful data | ||
| breadcrumb = Breadcrumb.http(url, method) | ||
| breadcrumb.setData("url", url) | ||
| breadcrumb.setData("filtered_url", trimmedUrl) | ||
| breadcrumb.setData("host", host) | ||
| breadcrumb.setData("path", encodedPath) | ||
| breadcrumb.setData("method", method) | ||
| breadcrumb.setData("success", true) | ||
|
|
||
| // We add the same data to the root call span | ||
| callRootSpan?.setData("url", url) | ||
| callRootSpan?.setData("filtered_url", trimmedUrl) | ||
| callRootSpan?.setData("host", host) | ||
| callRootSpan?.setData("path", encodedPath) | ||
| callRootSpan?.setData("method", method) | ||
| callRootSpan?.setData("success", true) | ||
| } | ||
|
|
||
| private fun trimUrl(url: String): String { | ||
| // Remove any uuid from the url and replace it with a "*" | ||
| val trimmedUrl = url.replace(uuidRegex, "*") | ||
| if (URL(trimmedUrl).query == null) { | ||
| return trimmedUrl | ||
| } | ||
| // Remove any parameter from the url | ||
| return trimmedUrl.replace(URL(trimmedUrl).query, "").replace("?", "") | ||
| } | ||
|
|
||
| /** | ||
| * Sets the [Response] that will be sent in the breadcrumb [Hint]. | ||
| * Also, it sets the protocol and status code in the breadcrumb and the call root span. | ||
| */ | ||
| fun setResponse(response: Response) { | ||
| this.response = response | ||
| breadcrumb.setData("protocol", response.protocol.name) | ||
| breadcrumb.setData("status_code", response.code) | ||
| callRootSpan?.setData("protocol", response.protocol.name) | ||
| callRootSpan?.setData("status_code", response.code) | ||
| callRootSpan?.status = SpanStatus.fromHttpStatusCode(response.code) | ||
| } | ||
|
|
||
| fun setProtocol(protocolName: String?) { | ||
| if (protocolName != null) { | ||
| breadcrumb.setData("protocol", protocolName) | ||
| callRootSpan?.setData("protocol", protocolName) | ||
| } | ||
| } | ||
|
|
||
| fun setRequestBodySize(byteCount: Long) { | ||
| if (byteCount > -1) { | ||
| breadcrumb.setData("request_body_size", byteCount) | ||
| callRootSpan?.setData("request_body_size", byteCount) | ||
| } | ||
| } | ||
|
|
||
| fun setResponseBodySize(byteCount: Long) { | ||
| if (byteCount > -1) { | ||
| breadcrumb.setData("response_body_size", byteCount) | ||
| callRootSpan?.setData("response_body_size", byteCount) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the success flag in the breadcrumb and the call root span to false. | ||
| * Also sets the [errorMessage] if not null. | ||
| */ | ||
| fun setError(errorMessage: String?) { | ||
| breadcrumb.setData("success", false) | ||
| callRootSpan?.setData("success", false) | ||
| if (errorMessage != null) { | ||
| breadcrumb.setData("error_message", errorMessage) | ||
| callRootSpan?.setData("error_message", errorMessage) | ||
| } | ||
| } | ||
|
|
||
| /** Starts a span, if the callRootSpan is not null. */ | ||
| fun startSpan(event: String) { | ||
| val span = callRootSpan?.startChild("http.client", event) ?: return | ||
| eventSpans[event] = span | ||
| } | ||
|
|
||
| /** Finishes a previously started span, and runs [beforeFinish] on it and on the call root span. */ | ||
| fun finishSpan(event: String, beforeFinish: ((span: ISpan) -> Unit)? = null) { | ||
| val span = eventSpans[event] ?: return | ||
| beforeFinish?.invoke(span) | ||
| callRootSpan?.let { beforeFinish?.invoke(it) } | ||
| span.finish() | ||
| } | ||
|
|
||
| /** Finishes the call root span, and runs [beforeFinish] on it. Then a breadcrumb is sent. */ | ||
| fun finishEvent(beforeFinish: ((span: ISpan) -> Unit)? = null) { | ||
| callRootSpan ?: return | ||
|
|
||
| // We forcefully finish all spans, even if they should already have been finished through finishSpan() | ||
| eventSpans.values.filter { !it.isFinished }.forEach { it.finish(SpanStatus.DEADLINE_EXCEEDED) } | ||
| beforeFinish?.invoke(callRootSpan) | ||
| callRootSpan.finish() | ||
|
|
||
| // We put data in the hint and send a breadcrumb | ||
| val hint = Hint() | ||
| hint.set(TypeCheckHint.OKHTTP_REQUEST, call.request()) | ||
| response?.let { hint.set(TypeCheckHint.OKHTTP_RESPONSE, it) } | ||
|
|
||
| hub.addBreadcrumb(breadcrumb, hint) | ||
| return | ||
| } | ||
| } |
Oops, something went wrong.