Rename HTTP trace properties and packages

Closes gh-11934
This commit is contained in:
Andy Wilkinson 2018-02-08 13:07:06 +00:00
parent 509b068338
commit 4beb6be179
32 changed files with 81 additions and 78 deletions

View File

@ -16,9 +16,9 @@
package org.springframework.boot.actuate.autoconfigure.web.trace;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.web.trace.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.web.trace.reactive.HttpTraceWebFilter;
import org.springframework.boot.actuate.web.trace.servlet.HttpTraceFilter;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

View File

@ -17,8 +17,8 @@
package org.springframework.boot.actuate.autoconfigure.web.trace;
import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
import org.springframework.boot.actuate.web.trace.HttpTraceEndpoint;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.HttpTraceEndpoint;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;

View File

@ -19,7 +19,7 @@ package org.springframework.boot.actuate.autoconfigure.web.trace;
import java.util.HashSet;
import java.util.Set;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
@ -32,7 +32,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @author Stephane Nicoll
* @since 2.0.0
*/
@ConfigurationProperties(prefix = "management.httptrace")
@ConfigurationProperties(prefix = "management.trace.http")
public class HttpTraceProperties {
/**

View File

@ -222,7 +222,7 @@
"defaultValue": true
},
{
"name": "management.httptrace.enabled",
"name": "management.trace.http.enabled",
"type": "java.lang.Boolean",
"description": "Whether to enable HTTP request-response tracing.",
"defaultValue": true
@ -232,7 +232,7 @@
"type": "java.lang.Boolean",
"description": "Whether to enable the trace servlet filter.",
"deprecation": {
"replacement": "management.httptrace.enabled",
"replacement": "management.trace.http.enabled",
"level": "error"
}
},
@ -1053,7 +1053,7 @@
"description": "Enable the trace servlet filter.",
"defaultValue": true,
"deprecation": {
"replacement": "management.trace.filter.enabled",
"replacement": "management.trace.http.enabled",
"level": "error"
}
},
@ -1062,7 +1062,7 @@
"type": "java.lang.Boolean",
"description": "Enable the endpoint.",
"deprecation": {
"replacement": "management.endpoint.trace.enabled",
"replacement": "management.endpoint.httptrace.enabled",
"level": "error"
}
},
@ -1080,7 +1080,7 @@
"type": "java.lang.String",
"description": "Endpoint URL path.",
"deprecation": {
"replacement": "management.endpoints.web.path-mapping.trace",
"replacement": "management.endpoints.web.path-mapping.httptrace",
"level": "error"
}
},
@ -1477,7 +1477,7 @@
{
"name": "management.trace.include",
"deprecation": {
"replacement": "management.httptrace.include",
"replacement": "management.trace.http.include",
"level": "error"
}
},
@ -1632,6 +1632,9 @@
{
"value": "heapdump"
},
{
"value": "httptrace"
},
{
"value": "info"
},
@ -1664,9 +1667,6 @@
},
{
"value": "threaddump"
},
{
"value": "trace"
}
],
"providers": [

View File

@ -25,13 +25,13 @@ import java.util.UUID;
import org.junit.Test;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace;
import org.springframework.boot.actuate.web.trace.HttpTraceEndpoint;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.web.trace.TraceableRequest;
import org.springframework.boot.actuate.web.trace.TraceableResponse;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace;
import org.springframework.boot.actuate.trace.http.HttpTraceEndpoint;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.actuate.trace.http.TraceableRequest;
import org.springframework.boot.actuate.trace.http.TraceableResponse;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

View File

@ -21,11 +21,11 @@ import java.util.Set;
import org.junit.Test;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.web.trace.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.actuate.web.trace.reactive.HttpTraceWebFilter;
import org.springframework.boot.actuate.web.trace.servlet.HttpTraceFilter;
import org.springframework.boot.autoconfigure.AutoConfigurations;

View File

@ -18,7 +18,7 @@ package org.springframework.boot.actuate.autoconfigure.web.trace;
import org.junit.Test;
import org.springframework.boot.actuate.web.trace.HttpTraceEndpoint;
import org.springframework.boot.actuate.trace.http.HttpTraceEndpoint;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.net.URI;
import java.security.Principal;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.net.URI;
import java.time.Instant;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.List;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.List;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.ArrayList;
import java.util.Collections;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.Collections;
import java.util.LinkedHashSet;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.net.URI;
import java.util.List;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.List;
import java.util.Map;

View File

@ -17,6 +17,6 @@
/**
* Actuator HTTP tracing support.
*
* @see org.springframework.boot.actuate.web.trace.HttpTraceRepository
* @see org.springframework.boot.actuate.trace.http.HttpTraceRepository
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;

View File

@ -21,10 +21,10 @@ import java.util.Set;
import reactor.core.publisher.Mono;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpResponse;

View File

@ -21,7 +21,7 @@ import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.springframework.boot.actuate.web.trace.TraceableRequest;
import org.springframework.boot.actuate.trace.http.TraceableRequest;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.web.server.ServerWebExchange;

View File

@ -20,7 +20,7 @@ import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.springframework.boot.actuate.web.trace.TraceableResponse;
import org.springframework.boot.actuate.trace.http.TraceableResponse;
import org.springframework.http.server.reactive.ServerHttpResponse;
/**

View File

@ -17,6 +17,6 @@
/**
* Actuator reactive HTTP tracing support.
*
* @see org.springframework.boot.actuate.web.trace.HttpTraceRepository
* @see org.springframework.boot.actuate.trace.http.HttpTraceRepository
*/
package org.springframework.boot.actuate.web.trace.reactive;

View File

@ -26,9 +26,9 @@ import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import javax.servlet.http.HttpSession;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.web.filter.OncePerRequestFilter;

View File

@ -25,7 +25,7 @@ import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.springframework.boot.actuate.web.trace.TraceableRequest;
import org.springframework.boot.actuate.trace.http.TraceableRequest;
import org.springframework.util.StringUtils;
/**

View File

@ -23,7 +23,7 @@ import java.util.Map;
import javax.servlet.http.HttpServletResponse;
import org.springframework.boot.actuate.web.trace.TraceableResponse;
import org.springframework.boot.actuate.trace.http.TraceableResponse;
/**
* An adapter that exposes an {@link HttpServletResponse} as a {@link TraceableResponse}.

View File

@ -17,6 +17,6 @@
/**
* Actuator servlet HTTP tracing support.
*
* @see org.springframework.boot.actuate.web.trace.HttpTraceRepository
* @see org.springframework.boot.actuate.trace.http.HttpTraceRepository
*/
package org.springframework.boot.actuate.web.trace.servlet;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.net.URI;
import java.security.Principal;
@ -27,7 +27,7 @@ import java.util.Map;
import org.junit.Test;
import org.springframework.boot.actuate.web.trace.HttpTrace.Request;
import org.springframework.boot.actuate.trace.http.HttpTrace.Request;
import org.springframework.http.HttpHeaders;
import static org.assertj.core.api.Assertions.assertThat;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.List;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace;
package org.springframework.boot.actuate.trace.http;
import java.util.List;
@ -30,7 +30,7 @@ import static org.mockito.Mockito.mock;
* @author Dave Syer
* @author Andy Wilkinson
*/
public class InMemoryTraceRepositoryTests {
public class InMemoryHttpTraceRepositoryTests {
private final InMemoryHttpTraceRepository repository = new InMemoryHttpTraceRepository();

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace.reactive;
package org.springframework.boot.actuate.trace.http.reactive;
import java.util.EnumSet;
import java.util.Set;
@ -22,10 +22,11 @@ import java.util.Set;
import org.junit.Test;
import reactor.core.publisher.Mono;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTraceRepository;
import org.springframework.boot.actuate.web.trace.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.actuate.web.trace.reactive.HttpTraceWebFilter;
import org.springframework.boot.test.context.runner.ReactiveWebApplicationContextRunner;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace.reactive;
package org.springframework.boot.actuate.trace.http.reactive;
import java.io.IOException;
import java.security.Principal;
@ -25,10 +25,11 @@ import javax.servlet.ServletException;
import org.junit.Test;
import reactor.core.publisher.Mono;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace.Session;
import org.springframework.boot.actuate.web.trace.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace.Session;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.actuate.web.trace.reactive.HttpTraceWebFilter;
import org.springframework.mock.http.server.reactive.MockServerHttpRequest;
import org.springframework.mock.web.server.MockServerWebExchange;
import org.springframework.web.server.ServerWebExchange;
@ -134,7 +135,7 @@ public class HttpTraceWebFilterTests {
}).block();
assertThat(this.repository.findAll()).hasSize(1);
org.springframework.boot.actuate.web.trace.HttpTrace.Principal tracedPrincipal = this.repository
org.springframework.boot.actuate.trace.http.HttpTrace.Principal tracedPrincipal = this.repository
.findAll().get(0).getPrincipal();
assertThat(tracedPrincipal).isNotNull();
assertThat(tracedPrincipal.getName()).isEqualTo("alice");

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.springframework.boot.actuate.web.trace.servlet;
package org.springframework.boot.actuate.trace.http.servlet;
import java.io.IOException;
import java.security.Principal;
@ -27,10 +27,11 @@ import javax.servlet.http.HttpServletResponse;
import org.junit.Test;
import org.springframework.boot.actuate.web.trace.HttpExchangeTracer;
import org.springframework.boot.actuate.web.trace.HttpTrace.Session;
import org.springframework.boot.actuate.web.trace.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.web.trace.Include;
import org.springframework.boot.actuate.trace.http.HttpExchangeTracer;
import org.springframework.boot.actuate.trace.http.HttpTrace.Session;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.boot.actuate.trace.http.Include;
import org.springframework.boot.actuate.web.trace.servlet.HttpTraceFilter;
import org.springframework.mock.web.MockFilterChain;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
@ -96,7 +97,7 @@ public class HttpTraceFilterTests {
this.filter.doFilter(request, new MockHttpServletResponse(),
new MockFilterChain());
assertThat(this.repository.findAll()).hasSize(1);
org.springframework.boot.actuate.web.trace.HttpTrace.Principal tracedPrincipal = this.repository
org.springframework.boot.actuate.trace.http.HttpTrace.Principal tracedPrincipal = this.repository
.findAll().get(0).getPrincipal();
assertThat(tracedPrincipal).isNotNull();
assertThat(tracedPrincipal.getName()).isEqualTo("alice");

View File

@ -1283,9 +1283,9 @@ content into your application. Rather, pick only the properties that you need.
management.health.status.http-mapping= # Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).
management.health.status.order=DOWN, OUT_OF_SERVICE, UP, UNKNOWN # Comma-separated list of health statuses in order of severity.
# HTTP TRACING ({sc-spring-boot-actuator-autoconfigure}/web/trace/HttpTraceProperties.{sc-ext}[HttpTraceProperties])
management.httptrace.enabled=true # Whether to enable HTTP request-response tracing.
management.httptrace.include=request-headers,response-headers,cookies,errors # Items to be included in the trace.
# HTTP TRACING ({sc-spring-boot-actuator-autoconfigure}/trace/http/HttpTraceProperties.{sc-ext}[HttpTraceProperties])
management.trace.http.enabled=true # Whether to enable HTTP request-response tracing.
management.trace.http.include=request-headers,response-headers,cookies,errors # Items to be included in the trace.
# INFO CONTRIBUTORS ({sc-spring-boot-actuator-autoconfigure}/info/InfoContributorProperties.{sc-ext}[InfoContributorProperties])
management.info.build.enabled=true # Whether to enable build info.

View File

@ -1395,7 +1395,7 @@ endpoint and obtain basic information about the last 100 request-response exchan
[[production-ready-http-tracing-custom]]
=== Custom HTTP tracing
To customize the items that are included in each trace, use the
`management.httptrace.include` configuration property.
`management.trace.http.include` configuration property.
By default, an `InMemoryHttpTraceRepository` that stores traces for the last 100
request-response exchanges is used. If you need to expand the capacity, you can define