diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientRequest.java b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientRequest.java index a0c8d007a8..5d5fcdc578 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientRequest.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientRequest.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 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. @@ -96,11 +96,10 @@ public interface ClientRequest { /** * Return a log message prefix to use to correlate messages for this request. - * The prefix is based on the value of the attribute {@link #LOG_ID_ATTRIBUTE} - * along with some extra formatting so that the prefix can be conveniently - * prepended with no further formatting no separators required. + * The prefix is based on the value of the attribute {@link #LOG_ID_ATTRIBUTE + * LOG_ID_ATTRIBUTE} surrounded with "[" and "]". * @return the log message prefix or an empty String if the - * {@link #LOG_ID_ATTRIBUTE} is not set. + * {@link #LOG_ID_ATTRIBUTE LOG_ID_ATTRIBUTE} is not set. * @since 5.1 */ String logPrefix(); diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientResponse.java b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientResponse.java index 6c5bf5b795..992ce6db5a 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientResponse.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientResponse.java @@ -205,14 +205,12 @@ public interface ClientResponse { Mono createException(); /** - * Return a log message prefix to use to correlate messages for this response. - * The prefix is based on the {@linkplain ClientRequest#logPrefix() client - * log prefix}, which itself is based on the value of the request attribute - * {@link ClientRequest#LOG_ID_ATTRIBUTE} along with some extra formatting - * so that the prefix can be conveniently prepended with no further - * formatting no separators required. + * Return a log message prefix to use to correlate messages for this exchange. + * The prefix is based on {@linkplain ClientRequest#logPrefix()}, which + * itself is based on the value of the {@link ClientRequest#LOG_ID_ATTRIBUTE + * LOG_ID_ATTRIBUTE} request attribute, further surrounded with "[" and "]". * @return the log message prefix or an empty String if the - * {@link ClientRequest#LOG_ID_ATTRIBUTE} was not set. + * {@link ClientRequest#LOG_ID_ATTRIBUTE LOG_ID_ATTRIBUTE} is not set. * @since 5.2.3 */ String logPrefix();