feat(client): improve logging

Logging is now:
1. Streaming
4. Configurable in-memory
5. Generally more robust
6. Usable with any underlying http client

Author: stainless-app[bot]

README.md

@@ -339,8 +339,6 @@ while (true) {
 
 ## Logging
 
-The SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).
-
 Enable logging by setting the `ORB_LOG` environment variable to `info`:
 
 ```sh
@@ -353,6 +351,19 @@ Or to `debug` for more verbose logging:
 export ORB_LOG=debug
 ```
 
+Or configure the client manually using the `logLevel` method:
+
+```java
+import com.withorb.api.client.OrbClient;
+import com.withorb.api.client.okhttp.OrbOkHttpClient;
+import com.withorb.api.core.LogLevel;
+
+OrbClient client = OrbOkHttpClient.builder()
+    .fromEnv()
+    .logLevel(LogLevel.INFO)
+    .build();
+```
+
 ## Webhook Verification
 
 We provide helper methods for verifying that a webhook request came from Orb, and not a malicious third party.

orb-java-client-okhttp/build.gradle.kts

@@ -7,7 +7,6 @@ dependencies {
     api(project(":orb-java-core"))
 
     implementation("com.squareup.okhttp3:okhttp:4.12.0")
-    implementation("com.squareup.okhttp3:logging-interceptor:4.12.0")
 
     testImplementation(kotlin("test"))
     testImplementation("org.assertj:assertj-core:3.27.7")

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OkHttpClient.kt

@@ -35,7 +35,6 @@ import okhttp3.Request
 import okhttp3.RequestBody
 import okhttp3.RequestBody.Companion.toRequestBody
 import okhttp3.Response
-import okhttp3.logging.HttpLoggingInterceptor
 import okio.BufferedSink
 import okio.buffer
 import okio.sink
@@ -93,18 +92,6 @@ internal constructor(@JvmSynthetic internal val okHttpClient: okhttp3.OkHttpClie
     private fun newCall(request: HttpRequest, requestOptions: RequestOptions): Call {
         val clientBuilder = okHttpClient.newBuilder()
 
-        val logLevel =
-            when (System.getenv("ORB_LOG")?.lowercase()) {
-                "info" -> HttpLoggingInterceptor.Level.BASIC
-                "debug" -> HttpLoggingInterceptor.Level.BODY
-                else -> null
-            }
-        if (logLevel != null) {
-            clientBuilder.addNetworkInterceptor(
-                HttpLoggingInterceptor().setLevel(logLevel).apply { redactHeader("Authorization") }
-            )
-        }
-
         requestOptions.timeout?.let {
             clientBuilder
                 .connectTimeout(it.connect())

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClient.kt

@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.json.JsonMapper
 import com.withorb.api.client.OrbClient
 import com.withorb.api.client.OrbClientImpl
 import com.withorb.api.core.ClientOptions
+import com.withorb.api.core.LogLevel
 import com.withorb.api.core.Sleeper
 import com.withorb.api.core.Timeout
 import com.withorb.api.core.http.AsyncStreamResponse
@@ -290,6 +291,15 @@ class OrbOkHttpClient private constructor() {
          */
         fun maxRetries(maxRetries: Int) = apply { clientOptions.maxRetries(maxRetries) }
 
+        /**
+         * The level at which to log request and response information.
+         *
+         * [fromEnv] will set the level from environment variables. See [LogLevel.fromEnv].
+         *
+         * Defaults to [LogLevel.fromEnv].
+         */
+        fun logLevel(logLevel: LogLevel) = apply { clientOptions.logLevel(logLevel) }
+
         fun apiKey(apiKey: String) = apply { clientOptions.apiKey(apiKey) }
 
         fun webhookSecret(webhookSecret: String?) = apply {

orb-java-client-okhttp/src/main/kotlin/com/withorb/api/client/okhttp/OrbOkHttpClientAsync.kt

@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.json.JsonMapper
 import com.withorb.api.client.OrbClientAsync
 import com.withorb.api.client.OrbClientAsyncImpl
 import com.withorb.api.core.ClientOptions
+import com.withorb.api.core.LogLevel
 import com.withorb.api.core.Sleeper
 import com.withorb.api.core.Timeout
 import com.withorb.api.core.http.AsyncStreamResponse
@@ -290,6 +291,15 @@ class OrbOkHttpClientAsync private constructor() {
          */
         fun maxRetries(maxRetries: Int) = apply { clientOptions.maxRetries(maxRetries) }
 
+        /**
+         * The level at which to log request and response information.
+         *
+         * [fromEnv] will set the level from environment variables. See [LogLevel.fromEnv].
+         *
+         * Defaults to [LogLevel.fromEnv].
+         */
+        fun logLevel(logLevel: LogLevel) = apply { clientOptions.logLevel(logLevel) }
+
         fun apiKey(apiKey: String) = apply { clientOptions.apiKey(apiKey) }
 
         fun webhookSecret(webhookSecret: String?) = apply {

orb-java-core/src/main/kotlin/com/withorb/api/core/ClientOptions.kt

@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.json.JsonMapper
 import com.withorb.api.core.http.AsyncStreamResponse
 import com.withorb.api.core.http.Headers
 import com.withorb.api.core.http.HttpClient
+import com.withorb.api.core.http.LoggingHttpClient
 import com.withorb.api.core.http.PhantomReachableClosingHttpClient
 import com.withorb.api.core.http.QueryParams
 import com.withorb.api.core.http.RetryingHttpClient
@@ -110,6 +111,14 @@ private constructor(
      * Defaults to 2.
      */
     @get:JvmName("maxRetries") val maxRetries: Int,
+    /**
+     * The level at which to log request and response information.
+     *
+     * [fromEnv] will set the level from environment variables. See [LogLevel.fromEnv].
+     *
+     * Defaults to [LogLevel.fromEnv].
+     */
+    @get:JvmName("logLevel") val logLevel: LogLevel,
     @get:JvmName("apiKey") val apiKey: String,
     private val webhookSecret: String?,
 ) {
@@ -169,6 +178,7 @@ private constructor(
         private var responseValidation: Boolean = false
         private var timeout: Timeout = Timeout.default()
         private var maxRetries: Int = 2
+        private var logLevel: LogLevel = LogLevel.fromEnv()
         private var apiKey: String? = null
         private var webhookSecret: String? = null
 
@@ -186,6 +196,7 @@ private constructor(
             responseValidation = clientOptions.responseValidation
             timeout = clientOptions.timeout
             maxRetries = clientOptions.maxRetries
+            logLevel = clientOptions.logLevel
             apiKey = clientOptions.apiKey
             webhookSecret = clientOptions.webhookSecret
         }
@@ -311,6 +322,15 @@ private constructor(
          */
         fun maxRetries(maxRetries: Int) = apply { this.maxRetries = maxRetries }
 
+        /**
+         * The level at which to log request and response information.
+         *
+         * [fromEnv] will set the level from environment variables. See [LogLevel.fromEnv].
+         *
+         * Defaults to [LogLevel.fromEnv].
+         */
+        fun logLevel(logLevel: LogLevel) = apply { this.logLevel = logLevel }
+
         fun apiKey(apiKey: String) = apply { this.apiKey = apiKey }
 
         fun webhookSecret(webhookSecret: String?) = apply { this.webhookSecret = webhookSecret }
@@ -415,6 +435,7 @@ private constructor(
          * System properties take precedence over environment variables.
          */
         fun fromEnv() = apply {
+            logLevel(LogLevel.fromEnv())
             (System.getProperty("orb.baseUrl") ?: System.getenv("ORB_BASE_URL"))?.let {
                 baseUrl(it)
             }
@@ -490,7 +511,13 @@ private constructor(
             return ClientOptions(
                 httpClient,
                 RetryingHttpClient.builder()
-                    .httpClient(httpClient)
+                    .httpClient(
+                        LoggingHttpClient.builder()
+                            .httpClient(httpClient)
+                            .clock(clock)
+                            .level(logLevel)
+                            .build()
+                    )
                     .sleeper(sleeper)
                     .clock(clock)
                     .maxRetries(maxRetries)
@@ -507,6 +534,7 @@ private constructor(
                 responseValidation,
                 timeout,
                 maxRetries,
+                logLevel,
                 apiKey,
                 webhookSecret,
             )

orb-java-core/src/main/kotlin/com/withorb/api/core/LogLevel.kt

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless.
+
+package com.withorb.api.core
+
+/** The level at which to log request and response information. */
+enum class LogLevel {
+    /** No logging. */
+    OFF,
+    /** Minimal request and response summary logs. No headers or bodies are logged. */
+    INFO,
+    /** [INFO] logs plus details about request failures. */
+    ERROR,
+    /**
+     * Full request and response logs. Sensitive headers are redacted, but sensitive data in request
+     * and response bodies may still be visible.
+     */
+    DEBUG;
+
+    /** Returns whether this level is at or higher than the given [level]. */
+    fun shouldLog(level: LogLevel): Boolean = ordinal >= level.ordinal
+
+    companion object {
+
+        /** Returns a [LogLevel] based on the `ORB_LOG` environment variable. */
+        fun fromEnv() =
+            when (System.getenv("ORB_LOG")?.lowercase()) {
+                "info" -> INFO
+                "error" -> ERROR
+                "debug" -> DEBUG
+                else -> OFF
+            }
+    }
+}

orb-java-core/src/main/kotlin/com/withorb/api/core/Utils.kt

@@ -6,6 +6,7 @@ import com.withorb.api.core.http.Headers
 import com.withorb.api.errors.OrbInvalidDataException
 import java.util.Collections
 import java.util.SortedMap
+import java.util.SortedSet
 import java.util.concurrent.CompletableFuture
 import java.util.concurrent.locks.Lock
 
@@ -17,6 +18,11 @@ internal fun <T : Any> T?.getOrThrow(name: String): T =
 internal fun <T> List<T>.toImmutable(): List<T> =
     if (isEmpty()) Collections.emptyList() else Collections.unmodifiableList(toList())
 
+@JvmSynthetic
+internal fun <V : Comparable<V>> SortedSet<V>.toImmutable(): SortedSet<V> =
+    if (isEmpty()) Collections.emptySortedSet()
+    else Collections.unmodifiableSortedSet(toSortedSet(comparator() ?: Comparator.naturalOrder()))
+
 @JvmSynthetic
 internal fun <K, V> Map<K, V>.toImmutable(): Map<K, V> =
     if (isEmpty()) immutableEmptyMap() else Collections.unmodifiableMap(toMap())