logging for JDBC fetch size and query timeout

Author: gavinking

hibernate-core/src/main/java/org/hibernate/engine/jdbc/JdbcLogging.java

@@ -152,8 +152,24 @@ public interface JdbcLogging extends BasicLogger {
 	@Message(value = "Unable to roll back isolated connection on exception ", id = 100021)
 	void unableToRollBackIsolatedConnection(@Cause Exception ignored);
 
+	@LogMessage(level = TRACE)
+	@Message(value = "JDBC fetch size: %s", id = 100022)
+	void fetchSize(int fetchSize);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Low JDBC fetch size: %s (consider setting 'hibernate.jdbc.fetch_size')", id = 100023)
+	void lowFetchSize(int fetchSize);
+
+	@LogMessage(level = TRACE)
+	@Message(value = "Setting JDBC fetch size: %s", id = 100024)
+	void settingFetchSize(int fetchSize);
+
+	@LogMessage(level = TRACE)
+	@Message(value = "Setting JDBC query timeout: %s", id = 100025)
+	void settingQueryTimeout(int timeout);
+
 	@LogMessage(level = WARN)
-	@Message(value = "Called joinTransaction() on a non-JTA EntityManager (ignoring)", id = 100025)
+	@Message(value = "Called joinTransaction() on a non-JTA EntityManager (ignoring)", id = 100026)
 	void callingJoinTransactionOnNonJtaEntityManager();
 
 	@LogMessage(level = TRACE)

hibernate-core/src/main/java/org/hibernate/engine/jdbc/internal/StatementPreparerImpl.java

@@ -25,6 +25,8 @@
 
 import org.checkerframework.checker.nullness.qual.Nullable;
 
+import static org.hibernate.engine.jdbc.JdbcLogging.JDBC_MESSAGE_LOGGER;
+
 /**
  * Standard implementation of {@link StatementPreparer}.
  *
@@ -141,7 +143,7 @@ public PreparedStatement prepareQueryStatement(
 		final int resultSetType;
 		if ( scrollMode != null && scrollMode != ScrollMode.FORWARD_ONLY ) {
 			if ( !settings().isScrollableResultSetsEnabled() ) {
-				throw new AssertionFailure("scrollable result sets are not enabled");
+				throw new AssertionFailure( "Scrollable result sets are not enabled" );
 			}
 			resultSetType = scrollMode.toResultSetType();
 		}
@@ -224,8 +226,21 @@ public void postProcess(PreparedStatement preparedStatement) throws SQLException
 	}
 
 	private void setStatementFetchSize(PreparedStatement statement) throws SQLException {
-		if ( settings().getFetchSizeOrNull() != null ) {
-			statement.setFetchSize( settings().getFetchSizeOrNull() );
+		final Integer fetchSize = settings().getFetchSizeOrNull();
+		if ( fetchSize != null ) {
+			JDBC_MESSAGE_LOGGER.settingFetchSize( fetchSize );
+			statement.setFetchSize( fetchSize );
+		}
+		else {
+			if ( JDBC_MESSAGE_LOGGER.isDebugEnabled() ) {
+				final int defaultFetchSize = statement.getFetchSize();
+				if ( defaultFetchSize < 100 ) {
+					JDBC_MESSAGE_LOGGER.lowFetchSize( statement.getFetchSize() );
+				}
+			}
+			else if ( JDBC_MESSAGE_LOGGER.isTraceEnabled() ) {
+				JDBC_MESSAGE_LOGGER.fetchSize( statement.getFetchSize() );
+			}
 		}
 	}
 

hibernate-core/src/main/java/org/hibernate/sql/results/jdbc/internal/DeferredResultSetAccess.java

@@ -36,6 +36,7 @@
 import org.hibernate.sql.exec.spi.JdbcSelectExecutor;
 
 import static java.util.Collections.emptyMap;
+import static org.hibernate.engine.jdbc.JdbcLogging.JDBC_MESSAGE_LOGGER;
 
 /**
  * @author Steve Ebersole
@@ -241,11 +242,15 @@ private void setQueryOptions(PreparedStatement preparedStatement) throws SQLExce
 		final QueryOptions queryOptions = executionContext.getQueryOptions();
 		// set options
 		if ( queryOptions != null ) {
-			if ( queryOptions.getFetchSize() != null ) {
-				preparedStatement.setFetchSize( queryOptions.getFetchSize() );
+			final Integer fetchSize = queryOptions.getFetchSize();
+			if ( fetchSize != null ) {
+				JDBC_MESSAGE_LOGGER.settingFetchSize( fetchSize );
+				preparedStatement.setFetchSize( fetchSize );
 			}
-			if ( queryOptions.getTimeout() != null ) {
-				preparedStatement.setQueryTimeout( queryOptions.getTimeout() );
+			final Integer timeout = queryOptions.getTimeout();
+			if ( timeout != null ) {
+				JDBC_MESSAGE_LOGGER.settingQueryTimeout( timeout );
+				preparedStatement.setQueryTimeout( timeout );
 			}
 		}
 	}