Package io.opentelemetry.javaagent.instrumentation.servlet

Class ServletHelper<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.javaagent.instrumentation.servlet.BaseServletHelper<REQUEST,RESPONSE>

io.opentelemetry.javaagent.instrumentation.servlet.ServletHelper<REQUEST,RESPONSE>

public class ServletHelper<REQUEST,RESPONSE>
extends BaseServletHelper<REQUEST,RESPONSE>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASYNC_EXCEPTION_ATTRIBUTE
static final String	CONTEXT_ATTRIBUTE

Fields inherited from class io.opentelemetry.javaagent.instrumentation.servlet.BaseServletHelper

accessor, instrumenter

Constructor Summary

Constructors

Constructor	Description
ServletHelper(io.opentelemetry.instrumentation.api.instrumenter.Instrumenter<ServletRequestContext<REQUEST>,ServletResponseContext<RESPONSE>> instrumenter, ServletAccessor<REQUEST,RESPONSE> accessor)

Method Summary

Modifier and Type	Method	Description
void	attachAsyncListener(REQUEST request)
void	end(ServletRequestContext<REQUEST> requestContext, REQUEST request, RESPONSE response, Throwable throwable, boolean topLevel, io.opentelemetry.context.Context context, io.opentelemetry.context.Scope scope)
Throwable	getAsyncException(REQUEST request)
RESPONSE	getAsyncListenerResponse(REQUEST request)
boolean	isAsyncListenerAttached(REQUEST request)
boolean	mustEndOnHandlerMethodExit(REQUEST request)	Helper method to determine whether the appserver handler/servlet service/servlet filter method that started a span must also end it, even if no error was detected.
void	recordAsyncException(REQUEST request, Throwable throwable)
void	setAsyncListenerResponse(REQUEST request, RESPONSE response)	Response object must be attached to a request prior to attachAsyncListener(ServletRequestContext) being called, as otherwise in some environments it is not possible to access response from async event in listeners.
Runnable	wrapAsyncRunnable(REQUEST request, Runnable runnable)

Methods inherited from class io.opentelemetry.javaagent.instrumentation.servlet.BaseServletHelper

addServletContextPath, captureServletAttributes, getServerContext, needsRescoping, recordException, shouldStart, start, updateContext

Methods inherited from class java.lang.Object

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

Field Details

ASYNC_EXCEPTION_ATTRIBUTE

public static final String ASYNC_EXCEPTION_ATTRIBUTE

CONTEXT_ATTRIBUTE

public static final String CONTEXT_ATTRIBUTE

Constructor Details

ServletHelper

public ServletHelper(io.opentelemetry.instrumentation.api.instrumenter.Instrumenter<ServletRequestContext<REQUEST>,ServletResponseContext<RESPONSE>> instrumenter,
 ServletAccessor<REQUEST,RESPONSE> accessor)

Method Details

end

public void end(ServletRequestContext<REQUEST> requestContext,
 REQUEST request,
 RESPONSE response,
 Throwable throwable,
 boolean topLevel,
 io.opentelemetry.context.Context context,
 io.opentelemetry.context.Scope scope)

mustEndOnHandlerMethodExit

public boolean mustEndOnHandlerMethodExit(REQUEST request)

Helper method to determine whether the appserver handler/servlet service/servlet filter method that started a span must also end it, even if no error was detected. Extracted as a separate method to avoid duplicating the comments on the logic behind this choice.

setAsyncListenerResponse

public void setAsyncListenerResponse(REQUEST request,
 RESPONSE response)

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

getAsyncListenerResponse

public RESPONSE getAsyncListenerResponse(REQUEST request)

attachAsyncListener

public void attachAsyncListener(REQUEST request)

isAsyncListenerAttached

public boolean isAsyncListenerAttached(REQUEST request)

wrapAsyncRunnable

public Runnable wrapAsyncRunnable(REQUEST request,
 Runnable runnable)

recordAsyncException

public void recordAsyncException(REQUEST request,
 Throwable throwable)

getAsyncException

public Throwable getAsyncException(REQUEST request)