org.springframework.cloud.sleuth.instrument.web.client

Class TraceAsyncClientHttpRequestFactoryWrapper

java.lang.Object

org.springframework.cloud.sleuth.instrument.web.client.TraceAsyncClientHttpRequestFactoryWrapper

All Implemented Interfaces:

org.springframework.http.client.AsyncClientHttpRequestFactory, org.springframework.http.client.ClientHttpRequestFactory

public class TraceAsyncClientHttpRequestFactoryWrapper
extends Object
implements org.springframework.http.client.ClientHttpRequestFactory, org.springframework.http.client.AsyncClientHttpRequestFactory

Wrapper that adds trace related headers to the created AsyncClientHttpRequest and to the ClientHttpRequest

Since:

1.0.0

Author:

Marcin Grzejszczak, Spencer Gibb

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpTraceKeysInjector	keysInjector
protected static org.apache.commons.logging.Log	log
protected HttpSpanInjector	spanInjector
protected Tracer	tracer

Constructor Summary

Constructors

Constructor and Description
TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer, HttpSpanInjector spanInjector, org.springframework.http.client.AsyncClientHttpRequestFactory asyncDelegate, org.springframework.http.client.ClientHttpRequestFactory syncDelegate, HttpTraceKeysInjector httpTraceKeysInjector)
TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer, HttpSpanInjector spanInjector, org.springframework.http.client.AsyncClientHttpRequestFactory asyncDelegate, HttpTraceKeysInjector httpTraceKeysInjector) According to the JavaDocs all Spring AsyncClientHttpRequestFactory implement the ClientHttpRequestFactory interface.
TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer, HttpSpanInjector spanInjector, HttpTraceKeysInjector httpTraceKeysInjector) Default implementation that creates a SimpleClientHttpRequestFactory that has a wrapped task executor via the TraceAsyncListenableTaskExecutor

Method Summary

Modifier and Type	Method and Description
protected void	addRequestTags(org.springframework.http.HttpRequest request) Adds HTTP tags to the client side span
org.springframework.http.client.AsyncClientHttpRequest	createAsyncRequest(URI uri, org.springframework.http.HttpMethod httpMethod)
org.springframework.http.client.ClientHttpRequest	createRequest(URI uri, org.springframework.http.HttpMethod httpMethod)
protected Span	currentSpan()
void	finish() Close the current span and log the client received event
protected boolean	isTracing()
protected void	publishStartEvent(org.springframework.http.HttpRequest request) Enriches the request with proper headers and publishes the client sent event

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

tracer

protected final Tracer tracer

spanInjector

protected final HttpSpanInjector spanInjector

keysInjector

protected final HttpTraceKeysInjector keysInjector

Constructor Detail

TraceAsyncClientHttpRequestFactoryWrapper

public TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer,
                                                 HttpSpanInjector spanInjector,
                                                 org.springframework.http.client.AsyncClientHttpRequestFactory asyncDelegate,
                                                 HttpTraceKeysInjector httpTraceKeysInjector)

According to the JavaDocs all Spring AsyncClientHttpRequestFactory implement the ClientHttpRequestFactory interface. In case that it's not true we're setting the SimpleClientHttpRequestFactory as a default for sync request processing.

See Also:

AsyncRestTemplate.AsyncRestTemplate(AsyncClientHttpRequestFactory)

TraceAsyncClientHttpRequestFactoryWrapper

public TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer,
                                                 HttpSpanInjector spanInjector,
                                                 HttpTraceKeysInjector httpTraceKeysInjector)

Default implementation that creates a SimpleClientHttpRequestFactory that has a wrapped task executor via the TraceAsyncListenableTaskExecutor

TraceAsyncClientHttpRequestFactoryWrapper

public TraceAsyncClientHttpRequestFactoryWrapper(Tracer tracer,
                                                 HttpSpanInjector spanInjector,
                                                 org.springframework.http.client.AsyncClientHttpRequestFactory asyncDelegate,
                                                 org.springframework.http.client.ClientHttpRequestFactory syncDelegate,
                                                 HttpTraceKeysInjector httpTraceKeysInjector)

Method Detail

createAsyncRequest

public org.springframework.http.client.AsyncClientHttpRequest createAsyncRequest(URI uri,
                                                                                 org.springframework.http.HttpMethod httpMethod)
                                                                          throws IOException

Specified by:

createAsyncRequest in interface org.springframework.http.client.AsyncClientHttpRequestFactory

Throws:

IOException

createRequest

public org.springframework.http.client.ClientHttpRequest createRequest(URI uri,
                                                                       org.springframework.http.HttpMethod httpMethod)
                                                                throws IOException

Specified by:

createRequest in interface org.springframework.http.client.ClientHttpRequestFactory

Throws:

IOException

publishStartEvent

protected void publishStartEvent(org.springframework.http.HttpRequest request)

Enriches the request with proper headers and publishes the client sent event

addRequestTags

protected void addRequestTags(org.springframework.http.HttpRequest request)

Adds HTTP tags to the client side span

finish

public void finish()

Close the current span and log the client received event

currentSpan

protected Span currentSpan()

isTracing

protected boolean isTracing()