Skip to content

Add in_use metrics for sql connection pool #1570

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

Merged
merged 1 commit into from
Nov 13, 2025
Merged

Add in_use metrics for sql connection pool #1570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 33 additions & 6 deletions vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/pool/SqlConnectionPool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,24 @@

import io.netty.channel.EventLoop;
import io.vertx.core.*;
import io.vertx.core.internal.ContextInternal;
import io.vertx.core.internal.PromiseInternal;
import io.vertx.core.internal.VertxInternal;
import io.vertx.core.internal.net.NetSocketInternal;
import io.vertx.core.internal.pool.*;
import io.vertx.core.net.SocketAddress;
import io.vertx.core.spi.metrics.ClientMetrics;
import io.vertx.core.spi.metrics.PoolMetrics;
import io.vertx.core.spi.tracing.VertxTracer;
import io.vertx.core.tracing.TracingPolicy;
import io.vertx.core.internal.pool.*;
import io.vertx.core.internal.ContextInternal;
import io.vertx.core.internal.VertxInternal;
import io.vertx.sqlclient.SqlConnectOptions;
import io.vertx.sqlclient.impl.tracing.QueryReporter;
import io.vertx.sqlclient.spi.DatabaseMetadata;
import io.vertx.sqlclient.spi.connection.Connection;
import io.vertx.sqlclient.spi.connection.ConnectionContext;
import io.vertx.sqlclient.spi.connection.ConnectionFactory;
import io.vertx.sqlclient.spi.protocol.CommandBase;
import io.vertx.sqlclient.spi.protocol.QueryCommandBase;
import io.vertx.sqlclient.impl.tracing.QueryReporter;
import io.vertx.sqlclient.spi.connection.ConnectionFactory;
import io.vertx.sqlclient.spi.DatabaseMetadata;

import java.util.List;
import java.util.function.Function;
Expand Down Expand Up @@ -184,6 +184,27 @@ private void dequeueMetric(Object metric) {
}
}

private Object beginMetric() {
if (metrics != null) {
try {
return metrics.begin();
} catch (Exception e) {
//
}
}
return NO_METRICS;
}

private void endMetric(Object metric) {
if (metrics != null && metric != NO_METRICS) {
try {
metrics.end(metric);
} catch (Exception e) {
//
}
}
}

