Package io.opentelemetry.instrumentation.servlet

Class ServletHttpServerTracer<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.tracer.BaseTracer

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

io.opentelemetry.instrumentation.servlet.ServletHttpServerTracer<REQUEST,RESPONSE>

public abstract class ServletHttpServerTracer<REQUEST,RESPONSE>
extends io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

Field Summary

Fields

Modifier and Type	Field	Description
static String	ASYNC_LISTENER_ATTRIBUTE
static String	ASYNC_LISTENER_RESPONSE_ATTRIBUTE

Fields inherited from class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer

CONTEXT_ATTRIBUTE, USER_AGENT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletHttpServerTracer(ServletAccessor<REQUEST,RESPONSE> accessor)

Method Summary

Modifier and Type	Method	Description
void	addUnwrappedThrowable(io.opentelemetry.context.Context context, Throwable throwable)
void	attachAsyncListener(REQUEST request)
protected void	attachServerContext(io.opentelemetry.context.Context context, REQUEST request)
protected io.opentelemetry.context.Context	customizeContext(io.opentelemetry.context.Context context, REQUEST request)
void	endExceptionally(io.opentelemetry.context.Context context, Throwable throwable, RESPONSE response, long timestamp)
Throwable	errorException(REQUEST request)
protected abstract String	errorExceptionAttributeName()
protected String	flavor(REQUEST connection, REQUEST request)
protected abstract io.opentelemetry.context.propagation.TextMapGetter<REQUEST>	getGetter()
io.opentelemetry.context.Context	getServerContext(REQUEST request)
String	getSpanName(REQUEST request)
boolean	isAsyncListenerAttached(REQUEST request)
protected String	method(REQUEST request)
boolean	needsRescoping(io.opentelemetry.context.Context attachedContext)
void	onTimeout(io.opentelemetry.context.Context context, long timeout)
protected String	peerHostIp(REQUEST connection)
protected Integer	peerPort(REQUEST connection)
protected String	requestHeader(REQUEST httpServletRequest, String name)
protected int	responseStatus(RESPONSE response)
void	setAsyncListenerResponse(REQUEST request, RESPONSE response)	Response object must be attached to a request prior to attachAsyncListener(Object) being called, as otherwise in some environments it is not possible to access response from async event in listeners.
void	setPrincipal(io.opentelemetry.context.Context context, REQUEST request)
io.opentelemetry.context.Context	startSpan(REQUEST request, String spanName, boolean servlet)
protected Throwable	unwrapThrowable(Throwable throwable)
io.opentelemetry.context.Context	updateContext(io.opentelemetry.context.Context context, REQUEST request)	When server spans are managed by app server instrumentation we need to add context path of current request to context if it isn't already added.
void	updateSpanName(REQUEST request)
protected String	url(REQUEST httpServletRequest)

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

end, end, endExceptionally, endExceptionally, getServerSpan, isRelativeUrl, onConnection, onConnectionAndRequest, onRequest, startSpan, startSpan, startSpan

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ASYNC_LISTENER_ATTRIBUTE

public static final String ASYNC_LISTENER_ATTRIBUTE

ASYNC_LISTENER_RESPONSE_ATTRIBUTE

public static final String ASYNC_LISTENER_RESPONSE_ATTRIBUTE

Constructor Detail

ServletHttpServerTracer

protected ServletHttpServerTracer(ServletAccessor<REQUEST,RESPONSE> accessor)

Method Detail

startSpan

public io.opentelemetry.context.Context startSpan(REQUEST request,
                                                  String spanName,
                                                  boolean servlet)

customizeContext

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

Overrides:

customizeContext in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

endExceptionally

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

Overrides:

endExceptionally in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

url

protected String url(REQUEST httpServletRequest)

Specified by:

url in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

getServerContext

public io.opentelemetry.context.Context getServerContext(REQUEST request)

Specified by:

getServerContext in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

attachServerContext

protected void attachServerContext(io.opentelemetry.context.Context context,
                                   REQUEST request)

Specified by:

attachServerContext in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

peerPort

protected Integer peerPort(REQUEST connection)

Specified by:

peerPort in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

peerHostIp

protected String peerHostIp(REQUEST connection)

Specified by:

peerHostIp in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

method

protected String method(REQUEST request)

Specified by:

method in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

responseStatus

protected int responseStatus(RESPONSE response)

Specified by:

responseStatus in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

getGetter

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

Specified by:

getGetter in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

setAsyncListenerResponse

public void setAsyncListenerResponse(REQUEST request,
                                     RESPONSE response)

Response object must be attached to a request prior to attachAsyncListener(Object) being called, as otherwise in some environments it is not possible to access response from async event in listeners.

attachAsyncListener

public void attachAsyncListener(REQUEST request)

isAsyncListenerAttached

public boolean isAsyncListenerAttached(REQUEST request)

addUnwrappedThrowable

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

unwrapThrowable

protected Throwable unwrapThrowable(Throwable throwable)

Overrides:

unwrapThrowable in class io.opentelemetry.instrumentation.api.tracer.BaseTracer

setPrincipal

public void setPrincipal(io.opentelemetry.context.Context context,
                         REQUEST request)

flavor

protected String flavor(REQUEST connection,
                        REQUEST request)

Specified by:

flavor in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

requestHeader

protected String requestHeader(REQUEST httpServletRequest,
                               String name)

Specified by:

requestHeader in class io.opentelemetry.instrumentation.api.tracer.HttpServerTracer<REQUEST,RESPONSE,REQUEST,REQUEST>

errorException

public Throwable errorException(REQUEST request)

errorExceptionAttributeName

protected abstract String errorExceptionAttributeName()

getSpanName

public String getSpanName(REQUEST request)

updateContext

public io.opentelemetry.context.Context updateContext(io.opentelemetry.context.Context context,
                                                      REQUEST request)

When server spans are managed by app server instrumentation we need to add context path of current request to context if it isn't already added. Servlet instrumentation adds it when it starts server span.

updateSpanName

public void updateSpanName(REQUEST request)

onTimeout

public void onTimeout(io.opentelemetry.context.Context context,
                      long timeout)

needsRescoping

public boolean needsRescoping(io.opentelemetry.context.Context attachedContext)