Package io.opentelemetry.instrumentation.api.tracer

Class HttpServerTracer<REQUEST,RESPONSE,CONNECTION,STORAGE>

java.lang.Object

io.opentelemetry.instrumentation.api.tracer.BaseTracer

io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,CONNECTION,STORAGE>

Type Parameters:

REQUEST - - The specific type for HTTP requests

RESPONSE - - The specific type for HTTP responses

CONNECTION - - The specific type of HTTP connection, used to get peer address information and HTTP flavor.

STORAGE - - Implementation specific storage type for attaching/getting the server context. Use Void if your subclass does not have an implementation specific storage need.

public abstract class HttpServerTracer<REQUEST,RESPONSE,CONNECTION,STORAGE>
extends BaseTracer

Base class for implementing Tracers for HTTP servers. It has 3 types that must be specified by subclasses:

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTEXT_ATTRIBUTE
protected static String	USER_AGENT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpServerTracer()
protected	HttpServerTracer(io.opentelemetry.api.OpenTelemetry openTelemetry)

Method Summary

Modifier and Type	Method	Description
protected abstract void	attachServerContext(io.opentelemetry.context.Context context, STORAGE storage)	Stores given context in the given request-response-loop storage in implementation specific way.
protected io.opentelemetry.context.Context	customizeContext(io.opentelemetry.context.Context context, REQUEST request)	Override in subclass to customize context that is returned by startSpan.
void	end(io.opentelemetry.context.Context context, RESPONSE response)	Convenience method.
void	end(io.opentelemetry.context.Context context, RESPONSE response, long timestamp)
void	endExceptionally(io.opentelemetry.context.Context context, Throwable throwable)	Convenience method.
void	endExceptionally(io.opentelemetry.context.Context context, Throwable throwable, RESPONSE response)	Convenience method.
void	endExceptionally(io.opentelemetry.context.Context context, Throwable throwable, RESPONSE response, long timestamp)	If response is null, the http.status_code will be set to 500 and the Span status will be set to StatusCode.ERROR.
protected abstract String	flavor(CONNECTION connection, REQUEST request)
protected abstract io.opentelemetry.context.propagation.TextMapGetter<REQUEST>	getGetter()
abstract @Nullable io.opentelemetry.context.Context	getServerContext(STORAGE storage)	Returns context stored to the given request-response-loop storage by attachServerContext(Context, Object).
io.opentelemetry.api.trace.Span	getServerSpan(STORAGE storage)
protected boolean	isRelativeUrl(String url)
protected abstract String	method(REQUEST request)
protected void	onConnection(io.opentelemetry.api.trace.SpanBuilder spanBuilder, CONNECTION connection)
protected void	onConnectionAndRequest(io.opentelemetry.api.trace.SpanBuilder spanBuilder, CONNECTION connection, REQUEST request)
protected void	onRequest(io.opentelemetry.api.trace.SpanBuilder spanBuilder, REQUEST request)
protected abstract @Nullable String	peerHostIp(CONNECTION connection)
protected abstract @Nullable Integer	peerPort(CONNECTION connection)
protected abstract @Nullable String	requestHeader(REQUEST request, String name)
protected abstract int	responseStatus(RESPONSE response)
io.opentelemetry.context.Context	startSpan(REQUEST request, CONNECTION connection, @Nullable STORAGE storage, String spanName, long startTimestamp)
io.opentelemetry.context.Context	startSpan(REQUEST request, CONNECTION connection, STORAGE storage, Method origin)
io.opentelemetry.context.Context	startSpan(REQUEST request, CONNECTION connection, STORAGE storage, String spanName)
protected abstract String	url(REQUEST request)

Methods inherited from class io.opentelemetry.instrumentation.api.tracer.BaseTracer

end, end, endExceptionally, extract, getInstrumentationName, getVersion, inject, onException, shouldStartSpan, spanBuilder, startSpan, startSpan, startSpan, unwrapThrowable, withClientSpan, withConsumerSpan, withServerSpan

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_ATTRIBUTE