// TODO : try optimize without promise
public <R> void execute(CommandBase<R> cmd, Completable<R> handler) {
ContextInternal context = vertx.getOrCreateContext();
Expand All @@ -193,7 +214,9 @@ public <R> void execute(CommandBase<R> cmd, Completable<R> handler) {
p.future().compose(lease -> {
dequeueMetric(metric);
PooledConnection pooled = lease.get();
pooled.timerMetric = beginMetric();
Connection conn = pooled.conn;

Future<R> future;
if (afterAcquire != null) {
future = afterAcquire.apply(conn)
Expand All @@ -205,6 +228,7 @@ public <R> void execute(CommandBase<R> cmd, Completable<R> handler) {
future = pp;
}
return future.andThen(ar -> {
endMetric(pooled.timerMetric);
pooled.refresh();
lease.recycle();
});
Expand Down Expand Up @@ -247,6 +271,7 @@ public void complete(Lease<PooledConnection> lease, Throwable failure) {
private void handle(Lease<PooledConnection> lease) {
dequeueMetric(metric);
PooledConnection pooled = lease.get();
pooled.timerMetric = beginMetric();
pooled.lease = lease;
handler.succeed(pooled);
}
Expand Down Expand Up @@ -306,6 +331,7 @@ public class PooledConnection implements Connection, ConnectionContext {
private ConnectionContext holder;
private Promise<ConnectResult<PooledConnection>> poolCallback;
private Lease<PooledConnection> lease;
private Object timerMetric;
public long idleEvictionTimestamp;
public long lifetimeEvictionTimestamp;

Expand Down Expand Up @@ -446,6 +472,7 @@ private void doClose(ConnectionContext holder, Completable<Void> promise) {
}

private void cleanup(Completable<Void> promise) {
endMetric(timerMetric);
Lease<PooledConnection> l = this.lease;
this.lease = null;
refresh();
Expand Down
29 changes: 25 additions & 4 deletions vertx-sql-client/src/test/java/io/vertx/tests/sqlclient/tck/MetricsTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public void close() {
pool.query("SELECT * FROM immutable WHERE id=1").execute().toCompletionStage().toCompletableFuture().get(20, TimeUnit.SECONDS);
ctx.assertEquals(0, closeCount.get());
pool.close();
awaitQueueSize(ctx, closeCount, 1);
awaitUntilSizeEquals(ctx, closeCount, 1);
}

@Test
Expand All @@ -131,6 +131,9 @@ private void testQueuing(TestContext ctx, boolean timeout) throws Exception {
AtomicInteger queueSize = new AtomicInteger();
List<Object> enqueueMetrics = Collections.synchronizedList(new ArrayList<>());
List<Object> dequeueMetrics = Collections.synchronizedList(new ArrayList<>());
AtomicInteger usageSize = new AtomicInteger();
List<Object> beginMetrics = Collections.synchronizedList(new ArrayList<>());
List<Object> endMetrics = Collections.synchronizedList(new ArrayList<>());
poolMetrics = new PoolMetrics() {
@Override
public Object enqueue() {
Expand All @@ -144,6 +147,20 @@ public void dequeue(Object taskMetric) {
dequeueMetrics.add(taskMetric);
queueSize.decrementAndGet();
}

@Override
public Object begin() {
Object metric = new Object();
beginMetrics.add(metric);
usageSize.incrementAndGet();
return metric;
}

@Override
public void end(Object usageMetric) {
endMetrics.add(usageMetric);
usageSize.decrementAndGet();
}
};
PoolOptions poolOptions = new PoolOptions().setMaxSize(1).setName("the-pool");
if (timeout) {
Expand All @@ -156,16 +173,20 @@ public void dequeue(Object taskMetric) {
for (int i = 0;i < num;i++) {
futures.add(pool.withConnection(sqlConn -> sqlConn.query("SELECT * FROM immutable WHERE id=1").execute()));
}
awaitQueueSize(ctx, queueSize, timeout ? 0 : num);
awaitUntilSizeEquals(ctx, queueSize, timeout ? 0 : num);
conn.close();
Future.join(futures).otherwiseEmpty().await(20, SECONDS);
ctx.assertEquals(0, queueSize.get());
ctx.assertEquals(enqueueMetrics, dequeueMetrics);
awaitUntilSizeEquals(ctx, usageSize, 0);
ctx.assertEquals(timeout ? 1 : num + 1, beginMetrics.size());
ctx.assertEquals(timeout ? 1 : num + 1, endMetrics.size());
ctx.assertEquals(beginMetrics, endMetrics);
ctx.assertEquals("sql", poolType);
ctx.assertEquals("the-pool", poolName);
}

private void awaitQueueSize(TestContext ctx, AtomicInteger queueSize, int num) throws InterruptedException {
private void awaitUntilSizeEquals(TestContext ctx, AtomicInteger queueSize, int num) throws InterruptedException {
long now = System.currentTimeMillis();
for (; ; ) {
if (queueSize.get() != num) {
Expand Down Expand Up @@ -227,7 +248,7 @@ public void dequeue(Object taskMetric) {
.onComplete(ctx.asyncAssertFailure(t -> async.countDown()));
}
conn.closeHandler(v -> async.countDown());
awaitQueueSize(ctx, queueSize, 16);
awaitUntilSizeEquals(ctx, queueSize, 16);
firstConnection.get().clientSocket().close();
async.await(20_000);
ctx.assertEquals(0, queueSize.get());
Expand Down