Package io.honeycomb.beeline.tracing.propagation

Class HttpServerPropagator

java.lang.Object

io.honeycomb.beeline.tracing.propagation.HttpServerPropagator

public class HttpServerPropagator
extends Object

Provides straightforward instrumentation of an an HTTP server, while also adding a standardized set of span fields.

Example instrumentation for synchronous server code:

 HttpServerRequestAdapter adaptedHttpRequest = new HttpServerRequestAdapter(actualHttpRequest);
 HttpServerResponseAdapter adaptedHttpResponse = null;
 Throwable error = null;
 Span span = serverPropagator.startPropagation(adaptedHttpRequest);
 try {
   actualHttpResponse = doServerWork(actualHttpRequest);
   adaptedHttpResponse = new HttpServerResponseAdapter(actualHttpResponse);
 } catch (Exception ex) {
   error = ex;
   throw ex;
 } finally {
   serverPropagator.endPropagation(adaptedHttpResponse, error, span);
 }
 

The API is based on Brave's HTTP utilities under brave.http.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OPERATION_TYPE_HTTP_SERVER

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpServerPropagator(Beeline beeline, String serviceName, Function<HttpServerRequestAdapter,String> requestToSpanName)	Create an HttpServerPropagator for tracing requests received by an HTTP server.
protected	HttpServerPropagator(String serviceName, Function<HttpServerRequestAdapter,String> requestToSpanName, HttpServerRequestSpanCustomizer spanCustomizer, PropagationCodec<String> propagationCodec, Beeline beeline)

Method Summary

Modifier and Type	Method	Description
void	endPropagation(HttpServerResponseAdapter httpResponse, Throwable error, Span span)	Adds standard span fields based on data in the HTTP response or the error.
Span	startPropagation(HttpServerRequestAdapter httpRequest)	Creates a root span for this HTTP server call and adds the standardized fields to it.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_TYPE_HTTP_SERVER

public static final String OPERATION_TYPE_HTTP_SERVER

See Also:

Constant Field Values

Constructor Detail

HttpServerPropagator

public HttpServerPropagator(Beeline beeline,
                            String serviceName,
                            Function<HttpServerRequestAdapter,String> requestToSpanName)

Create an HttpServerPropagator for tracing requests received by an HTTP server.

requestToSpanName allows you to dynamically name the HTTP server span such that the name reflects the operation, e.g. based on HTTP method or request path used.

Parameters:

beeline - the beeline

serviceName - the service name

requestToSpanName - a function from an HTTP request to a span name

HttpServerPropagator

protected HttpServerPropagator(String serviceName,
                               Function<HttpServerRequestAdapter,String> requestToSpanName,
                               HttpServerRequestSpanCustomizer spanCustomizer,
                               PropagationCodec<String> propagationCodec,
                               Beeline beeline)

Method Detail

startPropagation

public Span startPropagation(HttpServerRequestAdapter httpRequest)

Creates a root span for this HTTP server call and adds the standardized fields to it.

Parameters:

httpRequest - the adapted HTTP request

Returns:

the span

endPropagation

public void endPropagation(HttpServerResponseAdapter httpResponse,
                           Throwable error,
                           Span span)

Adds standard span fields based on data in the HTTP response or the error. Closes the HTTP server span.

The httpResponse and the error are both allowed to be null.

Parameters:

httpResponse - the adapted HTTP response, may be null

error - an error that was thrown when the HTTP server was processing the HTTP request, may be null

span - the span for the HTTP server call