migrate QueryResultsCacheImpl logging to SecondLevelCacheLogger

Author: gavinking

hibernate-core/src/main/java/org/hibernate/cache/internal/QueryResultsCacheImpl.java

@@ -51,7 +51,7 @@ public boolean put(
 			final List<?> results,
 			final SharedSessionContractImplementor session) throws HibernateException {
 		if ( L2CACHE_LOGGER.isTraceEnabled() ) {
-			L2CACHE_LOGGER.tracef( "Caching query results in region: %s; timestamp=%s",
+			L2CACHE_LOGGER.cachingQueryResults(
 					cacheRegion.getName(),
 					session.getCacheTransactionSynchronization().getCachingTimestamp() );
 		}
@@ -92,26 +92,26 @@ public List<?> get(
 			final SharedSessionContractImplementor session) throws HibernateException {
 		final boolean loggerTraceEnabled = L2CACHE_LOGGER.isTraceEnabled();
 		if ( loggerTraceEnabled ) {
-			L2CACHE_LOGGER.tracef( "Checking cached query results in region: %s", cacheRegion.getName() );
+			L2CACHE_LOGGER.checkingCachedQueryResults( cacheRegion.getName() );
 		}
 
 		final CacheItem cacheItem = getCachedData( key, session );
 		if ( cacheItem == null ) {
 			if ( loggerTraceEnabled ) {
-				L2CACHE_LOGGER.trace( "Query results were not found in cache" );
+				L2CACHE_LOGGER.queryResultsNotFound();
 			}
 			return null;
 		}
 
 		if ( !timestampsCache.isUpToDate( spaces, cacheItem.timestamp, session ) ) {
 			if ( loggerTraceEnabled ) {
-				L2CACHE_LOGGER.trace( "Cached query results were not up-to-date" );
+				L2CACHE_LOGGER.cachedQueryResultsStale();
 			}
 			return null;
 		}
 
 		if ( loggerTraceEnabled ) {
-			L2CACHE_LOGGER.trace( "Returning cached query results" );
+			L2CACHE_LOGGER.returningCachedQueryResults();
 		}
 
 		// No need to copy results, since consumers will never mutate
@@ -124,27 +124,28 @@ public List<?> get(
 			final String[] spaces,
 			final SharedSessionContractImplementor session) throws HibernateException {
 		final boolean loggerTraceEnabled = L2CACHE_LOGGER.isTraceEnabled();
+
 		if ( loggerTraceEnabled ) {
-			L2CACHE_LOGGER.tracef( "Checking cached query results in region: %s", cacheRegion.getName() );
+			L2CACHE_LOGGER.checkingCachedQueryResults( cacheRegion.getName() );
 		}
 
 		final CacheItem cacheItem = getCachedData( key, session );
 		if ( cacheItem == null ) {
 			if ( loggerTraceEnabled ) {
-				L2CACHE_LOGGER.trace( "Query results were not found in cache" );
+				L2CACHE_LOGGER.queryResultsNotFound();
 			}
 			return null;
 		}
 
 		if ( !timestampsCache.isUpToDate( spaces, cacheItem.timestamp, session ) ) {
 			if ( loggerTraceEnabled ) {
-				L2CACHE_LOGGER.trace( "Cached query results were not up-to-date" );
+				L2CACHE_LOGGER.cachedQueryResultsStale();
 			}
 			return null;
 		}
 
 		if ( loggerTraceEnabled ) {
-			L2CACHE_LOGGER.trace( "Returning cached query results" );
+			L2CACHE_LOGGER.returningCachedQueryResults();
 		}
 
 		return deepCopy( cacheItem.results );

hibernate-core/src/main/java/org/hibernate/cache/spi/SecondLevelCacheLogger.java

@@ -17,6 +17,7 @@
 import java.lang.invoke.MethodHandles;
 
 import static org.jboss.logging.Logger.Level.INFO;
+import static org.jboss.logging.Logger.Level.TRACE;
 import static org.jboss.logging.Logger.Level.WARN;
 
 /**
@@ -26,7 +27,7 @@
 @ValidIdRange( min = 90001001, max = 90002000 )
 @SubSystemLogging(
 		name = SecondLevelCacheLogger.LOGGER_NAME,
-		description = "Logging related to Hibernate second-level caching"
+		description = "Logging related to the second-level cache"
 )
 @Internal
 public interface SecondLevelCacheLogger extends BasicLogger {
@@ -60,7 +61,7 @@ public interface SecondLevelCacheLogger extends BasicLogger {
 
 	@LogMessage( level = WARN )
 	@Message(
-			value = "Read-only caching was requested for mutable natural-id for entity [%s]",
+			value = "Read-only caching was requested for entity [%s] with mutable natural id",
 			id = NAMESPACE + 4
 	)
 	void readOnlyCachingMutableNaturalId(String entity);
@@ -100,4 +101,38 @@ public interface SecondLevelCacheLogger extends BasicLogger {
 	@SuppressWarnings( "unused" ) // used by hibernate-jcache
 	void nonStandardSupportForAccessType(String regionName, String accessType, String regionFactoryClass);
 
+	@LogMessage(level = TRACE)
+	@Message(
+			value = "Caching query results in region '%s' with timestamp %s",
+			id = NAMESPACE + 9
+	)
+	void cachingQueryResults(String regionName, long timestamp);
+
+	@LogMessage(level = TRACE)
+	@Message(
+			value = "Checking cached query results in region '%s'",
+			id = NAMESPACE + 10
+	)
+	void checkingCachedQueryResults(String regionName);
+
+	@LogMessage(level = TRACE)
+	@Message(
+			value = "Query results were not found in cache",
+			id = NAMESPACE + 11
+	)
+	void queryResultsNotFound();
+
+	@LogMessage(level = TRACE)
+	@Message(
+			value = "Cached query results were stale",
+			id = NAMESPACE + 12
+	)
+	void cachedQueryResultsStale();
+
+	@LogMessage(level = TRACE)
+	@Message(
+			value = "Returning cached query results",
+			id = NAMESPACE + 14
+	)
+	void returningCachedQueryResults();
 }