Skip to content

Use logback for logging #1110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Use logback for logging #1110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50a8fe0
Merge pull request #1056 from ClickHouse/develop
zhicwu Aug 29, 2022
42b1b21
Merge pull request #1058 from ClickHouse/develop
zhicwu Aug 30, 2022
7722d3f
Use logback for logging
n-oden Oct 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
46 changes: 46 additions & 0 deletions clickhouse-cli-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down
43 changes: 42 additions & 1 deletion clickhouse-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
46 changes: 46 additions & 0 deletions clickhouse-grpc-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
46 changes: 46 additions & 0 deletions clickhouse-http-client/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
45 changes: 45 additions & 0 deletions clickhouse-jdbc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -107,6 +151,7 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>${slf4j.version}</version>
<scope>test</scope>
</dependency>
<dependency>
Expand Down
32 changes: 32 additions & 0 deletions clickhouse-jdbc/src/main/resources/logback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
Loading