Repository navigation
[docs] What client-v2 and jdbc-v2 log, and a safe logging configuration - #3301
Open
LjungeldTheHelper wants to merge 1 commit into
Open
LjungeldTheHelper wants to merge 1 commit into
LjungeldTheHelper wants to merge 1 commit into
Conversation
…ion (ClickHouse#3295) Adds copy-ready Logback and Log4j 2 configurations that keep the client, the driver and the Apache HttpClient header and wire loggers (unshaded, client-v2 `all` and clickhouse-jdbc-all names) at INFO, and documents the logging contract of client-v2 and jdbc-v2. Corrects the shaded logger prefix of clickhouse-jdbc-all. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation for #3295. It describes the logging behavior introduced by #3300, so merge it after #3300. The
branch is based on
mainand contains only the documentation commit.docs/clickhouse-docs/index.mdx, Logging:values, full URLs and query strings, configuration values, client name and metadata, query IDs, exception
messages), the use of
ERROR/WARN/DEBUG, and metrics, spans, or a packet capture with test credentials fordeeper diagnosis.
logback.xmlandlog4j2.xmlthat keepcom.clickhouseand theApache HttpClient header and wire loggers at
INFO, with the two V2 packages to switch toDEBUGfor a shortdiagnosis and
OFFas the alternative. The configuration covers the unshaded names and both shaded prefixes.com.clickhouse.shaded.isclient-v2with theallclassifier;clickhouse-jdbc-allrelocates tocom.clickhouse.client.internal.and also contains the unshaded names(checked in the published
clickhouse-jdbc-all0.11.0 jar).docs/clickhouse-docs/jdbc.mdx, Troubleshooting → Logging: links to the two sections.No code changes.
Checklist
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only updates to clickhouse-docs; no application code, configuration defaults, or security behavior changes in this PR.
Overview
This PR documents only (no runtime changes) how
client-v2andjdbc-v2handle logging and how to configure SLF4J safely in production.On the Java integrations overview (
index.mdx), it expands the Logging section with a new “What the client and the driver log” page that states what is never emitted (including atTRACE): SQL/parameters/rows/bodies, credentials and headers, URLs/query strings, config, client metadata/query IDs, and exception messages; it also explainsERROR/WARN/DEBUGusage and points to metrics/spans or test packet capture for deeper debugging.It adds “Safe logging configuration” with copy-ready
logback.xmlandlog4j2.xmlthat pincom.clickhouseand Apache HttpClient header/wire loggers toINFO(with notes on short-livedDEBUGforcom.clickhouse.client.api/com.clickhouse.jdbcand usingOFF). The HTTP wire logs blurb is corrected for shaded logger prefixes:com.clickhouse.shaded.*forclient-v2allvscom.clickhouse.client.internal.*forclickhouse-jdbc-all, listing all relevant logger names.The JDBC troubleshooting Logging subsection gains a cross-link to those two anchors so driver users see the same privacy guarantees and sample configs.
Reviewed by Cursor Bugbot for commit e658d62. Bugbot is set up for automated code reviews on this repo. Configure here.