[DATAES-317] introduce query logging in ElasticsearchTemplate

Author: xhaggi

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,7 +41,6 @@
 import org.elasticsearch.action.bulk.BulkItemResponse;
 import org.elasticsearch.action.bulk.BulkRequestBuilder;
 import org.elasticsearch.action.bulk.BulkResponse;
-import org.elasticsearch.action.count.CountRequestBuilder;
 import org.elasticsearch.action.get.GetResponse;
 import org.elasticsearch.action.get.MultiGetRequest;
 import org.elasticsearch.action.get.MultiGetRequestBuilder;
@@ -85,7 +84,6 @@
 import org.springframework.data.elasticsearch.core.aggregation.impl.AggregatedPageImpl;
 import org.springframework.data.elasticsearch.core.convert.ElasticsearchConverter;
 import org.springframework.data.elasticsearch.core.convert.MappingElasticsearchConverter;
-import org.springframework.data.elasticsearch.core.facet.FacetRequest;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
 import org.springframework.data.elasticsearch.core.mapping.SimpleElasticsearchMappingContext;
 import org.springframework.data.elasticsearch.core.query.*;
@@ -104,10 +102,12 @@
  * @author Young Gu
  * @author Oliver Gierke
  * @author Mark Janssen
+ * @author Sascha Woo
  */
 
 public class ElasticsearchTemplate implements ElasticsearchOperations, ApplicationContextAware {
 
+	private static final Logger QUERY_LOGGER = LoggerFactory.getLogger("org.springframework.data.elasticsearch.core.QUERY");
 	private static final Logger logger = LoggerFactory.getLogger(ElasticsearchTemplate.class);
 	private Client client;
 	private ElasticsearchConverter elasticsearchConverter;
@@ -304,6 +304,10 @@ public <T> List<String> queryForIds(SearchQuery query) {
 		if (query.getFilter() != null) {
 			request.setPostFilter(query.getFilter());
 		}
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(request.toString());
+
 		SearchResponse response = getSearchResponse(request.execute());
 		return extractIds(response);
 	}
@@ -326,12 +330,11 @@ public <T> Page<T> queryForPage(CriteriaQuery criteriaQuery, Class<T> clazz) {
 
 		if (elasticsearchFilter != null)
 			searchRequestBuilder.setPostFilter(elasticsearchFilter);
-		if (logger.isDebugEnabled()) {
-			logger.debug("doSearch query:\n" + searchRequestBuilder.toString());
-		}
 
-		SearchResponse response = getSearchResponse(searchRequestBuilder
-				.execute());
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(searchRequestBuilder.toString());
+
+		SearchResponse response = getSearchResponse(searchRequestBuilder.execute());
 		return resultsMapper.mapResults(response, clazz, criteriaQuery.getPageable());
 	}
 
@@ -342,7 +345,12 @@ public <T> Page<T> queryForPage(StringQuery query, Class<T> clazz) {
 
 	@Override
 	public <T> Page<T> queryForPage(StringQuery query, Class<T> clazz, SearchResultMapper mapper) {
-		SearchResponse response = getSearchResponse(prepareSearch(query, clazz).setQuery(query.getSource()).execute());
+		SearchRequestBuilder requestBuilder = prepareSearch(query, clazz).setQuery(query.getSource());
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(requestBuilder.toString());
+
+		SearchResponse response = getSearchResponse(requestBuilder.execute());
 		return mapper.mapResults(response, clazz, query.getPageable());
 	}
 
@@ -464,6 +472,10 @@ private long doCount(CountRequestBuilder countRequestBuilder, QueryBuilder elast
 		if (elasticsearchQuery != null) {
 			countRequestBuilder.setQuery(elasticsearchQuery);
 		}
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(countRequestBuilder.toString());
+
 		return countRequestBuilder.execute().actionGet().getCount();
 	}
 
@@ -477,6 +489,10 @@ private long doCount(SearchRequestBuilder searchRequestBuilder, QueryBuilder ela
 			searchRequestBuilder.setPostFilter(elasticsearchFilter);
 		}
 		searchRequestBuilder.setSearchType(SearchType.COUNT);
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(searchRequestBuilder.toString());
+
 		return searchRequestBuilder.execute().actionGet().getHits().getTotalHits();
 	}
 
@@ -780,6 +796,9 @@ private String doScan(SearchRequestBuilder requestBuilder, CriteriaQuery criteri
 			requestBuilder.setPostFilter(elasticsearchFilter);
 		}
 
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(requestBuilder.toString());
+
 		return getSearchResponse(requestBuilder.execute()).getScrollId();
 	}
 
@@ -792,7 +811,12 @@ private String doScan(SearchRequestBuilder requestBuilder, SearchQuery searchQue
 			requestBuilder.setPostFilter(searchQuery.getFilter());
 		}
 
-		return getSearchResponse(requestBuilder.setQuery(searchQuery.getQuery()).execute()).getScrollId();
+		requestBuilder.setQuery(searchQuery.getQuery());
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(requestBuilder.toString());
+
+		return getSearchResponse(requestBuilder.execute()).getScrollId();
 	}
 
 	@Override
@@ -897,7 +921,13 @@ private SearchResponse doSearch(SearchRequestBuilder searchRequest, SearchQuery
 				searchRequest.addAggregation(aggregatedFacet.getFacet());
 			}
 		}
-		return getSearchResponse(searchRequest.setQuery(searchQuery.getQuery()).execute());
+
+		searchRequest.setQuery(searchQuery.getQuery());
+
+		if (QUERY_LOGGER.isDebugEnabled())
+			QUERY_LOGGER.debug(searchRequest.toString());
+
+		return getSearchResponse(searchRequest.execute());
 	}
 
 	private SearchResponse getSearchResponse(ListenableActionFuture<SearchResponse> response) {