com.atlassian.confluence.util.zipkin.api

Interface ZipkinHttpClientInterceptorManager

@Internal
public interface ZipkinHttpClientInterceptorManager

Manager for obtaining the HttpClient interceptors required for handling Zipkin communications. This is a placeholder until a final abstraction is defined. It is open to be removed or changed without notice.

Since:

5.10

Method Summary

Modifier and Type	Method and Description
@NonNull Iterable<org.apache.http.HttpRequestInterceptor>	requestInterceptors(String serviceName) Returns the HttpRequestInterceptor's for an outbound connection.
@NonNull Iterable<org.apache.http.HttpRequestInterceptor>	requestInterceptors(String serviceName, BiFunction<URI,String,String> spanNameGenerator) Returns the HttpRequestInterceptor's for an outbound connection, that generates the span name using the supplied function.
@NonNull Iterable<org.apache.http.HttpResponseInterceptor>	responseInterceptors() Returns the HttpResponseInterceptor's for an outbound connection.

Method Detail

requestInterceptors

@NonNull Iterable<org.apache.http.HttpRequestInterceptor> requestInterceptors(String serviceName)

Returns the HttpRequestInterceptor's for an outbound connection. The span name will be computed using the system default algorithm.

Parameters:

serviceName - the name of the service being invoked

Returns:

the request interceptors

requestInterceptors

@NonNull Iterable<org.apache.http.HttpRequestInterceptor> requestInterceptors(String serviceName,
                                                                              BiFunction<URI,String,String> spanNameGenerator)

Returns the HttpRequestInterceptor's for an outbound connection, that generates the span name using the supplied function. NOTE:

Parameters:

serviceName - the name of the service being invoked

spanNameGenerator - function for generating a span name for the invocation. The function is passed the URI for the outbound connection, and the http method (i.e. GET, POST, etc)

Returns:

the request interceptors

responseInterceptors

@NonNull Iterable<org.apache.http.HttpResponseInterceptor> responseInterceptors()

Returns the HttpResponseInterceptor's for an outbound connection.

Returns:

the response interceptors