-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat(bqjdbc): Per connection logs - Add BigQueryJdbcMdc #12748
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| drivers/** | ||
| target-it/** | ||
| target-it/** | ||
| *logs/** |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.bigquery.jdbc; | ||
|
|
||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.concurrent.atomic.AtomicLong; | ||
|
|
||
| /** | ||
| * Lightweight MDC implementation for the BigQuery JDBC driver using InheritableThreadLocal. | ||
| * Allocates a dedicated, independent InheritableThreadLocal object per concrete BigQueryConnection | ||
| * instance. | ||
| */ | ||
| public class BigQueryJdbcMdc { | ||
| private static final AtomicLong nextId = new AtomicLong(1); | ||
| private static final ConcurrentHashMap<BigQueryConnection, InheritableThreadLocal<String>> | ||
| instanceLocals = new ConcurrentHashMap<>(); | ||
| private static final ConcurrentHashMap<BigQueryConnection, String> instanceIds = | ||
| new ConcurrentHashMap<>(); | ||
|
|
||
| /** Allocates an exclusive InheritableThreadLocal and registers the connection mapping. */ | ||
| private static final InheritableThreadLocal<String> currentConnectionId = | ||
| new InheritableThreadLocal<>(); | ||
|
|
||
| public static void registerInstance(BigQueryConnection connection, String id) { | ||
| if (connection != null) { | ||
| String cleanId = | ||
| instanceIds.computeIfAbsent( | ||
| connection, | ||
| k -> { | ||
| String digits = (id != null) ? id.replaceAll("[^0-9]", "") : ""; | ||
| String numericPart = | ||
| digits.isEmpty() ? String.valueOf(nextId.getAndIncrement()) : digits; | ||
| return "JdbcConnection-" + numericPart; | ||
| }); | ||
|
|
||
| currentConnectionId.set(cleanId); | ||
| InheritableThreadLocal<String> threadLocal = | ||
| instanceLocals.computeIfAbsent(connection, k -> new InheritableThreadLocal<>()); | ||
Neenu1995 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| threadLocal.set(cleanId); | ||
| } | ||
| } | ||
|
|
||
| /** Retrieves the connection ID mapped to a specific BigQueryConnection instance. */ | ||
| public static String getConnectionId(BigQueryConnection connection) { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why using MDC if
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. But then we don't have a way to track different connection IDs in multiple threads. The MDC here keeps track of different connection instances and it's corresponding connection ID and thread. This is cross verified when a LOG message comes in and redirected to the appropriate log file. |
||
| if (connection != null) { | ||
| InheritableThreadLocal<String> local = instanceLocals.get(connection); | ||
| if (local != null) { | ||
| String val = local.get(); | ||
| if (val != null) { | ||
| return val; | ||
| } | ||
| } | ||
| return instanceIds.get(connection); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the connection ID carried by any registered active connection on the current thread. | ||
| */ | ||
| public static String getConnectionId() { | ||
| return currentConnectionId.get(); | ||
| } | ||
|
|
||
| /** Clears the connection ID context from all active connection contexts on the current thread. */ | ||
| public static void removeInstance(BigQueryConnection connection) { | ||
| if (connection != null) { | ||
| InheritableThreadLocal<String> local = instanceLocals.remove(connection); | ||
| if (local != null) { | ||
| local.remove(); | ||
| } | ||
| instanceIds.remove(connection); | ||
| } | ||
| } | ||
Neenu1995 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| public static void clear() { | ||
| currentConnectionId.remove(); | ||
| for (InheritableThreadLocal<String> local : instanceLocals.values()) { | ||
| local.remove(); | ||
| } | ||
| instanceLocals.clear(); | ||
| instanceIds.clear(); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Copyright 2026 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.bigquery.jdbc; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
|
||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.Mockito; | ||
|
|
||
| public class BigQueryJdbcMdcTest { | ||
|
|
||
| private BigQueryConnection mockConnection1; | ||
| private BigQueryConnection mockConnection2; | ||
|
|
||
| @BeforeEach | ||
| public void setUp() { | ||
| mockConnection1 = Mockito.mock(BigQueryConnection.class); | ||
| mockConnection2 = Mockito.mock(BigQueryConnection.class); | ||
| } | ||
|
|
||
| @AfterEach | ||
| public void tearDown() { | ||
| BigQueryJdbcMdc.clear(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRegisterAndRetrieveConnectionId() { | ||
| BigQueryJdbcMdc.registerInstance(mockConnection1, "123"); | ||
|
|
||
| assertEquals("JdbcConnection-123", BigQueryJdbcMdc.getConnectionId(mockConnection1)); | ||
| assertEquals("JdbcConnection-123", BigQueryJdbcMdc.getConnectionId()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testClearContext() { | ||
| BigQueryJdbcMdc.registerInstance(mockConnection1, "456"); | ||
| assertEquals("JdbcConnection-456", BigQueryJdbcMdc.getConnectionId(mockConnection1)); | ||
|
|
||
| BigQueryJdbcMdc.clear(); | ||
|
|
||
| assertNull(BigQueryJdbcMdc.getConnectionId()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMultipleConnectionsSameThread() { | ||
| BigQueryJdbcMdc.registerInstance(mockConnection1, "111"); | ||
| BigQueryJdbcMdc.registerInstance(mockConnection2, "222"); | ||
|
|
||
| assertEquals("JdbcConnection-111", BigQueryJdbcMdc.getConnectionId(mockConnection1)); | ||
| assertEquals("JdbcConnection-222", BigQueryJdbcMdc.getConnectionId(mockConnection2)); | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.