add sentry-okhttp module

partially resolves #1783
getsentry · Oct 20, 2023 · 7cbfcf1 · 7cbfcf1
1 parent 86f0096
commit 7cbfcf1
Show file tree

Hide file tree

Showing 23 changed files with 979 additions and 671 deletions.
diff --git a/.craft.yml b/.craft.yml
@@ -49,6 +49,7 @@ targets:
       maven:io.sentry:sentry-jdbc:
       maven:io.sentry:sentry-graphql:
       maven:io.sentry:sentry-quartz:
+      maven:io.sentry:sentry-okhttp:
       maven:io.sentry:sentry-android-navigation:
       maven:io.sentry:sentry-compose:
       maven:io.sentry:sentry-compose-android:

diff --git a/.github/ISSUE_TEMPLATE/bug_report_java.yml b/.github/ISSUE_TEMPLATE/bug_report_java.yml
@@ -30,6 +30,7 @@ body:
         - sentry-quartz
         - sentry-openfeign
         - sentry-apache-http-client-5
+        - sentry-okhttp
         - other
     validations:
       required: true

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add `sentry-okhttp` module to support instrumenting OkHttp in non-Android projects
+
 ## 6.32.0
 
 ### Features

diff --git a/README.md b/README.md
@@ -38,17 +38,18 @@ Sentry SDK for Java and Android
 | sentry-kotlin-extensions                | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-kotlin-extensions/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-kotlin-extensions)                               | 14 |
 | sentry-servlet                          | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-servlet/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-servlet)                                                   | |
 | sentry-servlet-jakarta                  | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-servlet-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-servlet-jakarta)                                   | |
-| sentry-spring-boot                      | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot)                           |
+| sentry-spring-boot                      | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot)                                           |
 | sentry-spring-boot-jakarta              | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-jakarta)                           |
 | sentry-spring-boot-starter              | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter)                           |
-| sentry-spring-boot-starter-jakarta      | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter-jakarta)                           |
+| sentry-spring-boot-starter-jakarta      | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-boot-starter-jakarta)           |
 | sentry-spring                           | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring)                                                     |
-| sentry-spring-jakarta                   | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-jakarta)                                                     |
+| sentry-spring-jakarta                   | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-jakarta/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-spring-jakarta)                                     |
 | sentry-logback                          | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-logback/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-logback)                                                   |
 | sentry-log4j2                           | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-log4j2/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-log4j2)                                                     |
 | sentry-bom                              | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-bom/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-bom)                                                           |
 | sentry-graphql                          | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-graphql/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-graphql)                                                   |
 | sentry-quartz                           | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-quartz/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-quartz)                                                     |
+| sentry-okhttp                           | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-okhttp/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-okhttp)                                                     |
 | sentry-openfeign                        | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-openfeign/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-openfeign)                                               |
 | sentry-opentelemetry-agent              | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-opentelemetry-agent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-opentelemetry-agent)                           |
 | sentry-opentelemetry-agentcustomization | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-opentelemetry-agentcustomization/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.sentry/sentry-opentelemetry-agentcustomization) |