public static final String CONTEXT_ATTRIBUTE

USER_AGENT

protected static final String USER_AGENT

See Also:

Constant Field Values

Constructor Detail

HttpServerTracer

protected HttpServerTracer()

HttpServerTracer

protected HttpServerTracer(io.opentelemetry.api.OpenTelemetry openTelemetry)

Method Detail

startSpan

public io.opentelemetry.context.Context startSpan(REQUEST request,
                                                  CONNECTION connection,
                                                  STORAGE storage,
                                                  Method origin)

startSpan

public io.opentelemetry.context.Context startSpan(REQUEST request,
                                                  CONNECTION connection,
                                                  STORAGE storage,
                                                  String spanName)

startSpan

public io.opentelemetry.context.Context startSpan(REQUEST request,
                                                  CONNECTION connection,
                                                  @Nullable STORAGE storage,
                                                  String spanName,
                                                  long startTimestamp)

customizeContext

protected io.opentelemetry.context.Context customizeContext(io.opentelemetry.context.Context context,
                                                            REQUEST request)

Override in subclass to customize context that is returned by startSpan.

end

public void end(io.opentelemetry.context.Context context,
                RESPONSE response)

Convenience method. Delegates to end(Context, Object, long), passing timestamp value of -1.

end

public void end(io.opentelemetry.context.Context context,
                RESPONSE response,
                long timestamp)

endExceptionally

public void endExceptionally(io.opentelemetry.context.Context context,
                             Throwable throwable)

Convenience method. Delegates to endExceptionally(Context, Throwable, Object), passing response value of null.

Overrides:

endExceptionally in class BaseTracer

See Also:

BaseTracer.onException(Context, Throwable), BaseTracer.end(Context)

endExceptionally

public void endExceptionally(io.opentelemetry.context.Context context,
                             Throwable throwable,
                             RESPONSE response)

Convenience method. Delegates to endExceptionally(Context, Throwable, Object, long), passing timestamp value of -1.

endExceptionally

public void endExceptionally(io.opentelemetry.context.Context context,
                             Throwable throwable,
                             RESPONSE response,
                             long timestamp)

If response is null, the http.status_code will be set to 500 and the Span status will be set to StatusCode.ERROR.

getServerSpan

public io.opentelemetry.api.trace.Span getServerSpan(STORAGE storage)

getServerContext

public abstract @Nullable io.opentelemetry.context.Context getServerContext(STORAGE storage)

Returns context stored to the given request-response-loop storage by attachServerContext(Context, Object).

onConnection

protected void onConnection(io.opentelemetry.api.trace.SpanBuilder spanBuilder,
                            CONNECTION connection)

onRequest

protected void onRequest(io.opentelemetry.api.trace.SpanBuilder spanBuilder,
                         REQUEST request)

onConnectionAndRequest

protected void onConnectionAndRequest(io.opentelemetry.api.trace.SpanBuilder spanBuilder,
                                      CONNECTION connection,
                                      REQUEST request)

peerPort

protected abstract @Nullable Integer peerPort(CONNECTION connection)

peerHostIp

protected abstract @Nullable String peerHostIp(CONNECTION connection)

flavor

protected abstract String flavor(CONNECTION connection,
                                 REQUEST request)

getGetter

protected abstract io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getGetter()

url

protected abstract String url(REQUEST request)

method

protected abstract String method(REQUEST request)

requestHeader

protected abstract @Nullable String requestHeader(REQUEST request,
                                                  String name)

responseStatus

protected abstract int responseStatus(RESPONSE response)

attachServerContext

protected abstract void attachServerContext(io.opentelemetry.context.Context context,
                                            STORAGE storage)

Stores given context in the given request-response-loop storage in implementation specific way.

isRelativeUrl

protected boolean isRelativeUrl(String url)