From 7722d3f3e44b8b17fcc9df0656841877e8719511 Mon Sep 17 00:00:00 2001
From: "Nathan J. Mehl" <n@oden.io>
Date: Mon, 17 Oct 2022 13:08:41 -0400
Subject: [PATCH] Use logback for logging

- add logback jars to all components
- pin slf4j version to what's bundled w/ logback-classic
---
 README.md                                     |  8 +++
 clickhouse-cli-client/pom.xml                 | 46 ++++++++++++++++
 clickhouse-client/pom.xml                     | 43 ++++++++++++++-
 clickhouse-grpc-client/pom.xml                | 46 ++++++++++++++++
 clickhouse-http-client/pom.xml                | 46 ++++++++++++++++
 clickhouse-jdbc/pom.xml                       | 45 +++++++++++++++
 .../src/main/resources/logback.xml            | 32 +++++++++++
 pom.xml                                       | 55 +++++++++++++++----
 8 files changed, 309 insertions(+), 12 deletions(-)
 create mode 100644 clickhouse-jdbc/src/main/resources/logback.xml

diff --git a/README.md b/README.md
index 39cb5f2f1..34720864d 100644
--- a/README.md
+++ b/README.md
@@ -177,6 +177,14 @@ Use `mvn -DskipITs clean verify` to compile and generate packages if you're usin
 </toolchains>
 ```
 
+## Logging
+
+  You can customize logging configuration in `logback.xml` for each component, e.g. [clickhouse-jdbc/src/main/resources/logback.xml](clickhouse-jdbc/src/main/resources/logback.xml). See the [logback documentation](https://logback.qos.ch/manual/configuration.html) for details about the contents of this file.
+
+  Note that the default logging level is `trace` -- you may wish to set this to `info` or `warning` for less verbose logs in production.
+
+  Note also that the default logging format is the default plaintext format suggested by logback. We also provide (by way of example) a structured log appender named `JSON_STDOUT`; to use it you will need to change the `appender-ref` property of the root logger to point to it.
+
 ## Testing
 
 By default, [docker](https://docs.docker.com/engine/install/) is required to run integration test. Docker image(defaults to `clickhouse/clickhouse-server`) will be pulled from Internet, and containers will be created automatically by [testcontainers](https://www.testcontainers.org/) before testing. To test against specific version of ClickHouse, you can pass parameter like `-DclickhouseVersion=22.3` to Maven.
diff --git a/clickhouse-cli-client/pom.xml b/clickhouse-cli-client/pom.xml
index 68ccff155..09e6ae92b 100644
--- a/clickhouse-cli-client/pom.xml
+++ b/clickhouse-cli-client/pom.xml
@@ -14,6 +14,15 @@
     <description>Wrapper of ClickHouse native command-line client</description>
     <url>https://github.com/ClickHouse/clickhouse-jdbc/tree/master/clickhouse-cli-client</url>
 
+    <properties>
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
@@ -32,6 +41,43 @@
             <scope>provided</scope>
         </dependency>
 
+        <!-- Logging -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-json-classic</artifactId>
+            <version>${logback-json.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-jackson</artifactId>
+            <version>${logback-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
             <artifactId>clickhouse-client</artifactId>
diff --git a/clickhouse-client/pom.xml b/clickhouse-client/pom.xml
index f41e148d8..6cd52eb18 100644
--- a/clickhouse-client/pom.xml
+++ b/clickhouse-client/pom.xml
@@ -14,6 +14,15 @@
     <description>Unified Java client for ClickHouse</description>
     <url>https://github.com/ClickHouse/clickhouse-jdbc/tree/master/clickhouse-client</url>
 
+    <properties>
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
@@ -47,10 +56,42 @@
             <artifactId>lz4-java</artifactId>
             <scope>provided</scope>
         </dependency>
+
+        <!-- Logging -->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
-            <scope>provided</scope>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-json-classic</artifactId>
+            <version>${logback-json.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-jackson</artifactId>
+            <version>${logback-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind.version}</version>
         </dependency>
 
         <dependency>
diff --git a/clickhouse-grpc-client/pom.xml b/clickhouse-grpc-client/pom.xml
index 66279ffb2..8950320c7 100644
--- a/clickhouse-grpc-client/pom.xml
+++ b/clickhouse-grpc-client/pom.xml
@@ -14,6 +14,15 @@
     <description>gRPC client for ClickHouse</description>
     <url>https://github.com/ClickHouse/clickhouse-jdbc/tree/master/clickhouse-grpc-client</url>
 
+    <properties>
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
@@ -55,6 +64,43 @@
             <scope>provided</scope>
         </dependency>
 
+        <!-- Logging -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-json-classic</artifactId>
+            <version>${logback-json.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-jackson</artifactId>
+            <version>${logback-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
             <artifactId>clickhouse-client</artifactId>
diff --git a/clickhouse-http-client/pom.xml b/clickhouse-http-client/pom.xml
index 4edd2ecae..6daf5fcfe 100644
--- a/clickhouse-http-client/pom.xml
+++ b/clickhouse-http-client/pom.xml
@@ -14,6 +14,15 @@
     <description>HTTP client for ClickHouse</description>
     <url>https://github.com/ClickHouse/clickhouse-jdbc/tree/master/clickhouse-http-client</url>
 
+    <properties>
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
@@ -47,6 +56,43 @@
             <scope>provided</scope>
         </dependency>
 
+        <!-- Logging -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-json-classic</artifactId>
+            <version>${logback-json.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-jackson</artifactId>
+            <version>${logback-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
             <artifactId>clickhouse-client</artifactId>
diff --git a/clickhouse-jdbc/pom.xml b/clickhouse-jdbc/pom.xml
index 83deec78e..ba65898ae 100644
--- a/clickhouse-jdbc/pom.xml
+++ b/clickhouse-jdbc/pom.xml
@@ -19,6 +19,13 @@
         <javacc-plugin.version>4.1.4</javacc-plugin.version>
         <spec.title>JDBC</spec.title>
         <spec.version>4.2</spec.version>
+
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
     </properties>
 
     <dependencies>
@@ -85,6 +92,43 @@
             <version>${httpclient.version}</version>
         </dependency>
 
+        <!-- Logging -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-json-classic</artifactId>
+            <version>${logback-json.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>ch.qos.logback.contrib</groupId>
+            <artifactId>logback-jackson</artifactId>
+            <version>${logback-jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson-databind.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>${project.parent.groupId}</groupId>
             <artifactId>clickhouse-client</artifactId>
@@ -107,6 +151,7 @@
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
diff --git a/clickhouse-jdbc/src/main/resources/logback.xml b/clickhouse-jdbc/src/main/resources/logback.xml
new file mode 100644
index 000000000..4b007d568
--- /dev/null
+++ b/clickhouse-jdbc/src/main/resources/logback.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE configuration>
+
+<configuration>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.classic.encoder.PatternLayoutEncoder"/>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.contrib.jackson.JacksonJsonFormatter"/>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.contrib.json.classic.JsonLayout"/>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.core.ConsoleAppender"/>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.core.ConsoleAppender"/>
+    <import class="com.clickhouse.jdbcbridge.internal.qos.logback.core.encoder.LayoutWrappingEncoder"/>
+
+    <appender name="STDOUT" class="ConsoleAppender">
+        <encoder class="PatternLayoutEncoder">
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <appender name="JSON_STDOUT" class="ConsoleAppender">
+        <encoder class="LayoutWrappingEncoder">
+            <layout class="JsonLayout">
+                <appendLineSeparator>true</appendLineSeparator>
+                <timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSX</timestampFormat>
+                <timestampFormatTimezoneId>Etc/UTC</timestampFormatTimezoneId>
+                <jsonFormatter class="JacksonJsonFormatter"/>
+            </layout>
+        </encoder>
+    </appender>
+
+    <root level="trace">
+        <appender-ref ref="STDOUT"/>
+    </root>
+</configuration>
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 2390a6d85..5489adc46 100644
--- a/pom.xml
+++ b/pom.xml
@@ -93,12 +93,18 @@
         <protobuf.version>3.21.4</protobuf.version>
         <lz4.version>1.8.0</lz4.version>
         <roaring-bitmap.version>0.9.31</roaring-bitmap.version>
-        <slf4j.version>2.0.0-beta0</slf4j.version>
         <mockito.version>3.12.4</mockito.version>
         <wiremock.version>2.33.2</wiremock.version>
         <testcontainers.version>1.17.3</testcontainers.version>
         <testng.version>7.5</testng.version>
 
+        <slf4j.version>2.0.1</slf4j.version>
+        <logback.version>1.3.4</logback.version>
+        <logback-jackson.version>0.1.5</logback-jackson.version>
+        <logback-json.version>0.1.5</logback-json.version>
+        <jackson.version>2.13.4</jackson.version>
+        <jackson-databind.version>2.13.4.1</jackson-databind.version>
+
         <mariadb-driver.version>3.0.7</mariadb-driver.version>
         <mysql-driver.version>8.0.30</mysql-driver.version>
         <postgresql-driver.version>42.4.1</postgresql-driver.version>
@@ -247,16 +253,6 @@
                 <artifactId>RoaringBitmap</artifactId>
                 <version>${roaring-bitmap.version}</version>
             </dependency>
-            <dependency>
-                <groupId>org.slf4j</groupId>
-                <artifactId>slf4j-api</artifactId>
-                <version>${slf4j.version}</version>
-            </dependency>
-            <dependency>
-                <groupId>org.slf4j</groupId>
-                <artifactId>slf4j-simple</artifactId>
-                <version>${slf4j.version}</version>
-            </dependency>
             <dependency>
                 <groupId>org.mockito</groupId>
                 <artifactId>mockito-core</artifactId>
@@ -278,6 +274,43 @@
                 <version>${testng.version}</version>
             </dependency>
 
+            <!-- Logging -->
+            <dependency>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-api</artifactId>
+                <version>${slf4j.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-simple</artifactId>
+                <version>${slf4j.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>ch.qos.logback</groupId>
+                <artifactId>logback-classic</artifactId>
+                <version>${logback.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>ch.qos.logback.contrib</groupId>
+                <artifactId>logback-json-classic</artifactId>
+                <version>${logback-json.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>ch.qos.logback.contrib</groupId>
+                <artifactId>logback-jackson</artifactId>
+                <version>${logback-jackson.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>com.fasterxml.jackson.core</groupId>
+                <artifactId>jackson-core</artifactId>
+                <version>${jackson.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>com.fasterxml.jackson.core</groupId>
+                <artifactId>jackson-databind</artifactId>
+                <version>${jackson-databind.version}</version>
+            </dependency>
+
             <dependency>
                 <groupId>org.mariadb.jdbc</groupId>
                 <artifactId>mariadb-java-client</artifactId>