diff --git a/buildSrc/src/main/java/Config.kt b/buildSrc/src/main/java/Config.kt
@@ -236,6 +236,7 @@ object Config {
         val SENTRY_SERVLET_SDK_NAME = "$SENTRY_JAVA_SDK_NAME.servlet"
         val SENTRY_SERVLET_JAKARTA_SDK_NAME = "$SENTRY_JAVA_SDK_NAME.servlet.jakarta"
         val SENTRY_COMPOSE_HELPER_SDK_NAME = "$SENTRY_JAVA_SDK_NAME.compose.helper"
+        val SENTRY_OKHTTP_SDK_NAME = "$SENTRY_JAVA_SDK_NAME.okhttp"
         val group = "io.sentry"
         val description = "SDK for sentry.io"
         val versionNameProp = "versionName"

diff --git a/sentry-android-okhttp/api/sentry-android-okhttp.api b/sentry-android-okhttp/api/sentry-android-okhttp.api
@@ -6,8 +6,7 @@ public final class io/sentry/android/okhttp/BuildConfig {
 	public fun <init> ()V
 }
 
-public final class io/sentry/android/okhttp/SentryOkHttpEventListener : okhttp3/EventListener {
-	public static final field Companion Lio/sentry/android/okhttp/SentryOkHttpEventListener$Companion;
+public final class io/sentry/android/okhttp/SentryOkHttpEventListener : io/sentry/okhttp/SentryOkHttpEventListener {
 	public fun <init> ()V
 	public fun <init> (Lio/sentry/IHub;Lkotlin/jvm/functions/Function1;)V
 	public synthetic fun <init> (Lio/sentry/IHub;Lkotlin/jvm/functions/Function1;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -17,47 +16,16 @@ public final class io/sentry/android/okhttp/SentryOkHttpEventListener : okhttp3/
 	public synthetic fun <init> (Lio/sentry/IHub;Lokhttp3/EventListener;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Lokhttp3/EventListener$Factory;)V
 	public fun <init> (Lokhttp3/EventListener;)V
-	public fun cacheConditionalHit (Lokhttp3/Call;Lokhttp3/Response;)V
-	public fun cacheHit (Lokhttp3/Call;Lokhttp3/Response;)V
-	public fun cacheMiss (Lokhttp3/Call;)V
-	public fun callEnd (Lokhttp3/Call;)V
-	public fun callFailed (Lokhttp3/Call;Ljava/io/IOException;)V
-	public fun callStart (Lokhttp3/Call;)V
-	public fun canceled (Lokhttp3/Call;)V
-	public fun connectEnd (Lokhttp3/Call;Ljava/net/InetSocketAddress;Ljava/net/Proxy;Lokhttp3/Protocol;)V
-	public fun connectFailed (Lokhttp3/Call;Ljava/net/InetSocketAddress;Ljava/net/Proxy;Lokhttp3/Protocol;Ljava/io/IOException;)V
-	public fun connectStart (Lokhttp3/Call;Ljava/net/InetSocketAddress;Ljava/net/Proxy;)V
-	public fun connectionAcquired (Lokhttp3/Call;Lokhttp3/Connection;)V
-	public fun connectionReleased (Lokhttp3/Call;Lokhttp3/Connection;)V
-	public fun dnsEnd (Lokhttp3/Call;Ljava/lang/String;Ljava/util/List;)V
-	public fun dnsStart (Lokhttp3/Call;Ljava/lang/String;)V
-	public fun proxySelectEnd (Lokhttp3/Call;Lokhttp3/HttpUrl;Ljava/util/List;)V
-	public fun proxySelectStart (Lokhttp3/Call;Lokhttp3/HttpUrl;)V
-	public fun requestBodyEnd (Lokhttp3/Call;J)V
-	public fun requestBodyStart (Lokhttp3/Call;)V
-	public fun requestFailed (Lokhttp3/Call;Ljava/io/IOException;)V
-	public fun requestHeadersEnd (Lokhttp3/Call;Lokhttp3/Request;)V
-	public fun requestHeadersStart (Lokhttp3/Call;)V
-	public fun responseBodyEnd (Lokhttp3/Call;J)V
-	public fun responseBodyStart (Lokhttp3/Call;)V
-	public fun responseFailed (Lokhttp3/Call;Ljava/io/IOException;)V
-	public fun responseHeadersEnd (Lokhttp3/Call;Lokhttp3/Response;)V
-	public fun responseHeadersStart (Lokhttp3/Call;)V
-	public fun satisfactionFailure (Lokhttp3/Call;Lokhttp3/Response;)V
-	public fun secureConnectEnd (Lokhttp3/Call;Lokhttp3/Handshake;)V
-	public fun secureConnectStart (Lokhttp3/Call;)V
 }
 
-public final class io/sentry/android/okhttp/SentryOkHttpEventListener$Companion {
-}
-
-public final class io/sentry/android/okhttp/SentryOkHttpInterceptor : io/sentry/IntegrationName, okhttp3/Interceptor {
+public final class io/sentry/android/okhttp/SentryOkHttpInterceptor : io/sentry/okhttp/SentryOkHttpInterceptor, io/sentry/IntegrationName, okhttp3/Interceptor {
 	public fun <init> ()V
 	public fun <init> (Lio/sentry/IHub;)V
 	public fun <init> (Lio/sentry/IHub;Lio/sentry/android/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback;ZLjava/util/List;Ljava/util/List;)V
 	public synthetic fun <init> (Lio/sentry/IHub;Lio/sentry/android/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback;ZLjava/util/List;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/sentry/IHub;Lio/sentry/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback;ZLjava/util/List;Ljava/util/List;)V
+	public synthetic fun <init> (Lio/sentry/IHub;Lio/sentry/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback;ZLjava/util/List;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Lio/sentry/android/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback;)V
-	public fun intercept (Lokhttp3/Interceptor$Chain;)Lokhttp3/Response;
 }
 
 public abstract interface class io/sentry/android/okhttp/SentryOkHttpInterceptor$BeforeSpanCallback {

diff --git a/sentry-android-okhttp/build.gradle.kts b/sentry-android-okhttp/build.gradle.kts
@@ -24,9 +24,7 @@ android {
 
     buildTypes {
         getByName("debug")
-        getByName("release") {
-            consumerProguardFiles("proguard-rules.pro")
-        }
+        getByName("release")
     }
 
     kotlinOptions {
@@ -63,6 +61,7 @@ kotlin {
 
 dependencies {
     api(projects.sentry)
+    api(projects.sentryOkhttp)
 
     compileOnly(Config.Libs.okhttp)