-
-
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.
* made SentryOkHttpInterceptor work nicely with SentryOkHttpEventListener * added SentryOkHttpEventListener, with an optional instance of EventListener to propagate calls to * added SentryOkHttpEvent * updated span data to align with https://develop.sentry.dev/sdk/performance/span-data-conventions/
- Loading branch information
1 parent
37cd75a
commit fe90ed9
Showing
10 changed files
with
1,447 additions
and
32 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
137 changes: 137 additions & 0 deletions
137
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,137 @@ | ||
| 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.android.okhttp.SentryOkHttpEventListener.Companion.CONNECTION_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.CONNECT_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.REQUEST_BODY_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.REQUEST_HEADERS_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.RESPONSE_BODY_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.RESPONSE_HEADERS_EVENT | ||
| import io.sentry.android.okhttp.SentryOkHttpEventListener.Companion.SECURE_CONNECT_EVENT | ||
| import io.sentry.util.UrlUtils | ||
| import okhttp3.Request | ||
| import okhttp3.Response | ||
| import java.util.concurrent.ConcurrentHashMap | ||
|
|
||
| private const val PROTOCOL_KEY = "protocol" | ||
| private const val ERROR_MESSAGE_KEY = "error_message" | ||
|
|
||
| internal class SentryOkHttpEvent(private val hub: IHub, private val request: Request) { | ||
| private val eventSpans: MutableMap<String, ISpan> = ConcurrentHashMap() | ||
| private val breadcrumb: Breadcrumb | ||
| internal val callRootSpan: ISpan? | ||
| private var response: Response? = null | ||
|
|
||
| init { | ||
| val urlDetails = UrlUtils.parse(request.url.toString()) | ||
| val url = urlDetails.urlOrFallback | ||
| val host: String = request.url.host | ||
| val encodedPath: String = request.url.encodedPath | ||
| val method: String = request.method | ||
|
|
||
| // We start the call span that will contain all the others | ||
| callRootSpan = hub.span?.startChild("http.client", "$method $url") | ||
|
|
||
| urlDetails.applyToSpan(callRootSpan) | ||
|
|
||
| // We setup a breadcrumb with all meaningful data | ||
| breadcrumb = Breadcrumb.http(url, method) | ||
| breadcrumb.setData("host", host) | ||
| breadcrumb.setData("path", encodedPath) | ||
|
|
||
| // We add the same data to the root call span | ||
| callRootSpan?.setData("url", url) | ||
| callRootSpan?.setData("host", host) | ||
| callRootSpan?.setData("path", encodedPath) | ||
| callRootSpan?.setData("http.method", method) | ||
| } | ||
|
|
||
| /** | ||
| * 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_KEY, response.protocol.name) | ||
| breadcrumb.setData("status_code", response.code) | ||
| callRootSpan?.setData(PROTOCOL_KEY, response.protocol.name) | ||
| callRootSpan?.setData("http.status_code", response.code) | ||
| callRootSpan?.status = SpanStatus.fromHttpStatusCode(response.code) | ||
| } | ||
|
|
||
| fun setProtocol(protocolName: String?) { | ||
| if (protocolName != null) { | ||
| breadcrumb.setData(PROTOCOL_KEY, protocolName) | ||
| callRootSpan?.setData(PROTOCOL_KEY, protocolName) | ||
| } | ||
| } | ||
|
|
||
| fun setRequestBodySize(byteCount: Long) { | ||
| if (byteCount > -1) { | ||
| breadcrumb.setData("request_content_length", byteCount) | ||
| callRootSpan?.setData("http.request_content_length", byteCount) | ||
| } | ||
| } | ||
|
|
||
| fun setResponseBodySize(byteCount: Long) { | ||
| if (byteCount > -1) { | ||
| breadcrumb.setData("response_content_length", byteCount) | ||
| callRootSpan?.setData("http.response_content_length", byteCount) | ||
| } | ||
| } | ||
|
|
||
| /** Sets the [errorMessage] if not null. */ | ||
| fun setError(errorMessage: String?) { | ||
| if (errorMessage != null) { | ||
| breadcrumb.setData(ERROR_MESSAGE_KEY, errorMessage) | ||
| callRootSpan?.setData(ERROR_MESSAGE_KEY, errorMessage) | ||
| } | ||
| } | ||
|
|
||
| /** Starts a span, if the callRootSpan is not null. */ | ||
| fun startSpan(event: String) { | ||
| // Find the parent of the span being created. E.g. secureConnect is child of connect | ||
| val parentSpan = when (event) { | ||
| // PROXY_SELECT, DNS, CONNECT and CONNECTION are not children of one another | ||
| SECURE_CONNECT_EVENT -> eventSpans[CONNECT_EVENT] | ||
| REQUEST_HEADERS_EVENT -> eventSpans[CONNECTION_EVENT] | ||
| REQUEST_BODY_EVENT -> eventSpans[CONNECTION_EVENT] | ||
| RESPONSE_HEADERS_EVENT -> eventSpans[CONNECTION_EVENT] | ||
| RESPONSE_BODY_EVENT -> eventSpans[CONNECTION_EVENT] | ||
| else -> callRootSpan | ||
| } ?: callRootSpan | ||
| val span = parentSpan?.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, request) | ||
| response?.let { hint.set(TypeCheckHint.OKHTTP_RESPONSE, it) } | ||
|
|
||
| hub.addBreadcrumb(breadcrumb, hint) | ||
| return | ||
| } | ||
| } |
Oops, something went wrong.