-
Notifications
You must be signed in to change notification settings - Fork 783
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue 424 - Documentation for adding trace/span headers to http respo…
- Loading branch information
1 parent
56048b1
commit 8437bef
Showing
3 changed files
with
174 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
159 changes: 159 additions & 0 deletions
159
...g/springframework/cloud/sleuth/instrument/web/TraceCustomFilterResponseInjectorTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| * Copyright 2013-2016 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.cloud.sleuth.instrument.web; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.URI; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import javax.servlet.FilterChain; | ||
| import javax.servlet.ServletException; | ||
| import javax.servlet.ServletRequest; | ||
| import javax.servlet.ServletResponse; | ||
| import javax.servlet.http.HttpServletResponse; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.boot.autoconfigure.EnableAutoConfiguration; | ||
| import org.springframework.boot.context.embedded.EmbeddedServletContainerInitializedEvent; | ||
| import org.springframework.boot.test.SpringApplicationConfiguration; | ||
| import org.springframework.boot.test.WebIntegrationTest; | ||
| import org.springframework.cloud.sleuth.Span; | ||
| import org.springframework.cloud.sleuth.SpanInjector; | ||
| import org.springframework.cloud.sleuth.Tracer; | ||
| import org.springframework.context.ApplicationListener; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.http.RequestEntity; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.test.annotation.DirtiesContext; | ||
| import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; | ||
| import org.springframework.web.bind.annotation.RequestHeader; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
| import org.springframework.web.client.RestTemplate; | ||
| import org.springframework.web.filter.GenericFilterBean; | ||
|
|
||
| import static org.assertj.core.api.BDDAssertions.then; | ||
|
|
||
| @RunWith(SpringJUnit4ClassRunner.class) | ||
| @SpringApplicationConfiguration(TraceCustomFilterResponseInjectorTests.Config.class) | ||
| @WebIntegrationTest(randomPort = true) | ||
| @DirtiesContext | ||
| public class TraceCustomFilterResponseInjectorTests { | ||
| @Autowired RestTemplate restTemplate; | ||
| @Autowired Config config; | ||
| @Autowired CustomRestController customRestController; | ||
|
|
||
|
|
||
| @Test | ||
| @SuppressWarnings("unchecked") | ||
| public void should_inject_trace_and_span_ids_in_response_headers() { | ||
| RequestEntity<?> requestEntity = RequestEntity | ||
| .get(URI.create("http://localhost:" + this.config.port + "/headers")) | ||
| .build(); | ||
|
|
||
| @SuppressWarnings("rawtypes") | ||
| ResponseEntity<Map> responseEntity = this.restTemplate.exchange(requestEntity, Map.class); | ||
|
|
||
| then(responseEntity.getHeaders()) | ||
| .containsKeys(Span.TRACE_ID_NAME, Span.SPAN_ID_NAME) | ||
| .as("Trace headers must be present in response headers"); | ||
| } | ||
|
|
||
| @Configuration | ||
| @EnableAutoConfiguration | ||
| static class Config | ||
| implements ApplicationListener<EmbeddedServletContainerInitializedEvent> { | ||
| int port; | ||
|
|
||
| // tag::configuration[] | ||
| @Bean | ||
| SpanInjector<HttpServletResponse> customHttpServletResponseSpanInjector() { | ||
| return new CustomHttpServletResponseSpanInjector(); | ||
| } | ||
|
|
||
| @Bean | ||
| HttpResponseInjectingTraceFilter responseInjectingTraceFilter(Tracer tracer) { | ||
| return new HttpResponseInjectingTraceFilter(tracer, customHttpServletResponseSpanInjector()); | ||
| } | ||
| // end::configuration[] | ||
|
|
||
| @Override | ||
| public void onApplicationEvent(EmbeddedServletContainerInitializedEvent event) { | ||
| this.port = event.getEmbeddedServletContainer().getPort(); | ||
| } | ||
|
|
||
| @Bean | ||
| public RestTemplate restTemplate() { | ||
| return new RestTemplate(); | ||
| } | ||
|
|
||
| @Bean | ||
| CustomRestController customRestController() { | ||
| return new CustomRestController(); | ||
| } | ||
|
|
||
|
|
||
| } | ||
|
|
||
| // tag::injector[] | ||
| static class CustomHttpServletResponseSpanInjector | ||
| implements SpanInjector<HttpServletResponse> { | ||
|
|
||
| @Override | ||
| public void inject(Span span, HttpServletResponse carrier) { | ||
| carrier.addHeader(Span.TRACE_ID_NAME, Span.idToHex(span.getTraceId())); | ||
| carrier.addHeader(Span.SPAN_ID_NAME, Span.idToHex(span.getSpanId())); | ||
| } | ||
| } | ||
|
|
||
| static class HttpResponseInjectingTraceFilter extends GenericFilterBean { | ||
|
|
||
| private final Tracer tracer; | ||
| private final SpanInjector<HttpServletResponse> spanInjector; | ||
|
|
||
| public HttpResponseInjectingTraceFilter(Tracer tracer, SpanInjector<HttpServletResponse> spanInjector) { | ||
| this.tracer = tracer; | ||
| this.spanInjector = spanInjector; | ||
| } | ||
|
|
||
| @Override | ||
| public void doFilter(ServletRequest request, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException { | ||
| HttpServletResponse response = (HttpServletResponse) servletResponse; | ||
| Span currentSpan = this.tracer.getCurrentSpan(); | ||
| this.spanInjector.inject(currentSpan, response); | ||
| filterChain.doFilter(request, response); | ||
| } | ||
| } | ||
| // end::injector[] | ||
|
|
||
| @RestController | ||
| static class CustomRestController { | ||
|
|
||
| @RequestMapping("/headers") | ||
| public Map<String, String> headers(@RequestHeader HttpHeaders headers) { | ||
| Map<String, String> map = new HashMap<>(); | ||
| for (String key : headers.keySet()) { | ||
| map.put(key, headers.getFirst(key)); | ||
| } | ||
| return map; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters