github/ebean
4
0
Fork 0
mirror of https://github.com/ebean-orm/ebean.git synced 2024-04-21 10:51:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor move background Query plan collection into CQueryPlanManager

Browse Source
This commit is contained in:
Rob Bygrave
2024-04-12 22:18:58 +12:00
parent 89a294414e
commit eaccc47f2f
9 changed files with 75 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ebean-api/src/main/java/io/ebean/meta/QueryPlanRequest.java
+14 -24
View File
@@ -3,13 +3,24 @@ package io.ebean.meta;
/**
* Request used to capture query plans.
*/
public class QueryPlanRequest {
public final class QueryPlanRequest {
private long since;
private int maxCount;
private final int maxCount;
private long maxTimeMillis;
private final long maxTimeMillis;
/**
* Create with the max number of plans and max capture time.
*
* @param maxCount The maximum number of plans to capture
* @param maxTimeMillis The maximum time after which we stop capturing more plans
*/
public QueryPlanRequest(int maxCount, long maxTimeMillis) {
this.maxCount = maxCount;
this.maxTimeMillis = maxTimeMillis;
}
/**
* Return the epoch time in millis for minimum bind capture time.
@@ -39,16 +50,6 @@ public class QueryPlanRequest {
return maxCount;
}
/**
* Set the maximum number of plans to capture.
* <p>
* Use this to limit how much query plan capturing is done as query
* plan capture is actual database load.
*/
public void maxCount(int maxCount) {
this.maxCount = maxCount;
}
/**
* Return the maximum amount of time we want to use to capture plans.
* <p>
@@ -57,15 +58,4 @@ public class QueryPlanRequest {
public long maxTimeMillis() {
return maxTimeMillis;
}
/**
* Set the maximum amount of time we want to use to capture plans.
* <p>
* Query plan collection will stop once this time is exceeded. We use
* this to ensure the query plan capture does not use excessive amount
* of time - put too much load on the database.
*/
public void maxTimeMillis(long maxTimeMillis) {
this.maxTimeMillis = maxTimeMillis;
}
}
ebean-core/src/main/java/io/ebeaninternal/api/NoopQueryPlanManager.java
+5
View File
@@ -8,6 +8,11 @@ import java.util.List;
final class NoopQueryPlanManager implements QueryPlanManager {
@Override
public void startPlanCapture() {
// do nothing
}
@Override
public void setDefaultThreshold(long thresholdMicros) {
// do nothing
ebean-core/src/main/java/io/ebeaninternal/api/QueryPlanManager.java
+5
View File
@@ -12,6 +12,11 @@ public interface QueryPlanManager {
QueryPlanManager NOOP = new NoopQueryPlanManager();
/**
* Start background capture of query plans if enabled.
*/
void startPlanCapture();
/**
* Update the global default threshold used when new query plans are created.
*/
ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultMetaInfoManager.java
+6 -3
View File
@@ -1,6 +1,7 @@
package io.ebeaninternal.server.core;
import io.ebean.meta.*;
import io.ebeaninternal.api.QueryPlanManager;
import java.util.List;
import java.util.function.Function;
@@ -11,11 +12,13 @@ import java.util.function.Function;
final class DefaultMetaInfoManager implements MetaInfoManager {
private final DefaultServer server;
private final QueryPlanManager queryPlanManager;
private final Function<String, String> naming;
DefaultMetaInfoManager(DefaultServer server, Function<String, String> naming) {
DefaultMetaInfoManager(DefaultServer server, QueryPlanManager queryPlanManager) {
this.server = server;
this.naming = naming;
this.naming = server.config().getMetricNaming();
this.queryPlanManager = queryPlanManager;
}
@Override
@@ -25,7 +28,7 @@ final class DefaultMetaInfoManager implements MetaInfoManager {
@Override
public List<MetaQueryPlan> queryPlanCollectNow(QueryPlanRequest request) {
return server.queryPlanCollectNow(request);
return queryPlanManager.collect(request);
}
@Override
ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java
+4 -29
View File
@@ -56,7 +56,6 @@ import java.sql.Statement;
import java.time.Clock;
import java.util.*;
import java.util.concurrent.Callable;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Consumer;
import java.util.function.Function;
@@ -105,7 +104,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
private final EncryptKeyManager encryptKeyManager;
private final SpiJsonContext jsonContext;
private final DocumentStore documentStore;
private final MetaInfoManager metaInfoManager;
private final DefaultMetaInfoManager metaInfoManager;
private final CurrentTenantProvider currentTenantProvider;
private final SpiLogManager logManager;
private final PersistenceContextScope defaultPersistenceContextScope;
@@ -156,8 +155,8 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
DocStoreIntegration docStoreComponents = config.createDocStoreIntegration(this);
this.transactionManager = config.createTransactionManager(this, docStoreComponents.updateProcessor());
this.documentStore = docStoreComponents.documentStore();
this.queryPlanManager = config.initQueryPlanManager(transactionManager);
this.metaInfoManager = new DefaultMetaInfoManager(this, this.config.getMetricNaming());
this.queryPlanManager = config.initQueryPlanManager(this, transactionManager);
this.metaInfoManager = new DefaultMetaInfoManager(this, queryPlanManager);
this.serverPlugins = config.getPlugins();
this.ddlGenerator = config.initDdlGenerator(this);
this.scriptRunner = new DScriptRunner(this);
@@ -326,31 +325,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer {
migrationRunner.loadProperties(config.getProperties());
migrationRunner.run(config.getDataSource());
}
startQueryPlanCapture();
}
private void startQueryPlanCapture() {
if (config.isQueryPlanCapture()) {
long secs = config.getQueryPlanCapturePeriodSecs();
if (secs > 10) {
log.log(INFO, "capture query plan enabled, every {0}secs", secs);
backgroundExecutor.scheduleWithFixedDelay(this::collectQueryPlans, secs, secs, TimeUnit.SECONDS);
}
}
}
private void collectQueryPlans() {
QueryPlanRequest request = new QueryPlanRequest();
request.maxCount(config.getQueryPlanCaptureMaxCount());
request.maxTimeMillis(config.getQueryPlanCaptureMaxTimeMillis());
// obtains query explain plans ...
List<MetaQueryPlan> plans = metaInfoManager.queryPlanCollectNow(request);
QueryPlanListener listener = config.getQueryPlanListener();
if (listener == null) {
listener = DefaultQueryPlanListener.INSTANT;
}
listener.process(new QueryPlanCapture(this, plans));
queryPlanManager.startPlanCapture();
}
@Override
ebean-core/src/main/java/io/ebeaninternal/server/core/InternalConfiguration.java
+2 -2
View File
@@ -575,12 +575,12 @@ public final class InternalConfiguration {
return new DefaultServerCacheManager(builder);
}
public QueryPlanManager initQueryPlanManager(TransactionManager transactionManager) {
public QueryPlanManager initQueryPlanManager(DefaultServer server, TransactionManager transactionManager) {
if (!config.isQueryPlanEnable()) {
return QueryPlanManager.NOOP;
}
long threshold = config.getQueryPlanThresholdMicros();
return new CQueryPlanManager(transactionManager, threshold, queryPlanLogger(databasePlatform.platform()), extraMetrics);
return new CQueryPlanManager(server, transactionManager, threshold, queryPlanLogger(databasePlatform.platform()), extraMetrics);
}
/**
ebean-core/src/main/java/io/ebeaninternal/server/query/CQueryPlanManager.java
+35 -6
View File
@@ -1,22 +1,27 @@
package io.ebeaninternal.server.query;
import io.ebean.config.QueryPlanCapture;
import io.ebean.config.QueryPlanListener;
import io.ebean.meta.MetaQueryPlan;
import io.ebean.meta.QueryPlanRequest;
import io.ebean.metric.TimedMetric;
import io.ebeaninternal.api.*;
import io.ebeaninternal.server.core.DefaultServer;
import io.ebeaninternal.server.transaction.TransactionManager;
import io.ebeaninternal.server.bind.capture.BindCapture;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.*;
import static java.lang.System.Logger.Level.ERROR;
import static java.lang.System.Logger.Level.INFO;
import static java.util.Collections.emptyList;
public final class CQueryPlanManager implements QueryPlanManager {
private static final System.Logger log = CoreLog.internal;
private static final Object dummy = new Object();
private final ConcurrentHashMap<CQueryBindCapture, Object> plans = new ConcurrentHashMap<>();
@@ -24,14 +29,25 @@ public final class CQueryPlanManager implements QueryPlanManager {
private final QueryPlanLogger planLogger;
private final TimedMetric timeCollection;
private final TimedMetric timeBindCapture;
private final DefaultServer server;
private final QueryPlanListener listener;
private final int maxCount;
private final long maxTimeMillis;
private long defaultThreshold;
public CQueryPlanManager(TransactionManager transactionManager, long defaultThreshold, QueryPlanLogger planLogger, ExtraMetrics extraMetrics) {
public CQueryPlanManager(DefaultServer server, TransactionManager transactionManager, long defaultThreshold, QueryPlanLogger planLogger, ExtraMetrics extraMetrics) {
this.server = server;
this.transactionManager = transactionManager;
this.defaultThreshold = defaultThreshold;
this.planLogger = planLogger;
this.timeCollection = extraMetrics.planCollect();
this.timeBindCapture = extraMetrics.bindCapture();
final var config = server.config();
this.maxCount = config.getQueryPlanCaptureMaxCount();
this.maxTimeMillis = config.getQueryPlanCaptureMaxTimeMillis();
final var planListener = config.getQueryPlanListener();
this.listener = (planListener != null) ? planListener : DefaultQueryPlanListener.INSTANT;
}
@Override
@@ -49,15 +65,28 @@ public final class CQueryPlanManager implements QueryPlanManager {
timeBindCapture.addSinceNanos(startNanos);
}
@Override
public void startPlanCapture() {
final var config = server.config();
if (config.isQueryPlanCapture()) {
long secs = config.getQueryPlanCapturePeriodSecs();
if (secs > 10) {
log.log(INFO, "capture query plan enabled, every {0}secs", secs);
server.backgroundExecutor().scheduleWithFixedDelay(this::collectQueryPlans, secs, secs, TimeUnit.SECONDS);
}
}
}
private void collectQueryPlans() {
List<MetaQueryPlan> plans = collect(new QueryPlanRequest(maxCount, maxTimeMillis));
listener.process(new QueryPlanCapture(server, plans));
}
@Override
public List<MetaQueryPlan> collect(QueryPlanRequest request) {
if (plans.isEmpty()) {
return emptyList();
}
return collectPlans(request);
}
private List<MetaQueryPlan> collectPlans(QueryPlanRequest request) {
try (Connection connection = transactionManager.queryPlanConnection()) {
CQueryPlanRequest req = new CQueryPlanRequest(connection, request, plans.keySet().iterator());
while (req.hasNext()) {
ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultQueryPlanListener.java → ebean-core/src/main/java/io/ebeaninternal/server/query/DefaultQueryPlanListener.java
+1 -1
View File
@@ -1,4 +1,4 @@
package io.ebeaninternal.server.core;
package io.ebeaninternal.server.query;
import io.avaje.applog.AppLog;
import io.ebean.config.QueryPlanCapture;
ebean-test/src/test/java/org/tests/query/finder/TestCustomerFinder.java
+3 -6
View File
@@ -199,11 +199,8 @@ public class TestCustomerFinder extends BaseTestCase {
}
// obtains db query plans ...
QueryPlanRequest request = new QueryPlanRequest();
// collect max 1000 plans (use something more like 10)
request.maxCount(1_000);
// don't collect any more plans if used 10 secs
request.maxTimeMillis(10_000);
// collect max 10 plans, after 10 secs don't collect any more plans
var request = new QueryPlanRequest(10, 10_000);
List<MetaQueryPlan> plans0 = server().metaInfo().queryPlanCollectNow(request);
assertThat(plans0).isNotEmpty();
@@ -214,7 +211,7 @@ public class TestCustomerFinder extends BaseTestCase {
System.out.println(plan);
}
//DB.getBackgroundExecutor().scheduleWithFixedDelay(...)
// DB.backgroundExecutor().scheduleWithFixedDelay(...)
}
@Test