Logging setup using slf4j (#36)

* logging setup using slf4j and log4j

* log related http request and response details

* move the logger creation default behavior to logger less constructor overload

Author: NRHelmi

rai-sdk-examples/src/main/java/com/relationalai/examples/Runner.java

@@ -37,7 +37,7 @@ public static void main(String[] args) {
             cmd.run(cmdArgs);
         } catch (Exception e) {
             // error trying to run example
-            System.err.println(e.toString());
+            e.printStackTrace();
         }
         System.exit(0);
     }

rai-sdk/pom.xml

@@ -59,7 +59,13 @@
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
-            <version>1.7.36</version>
+            <version>2.0.6</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-reload4j</artifactId>
+            <version>2.0.6</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.google.protobuf</groupId>

rai-sdk/src/main/java/com/relationalai/Client.java

@@ -23,6 +23,8 @@
 import org.apache.arrow.vector.VectorSchemaRoot;
 import org.apache.arrow.vector.ipc.ArrowStreamReader;
 import org.awaitility.Awaitility;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import relationalai.protocol.Message;
 
 import java.io.*;
@@ -62,6 +64,8 @@ public class Client {
         defaultHeaders.put("User-Agent", userAgent());
     }
 
+    private Logger logger;
+
     public Client() {}
 
     // Note, creating a client from config will also enable the default access
@@ -70,6 +74,10 @@ public Client() {}
     // alternate implementation of AccessTokenHandler handler, or it can be
     // disabled by caling setAccessTokenHandler(null).
     public Client(Config cfg) {
+        this(cfg, LoggerFactory.getLogger("rai"));
+    }
+
+    public Client(Config cfg, Logger logger) {
         if (cfg.region != null)
             this.region = cfg.region;
         if (cfg.scheme != null)
@@ -81,9 +89,10 @@ public Client(Config cfg) {
         this.httpClient = HttpClient.newBuilder().build();
         this.credentials = cfg.credentials;
         this.setAccessTokenHandler(new DefaultAccessTokenHandler());
+        this.logger = logger;
     }
 
-    // Returns the current `HttpClient` instance, creating one if necessarry.
+    // Returns the current `HttpClient` instance, creating one if necessary.
     public HttpClient getHttpClient() {
         return this.httpClient;
     }
@@ -267,10 +276,16 @@ Object sendRequest(HttpRequest.Builder builder, Map<String, String> extraHeaders
         HttpResponse<byte[]> response =
                 getHttpClient().send(request, HttpResponse.BodyHandlers.ofByteArray());
 
-        int statusCode = response.statusCode();
-        String contentType = response.headers().firstValue("Content-Type").orElse("");
+        var statusCode = response.statusCode();
+        var contentType = response.headers().firstValue("Content-Type").orElse("");
+        var requestId = response.headers().firstValue("X-Request-ID").orElse("");
+        var userAgent = response.request().headers().firstValue("User-Agent").orElse("");
+        logger.debug("{} {} {} {} {} {} {}",
+                response.request().method(),
+                response.version(), response.request().headers().firstValue("Content-Type").orElse(""),
+                response.request().uri(), statusCode, userAgent, requestId);
+
         if (statusCode >= 400) {
-            var requestId = response.headers().firstValue("x-request-id").orElse("");
             throw new HttpError(
                     statusCode,
                     String.format("(request_id: %s) %s", requestId, new String(response.body(), StandardCharsets.UTF_8))
@@ -586,6 +601,7 @@ public Engine[] listEngines(String state)
 
     public OAuthClientExtra createOAuthClient(String name)
             throws HttpError, InterruptedException, IOException {
+        logger.info("createOAuthClient {}", name);
         return createOAuthClient(name, null);
     }
 
@@ -739,7 +755,7 @@ public TransactionAsyncResult execute(
             String database, String engine,
             String source, boolean readonly,
             Map<String, String> inputs) throws HttpError, IOException, InterruptedException {
-
+        logger.info("execute: database {}, engine {}, readonly {}", database, engine, readonly);
         var id = executeAsync(database, engine, source, readonly, inputs).transaction.id;
 
         Awaitility.await()

rai-sdk/src/test/resources/log4j.properties

@@ -0,0 +1,5 @@
+log4j.rootLogger=DEBUG, stdout
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+log4j.appender.stdout.Target=System.out
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%d{ISO8601} %p : %m%n