Package io.opentelemetry.instrumentation.api.tracer

Class HttpClientTracer<REQUEST,CARRIER,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.tracer.BaseTracer

io.opentelemetry.instrumentation.api.tracer.HttpClientTracer<REQUEST,CARRIER,RESPONSE>

public abstract class HttpClientTracer<REQUEST,CARRIER,RESPONSE>
extends BaseTracer

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SPAN_NAME
protected NetPeerAttributes	netPeerAttributes
protected static String	USER_AGENT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpClientTracer(io.opentelemetry.api.OpenTelemetry openTelemetry, NetPeerAttributes netPeerAttributes)
protected	HttpClientTracer(NetPeerAttributes netPeerAttributes)

Method Summary

Modifier and Type	Method	Description
void	end(io.opentelemetry.context.Context context, RESPONSE response)
void	end(io.opentelemetry.context.Context context, RESPONSE response, long endTimeNanos)
void	endExceptionally(io.opentelemetry.context.Context context, RESPONSE response, Throwable throwable)
void	endExceptionally(io.opentelemetry.context.Context context, RESPONSE response, Throwable throwable, long endTimeNanos)
void	endMaybeExceptionally(io.opentelemetry.context.Context context, RESPONSE response, @Nullable Throwable throwable)
protected @Nullable String	flavor(REQUEST request)
protected abstract io.opentelemetry.context.propagation.TextMapSetter<CARRIER>	getSetter()
protected void	inject(io.opentelemetry.context.Context context, CARRIER carrier)
protected abstract String	method(REQUEST request)
protected void	onRequest(io.opentelemetry.api.trace.SpanBuilder spanBuilder, REQUEST request)
protected void	onRequest(io.opentelemetry.api.trace.Span span, REQUEST request)	This method should only be used when the request is not yet available when startSpan(io.opentelemetry.context.Context, REQUEST, CARRIER) is called.
protected void	onResponse(io.opentelemetry.api.trace.Span span, RESPONSE response)
protected abstract @Nullable String	requestHeader(REQUEST request, String name)
protected abstract @Nullable String	responseHeader(RESPONSE response, String name)
boolean	shouldStartSpan(io.opentelemetry.context.Context parentContext)
protected String	spanNameForRequest(REQUEST request)
io.opentelemetry.context.Context	startSpan(io.opentelemetry.api.trace.SpanKind kind, io.opentelemetry.context.Context parentContext, REQUEST request, CARRIER carrier, long startTimeNanos)
io.opentelemetry.context.Context	startSpan(io.opentelemetry.context.Context parentContext, REQUEST request, CARRIER carrier)
io.opentelemetry.context.Context	startSpan(io.opentelemetry.context.Context parentContext, REQUEST request, CARRIER carrier, long startTimeNanos)
protected abstract @Nullable Integer	status(RESPONSE response)
protected abstract @Nullable URI	url(REQUEST request)

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

end, end, endExceptionally, 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

DEFAULT_SPAN_NAME

public static final String DEFAULT_SPAN_NAME

See Also:

Constant Field Values

USER_AGENT

protected static final String USER_AGENT

See Also:

Constant Field Values

netPeerAttributes

protected final NetPeerAttributes netPeerAttributes

Constructor Detail

HttpClientTracer

protected HttpClientTracer(NetPeerAttributes netPeerAttributes)

HttpClientTracer

protected HttpClientTracer(io.opentelemetry.api.OpenTelemetry openTelemetry,
                           NetPeerAttributes netPeerAttributes)

Method Detail

method

protected abstract String method(REQUEST request)

url

protected abstract @Nullable URI url(REQUEST request)
                              throws URISyntaxException

Throws:

URISyntaxException

flavor

protected @Nullable String flavor(REQUEST request)

status

protected abstract @Nullable Integer status(RESPONSE response)

requestHeader

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

responseHeader

protected abstract @Nullable String responseHeader(RESPONSE response,
                                                   String name)

getSetter

protected abstract io.opentelemetry.context.propagation.TextMapSetter<CARRIER> getSetter()

shouldStartSpan

public boolean shouldStartSpan(io.opentelemetry.context.Context parentContext)

startSpan

public io.opentelemetry.context.Context startSpan(io.opentelemetry.context.Context parentContext,
                                                  REQUEST request,
                                                  CARRIER carrier)

startSpan

public io.opentelemetry.context.Context startSpan(io.opentelemetry.api.trace.SpanKind kind,
                                                  io.opentelemetry.context.Context parentContext,
                                                  REQUEST request,
                                                  CARRIER carrier,
                                                  long startTimeNanos)

startSpan

public io.opentelemetry.context.Context startSpan(io.opentelemetry.context.Context parentContext,
                                                  REQUEST request,
                                                  CARRIER carrier,
                                                  long startTimeNanos)

inject

protected void inject(io.opentelemetry.context.Context context,
                      CARRIER carrier)

end

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

end

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

endExceptionally

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

endExceptionally

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

endMaybeExceptionally

public void endMaybeExceptionally(io.opentelemetry.context.Context context,
                                  RESPONSE response,
                                  @Nullable Throwable throwable)

onRequest

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

onRequest

protected void onRequest(io.opentelemetry.api.trace.Span span,
                         REQUEST request)

This method should only be used when the request is not yet available when startSpan(io.opentelemetry.context.Context, REQUEST, CARRIER) is called. Otherwise onRequest(SpanBuilder, Object) should be used.

onResponse

protected void onResponse(io.opentelemetry.api.trace.Span span,
                          RESPONSE response)

spanNameForRequest

protected String spanNameForRequest(REQUEST request)