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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
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)
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)

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

end, end, endExceptionally, extract, inject, onException, shouldStartSpan, spanNameForClass, spanNameForMethod, spanNameForMethod, spanNameForMethod, startSpan, startSpan, startSpan

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_ATTRIBUTE

public static final String CONTEXT_ATTRIBUTE

Constructor Detail

HttpServerTracer

public HttpServerTracer()

HttpServerTracer

public 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)

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).