Repository navigation
fix(client-v2): record connection times only when metrics are enabled #3309
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
Open
pcbeingused333
wants to merge
1
commit into
ClickHouse:main
Choose a base branch
from
pcbeingused333:c1692-times-queue
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+53
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
38 changes: 38 additions & 0 deletions
38
client-v2/src/test/java/com/clickhouse/client/api/internal/MeteredConnectionFactoryTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| package com.clickhouse.client.api.internal; | ||
|
|
||
| import org.apache.hc.core5.http.config.CharCodingConfig; | ||
| import org.apache.hc.core5.http.config.Http1Config; | ||
| import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParserFactory; | ||
| import org.testng.Assert; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import java.net.Socket; | ||
|
|
||
| public class MeteredConnectionFactoryTest { | ||
|
|
||
| private static HttpAPIClientHelper.MeteredManagedHttpClientConnectionFactory newFactory() { | ||
| return new HttpAPIClientHelper.MeteredManagedHttpClientConnectionFactory( | ||
| Http1Config.DEFAULT, CharCodingConfig.DEFAULT, DefaultHttpResponseParserFactory.INSTANCE); | ||
| } | ||
|
|
||
| @Test(groups = {"unit"}) | ||
| public void testConnectionTimesNotRecordedWithoutMetrics() throws Exception { | ||
| HttpAPIClientHelper.MeteredManagedHttpClientConnectionFactory factory = newFactory(); | ||
| for (int i = 0; i < 10; i++) { | ||
| factory.createConnection(new Socket()); | ||
| } | ||
| Assert.assertEquals(factory.times.size(), 0, "Connection times must not accumulate when metrics are disabled"); | ||
| } | ||
|
|
||
| @Test(groups = {"unit"}) | ||
| public void testConnectionTimesRecordedAndDrainedWithMetrics() throws Exception { | ||
| HttpAPIClientHelper.MeteredManagedHttpClientConnectionFactory factory = newFactory(); | ||
| factory.enableMetrics(); | ||
| for (int i = 0; i < 10; i++) { | ||
| factory.createConnection(new Socket()); | ||
| } | ||
| Assert.assertEquals(factory.times.size(), 10); | ||
| factory.getTime(); | ||
| Assert.assertEquals(factory.times.size(), 0); | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| - **[client-v2]** Fixed a memory leak where every new pooled HTTP connection added one entry to an internal queue of | ||
| connection times that was only drained by the metrics gauge. Without a metrics registry the queue was never emptied | ||
| and grew for the lifetime of the client. Connection times are now recorded only when metrics are enabled. `jdbc-v2` | ||
| is affected as well because it uses `client-v2`. (https://github.com/ClickHouse/clickhouse-java/issues/3253) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Metrics stay enabled after bind failure
Medium Severity
enableMetrics()runs before the Micrometer binders and is not turned off when registration fails. The client then keeps enqueueing connection times with no gauge callinggetTime(), so the unboundedtimesqueue this change addresses can still grow for the lifetime of theClient.Additional Locations (1)
client-v2/src/main/java/com/clickhouse/client/api/internal/HttpAPIClientHelper.java#L1387-L1403Reviewed by Cursor Bugbot for commit 32c65d7. Configure here.