DATAES-504 - Add configuration options for logging and timeouts to ReactiveElasticsearchClient.

We now log HTTP requests and responses with the org.springframework.data.elasticsearch.client.WIRE logger for both, the HighLevelRestClient and our reactive client and associate a logging Id for improved traceability.

Configuration of connection/socket timeouts is now available via the ClientConfiguration.

Along the lines we also aligned entity handling to EntityOperations already common in other modules. EntityOperations centralizes how aspects of entities (versioning, retrieval of index name/index type) are handled.

Original Pull Request: spring-projects#229

Author: mp911de

src/main/java/org/springframework/data/elasticsearch/client/ClientConfiguration.java

@@ -16,6 +16,8 @@
 package org.springframework.data.elasticsearch.client;
 
 import java.net.InetSocketAddress;
+import java.net.SocketAddress;
+import java.time.Duration;
 import java.util.List;
 import java.util.Optional;
 
@@ -99,6 +101,23 @@ static ClientConfiguration create(InetSocketAddress socketAddress) {
 	 */
 	Optional<SSLContext> getSslContext();
 
+	/**
+	 * Returns the {@link java.time.Duration connect timeout}.
+	 *
+	 * @see java.net.Socket#connect(SocketAddress, int)
+	 * @see io.netty.channel.ChannelOption#CONNECT_TIMEOUT_MILLIS
+	 */
+	Duration getConnectTimeout();
+
+	/**
+	 * Returns the {@link java.time.Duration socket timeout} which is typically applied as SO-timeout/read timeout.
+	 *
+	 * @see java.net.Socket#setSoTimeout(int)
+	 * @see io.netty.handler.timeout.ReadTimeoutHandler
+	 * @see io.netty.handler.timeout.WriteTimeoutHandler
+	 */
+	Duration getSocketTimeout();
+
 	/**
 	 * @author Christoph Strobl
 	 */
@@ -146,38 +165,59 @@ default MaybeSecureClientConfigurationBuilder connectedToLocalhost() {
 	/**
 	 * @author Christoph Strobl
 	 */
-	interface MaybeSecureClientConfigurationBuilder extends ClientConfigurationBuilderWithOptionalDefaultHeaders {
+	interface MaybeSecureClientConfigurationBuilder extends TerminalClientConfigurationBuilder {
 
 		/**
 		 * Connect via {@literal https} <br />
 		 * <strong>NOTE</strong> You need to leave out the protocol in
 		 * {@link ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(String)}.
 		 *
-		 * @return the {@link ClientConfigurationBuilderWithOptionalDefaultHeaders}.
+		 * @return the {@link TerminalClientConfigurationBuilder}.
 		 */
-		ClientConfigurationBuilderWithOptionalDefaultHeaders usingSsl();
+		TerminalClientConfigurationBuilder usingSsl();
 
 		/**
 		 * Connect via {@literal https} using the given {@link SSLContext}.<br />
 		 * <strong>NOTE</strong> You need to leave out the protocol in
 		 * {@link ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(String)}.
 		 *
-		 * @return the {@link ClientConfigurationBuilderWithOptionalDefaultHeaders}.
+		 * @return the {@link TerminalClientConfigurationBuilder}.
 		 */
-		ClientConfigurationBuilderWithOptionalDefaultHeaders usingSsl(SSLContext sslContext);
+		TerminalClientConfigurationBuilder usingSsl(SSLContext sslContext);
 	}
 
 	/**
 	 * @author Christoph Strobl
 	 * @author Mark Paluch
 	 */
-	interface ClientConfigurationBuilderWithOptionalDefaultHeaders {
+	interface TerminalClientConfigurationBuilder {
 
 		/**
 		 * @param defaultHeaders must not be {@literal null}.
-		 * @return the {@link ClientConfigurationBuilderWithOptionalDefaultHeaders}
+		 * @return the {@link TerminalClientConfigurationBuilder}
+		 */
+		TerminalClientConfigurationBuilder withDefaultHeaders(HttpHeaders defaultHeaders);
+
+		/**
+		 * Configure a {@link java.time.Duration} connect timeout.
+		 *
+		 * @param connectTimeout the timeout to use.
+		 * @return the {@link TerminalClientConfigurationBuilder}
+		 * @see java.net.Socket#connect(SocketAddress, int)
+		 * @see io.netty.channel.ChannelOption#CONNECT_TIMEOUT_MILLIS
+		 */
+		TerminalClientConfigurationBuilder withConnectTimeout(Duration connectTimeout);
+
+		/**
+		 * Configure a {@link java.time.Duration socket timeout} which is typically applied as SO-timeout/read timeout.
+		 *
+		 * @param soTimeout the timeout to use.
+		 * @return the {@link TerminalClientConfigurationBuilder}
+		 * @see java.net.Socket#setSoTimeout(int)
+		 * @see io.netty.handler.timeout.ReadTimeoutHandler
+		 * @see io.netty.handler.timeout.WriteTimeoutHandler
 		 */
-		ClientConfigurationBuilderWithOptionalDefaultHeaders withDefaultHeaders(HttpHeaders defaultHeaders);
+		TerminalClientConfigurationBuilder withSocketTimeout(Duration soTimeout);
 
 		/**
 		 * Build the {@link ClientConfiguration} object.

src/main/java/org/springframework/data/elasticsearch/client/ClientConfigurationBuilder.java

@@ -16,16 +16,17 @@
 package org.springframework.data.elasticsearch.client;
 
 import java.net.InetSocketAddress;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 
 import javax.net.ssl.SSLContext;
 
-import org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithOptionalDefaultHeaders;
 import org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint;
 import org.springframework.data.elasticsearch.client.ClientConfiguration.MaybeSecureClientConfigurationBuilder;
+import org.springframework.data.elasticsearch.client.ClientConfiguration.TerminalClientConfigurationBuilder;
 import org.springframework.http.HttpHeaders;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
@@ -44,8 +45,10 @@ class ClientConfigurationBuilder
 	private HttpHeaders headers = HttpHeaders.EMPTY;
 	private boolean useSsl;
 	private @Nullable SSLContext sslContext;
+	private Duration connectTimeout = Duration.ofSeconds(10);
+	private Duration soTimeout = Duration.ofSeconds(5);
 
-	/* 
+	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(java.lang.String[])
 	 */
@@ -58,7 +61,7 @@ public MaybeSecureClientConfigurationBuilder connectedTo(String... hostAndPorts)
 		return this;
 	}
 
-	/* 
+	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint#connectedTo(java.net.InetSocketAddress[])
 	 */
@@ -72,23 +75,23 @@ public MaybeSecureClientConfigurationBuilder connectedTo(InetSocketAddress... en
 		return this;
 	}
 
-	/* 
+	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.MaybeSecureClientConfigurationBuilder#usingSsl()
 	 */
 	@Override
-	public ClientConfigurationBuilderWithOptionalDefaultHeaders usingSsl() {
+	public TerminalClientConfigurationBuilder usingSsl() {
 
 		this.useSsl = true;
 		return this;
 	}
 
-	/* 
+	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.MaybeSecureClientConfigurationBuilder#usingSsl(javax.net.ssl.SSLContext)
 	 */
 	@Override
-	public ClientConfigurationBuilderWithOptionalDefaultHeaders usingSsl(SSLContext sslContext) {
+	public TerminalClientConfigurationBuilder usingSsl(SSLContext sslContext) {
 
 		Assert.notNull(sslContext, "SSL Context must not be null");
 
@@ -97,26 +100,53 @@ public ClientConfigurationBuilderWithOptionalDefaultHeaders usingSsl(SSLContext
 		return this;
 	}
 
-	/* 
+	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithOptionalDefaultHeaders#withDefaultHeaders(org.springframework.http.HttpHeaders)
+	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.TerminalClientConfigurationBuilder#withDefaultHeaders(org.springframework.http.HttpHeaders)
 	 */
 	@Override
-	public ClientConfigurationBuilderWithOptionalDefaultHeaders withDefaultHeaders(HttpHeaders defaultHeaders) {
+	public TerminalClientConfigurationBuilder withDefaultHeaders(HttpHeaders defaultHeaders) {
 
 		Assert.notNull(defaultHeaders, "Default HTTP headers must not be null");
 
 		this.headers = defaultHeaders;
 		return this;
 	}
 
-	/* 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.TerminalClientConfigurationBuilder#withConnectTimeout(java.time.Duration)
+	 */
+	@Override
+	public TerminalClientConfigurationBuilder withConnectTimeout(Duration connectTimeout) {
+
+		Assert.notNull(connectTimeout, "I/O timeout must not be null!");
+
+		this.connectTimeout = connectTimeout;
+		return this;
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.TerminalClientConfigurationBuilder#withTimeout(java.time.Duration)
+	 */
+	@Override
+	public TerminalClientConfigurationBuilder withSocketTimeout(Duration soTimeout) {
+
+		Assert.notNull(soTimeout, "Socket timeout must not be null!");
+
+		this.soTimeout = soTimeout;
+		return this;
+	}
+
+	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.elasticsearch.client.ClientConfiguration.ClientConfigurationBuilderWithOptionalDefaultHeaders#build()
 	 */
 	@Override
 	public ClientConfiguration build() {
-		return new DefaultClientConfiguration(this.hosts, this.headers, this.useSsl, this.sslContext);
+		return new DefaultClientConfiguration(this.hosts, this.headers, this.useSsl, this.sslContext, this.soTimeout,
+				this.connectTimeout);
 	}
 
 	private static InetSocketAddress parse(String hostAndPort) {

src/main/java/org/springframework/data/elasticsearch/client/ClientLogger.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2018 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.elasticsearch.client;
+
+import java.util.function.Supplier;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.util.ObjectUtils;
+
+/**
+ * Logging Utility to log client requests and responses. Logs client requests and responses to Elasticsearch to a
+ * dedicated logger: {@code org.springframework.data.elasticsearch.client.WIRE} on {@link org.slf4j.event.Level#TRACE}
+ * level.
+ *
+ * @author Mark Paluch
+ * @since 4.0
+ */
+public abstract class ClientLogger {
+
+	private static final String lineSeparator = System.getProperty("line.separator");
+	private static final Logger WIRE_LOGGER = LoggerFactory
+			.getLogger("org.springframework.data.elasticsearch.client.WIRE");
+
+	private ClientLogger() {}
+
+	/**
+	 * Returns {@literal true} if the logger is enabled.
+	 *
+	 * @return {@literal true} if the logger is enabled.
+	 */
+	public static boolean isEnabled() {
+		return WIRE_LOGGER.isTraceEnabled();
+	}
+
+	/**
+	 * Log an outgoing HTTP request.
+	 *
+	 * @param logId the correlation Id, see {@link #newLogId()}.
+	 * @param method HTTP method
+	 * @param endpoint URI
+	 * @param parameters optional parameters.
+	 */
+	public static void logRequest(String logId, String method, String endpoint, Object parameters) {
+
+		if (WIRE_LOGGER.isTraceEnabled()) {
+			WIRE_LOGGER.trace("[{}] Sending request {} {} with parameters: {}", logId, method.toUpperCase(), endpoint,
+					parameters);
+		}
+	}
+
+	/**
+	 * Log an outgoing HTTP request with a request body.
+	 *
+	 * @param logId the correlation Id, see {@link #newLogId()}.
+	 * @param method HTTP method
+	 * @param endpoint URI
+	 * @param parameters optional parameters.
+	 * @param body body content supplier.
+	 */
+	public static void logRequest(String logId, String method, String endpoint, Object parameters,
+			Supplier<Object> body) {
+
+		if (WIRE_LOGGER.isTraceEnabled()) {
+			WIRE_LOGGER.trace("[{}] Sending request {} {} with parameters: {}{}Request body: {}", logId, method.toUpperCase(),
+					endpoint, parameters, lineSeparator, body.get());
+		}
+	}
+
+	/**
+	 * Log a raw HTTP response without logging the body.
+	 *
+	 * @param logId the correlation Id, see {@link #newLogId()}.
+	 * @param statusCode the HTTP status code.
+	 */
+	public static void logRawResponse(String logId, HttpStatus statusCode) {
+
+		if (WIRE_LOGGER.isTraceEnabled()) {
+			WIRE_LOGGER.trace("[{}] Received raw response: ", logId, statusCode);
+		}
+	}
+
+	/**
+	 * Log a raw HTTP response along with the body.
+	 *
+	 * @param logId the correlation Id, see {@link #newLogId()}.
+	 * @param statusCode the HTTP status code.
+	 * @param body body content.
+	 */
+	public static void logResponse(String logId, HttpStatus statusCode, String body) {
+
+		if (WIRE_LOGGER.isTraceEnabled()) {
+			WIRE_LOGGER.trace("[{}] Received response: {}{}Response body: {}", logId, statusCode, lineSeparator, body);
+		}
+	}
+
+	/**
+	 * Creates a new, unique correlation Id to improve tracing across log events.
+	 *
+	 * @return a new, unique correlation Id.
+	 */
+	public static String newLogId() {
+		return ObjectUtils.getIdentityHexString(new Object());
+	}
+}