Package io.opentelemetry.instrumentation.api.instrumenter

Class InstrumenterBuilder<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder<REQUEST,RESPONSE>

public final class InstrumenterBuilder<REQUEST,RESPONSE>
extends Object

A builder of Instrumenter. Instrumentation libraries should generally expose their own builder with controls that are appropriate for that library and delegate to this to create the Instrumenter.

Method Summary

Modifier and Type	Method	Description
InstrumenterBuilder<REQUEST,RESPONSE>	addAttributesExtractor(AttributesExtractor<? super REQUEST,? super RESPONSE> attributesExtractor)	Adds a AttributesExtractor to extract attributes from requests and responses.
final InstrumenterBuilder<REQUEST,RESPONSE>	addAttributesExtractors(AttributesExtractor<? super REQUEST,? super RESPONSE>... attributesExtractors)	Adds AttributesExtractors to extract attributes from requests and responses.
InstrumenterBuilder<REQUEST,RESPONSE>	addAttributesExtractors(Iterable<? extends AttributesExtractor<? super REQUEST,? super RESPONSE>> attributesExtractors)	Adds AttributesExtractors to extract attributes from requests and responses.
InstrumenterBuilder<REQUEST,RESPONSE>	addContextCustomizer(ContextCustomizer<? super REQUEST> contextCustomizer)	Adds a ContextCustomizer to customize the context during Instrumenter.start(Context, Object).
InstrumenterBuilder<REQUEST,RESPONSE>	addRequestListener(RequestListener listener)	Adds a RequestListener which will be called for request start and end.
InstrumenterBuilder<REQUEST,RESPONSE>	addRequestMetrics(RequestMetrics factory)	Adds a RequestMetrics whose metrics will be recorded for request start and end.
InstrumenterBuilder<REQUEST,RESPONSE>	addSpanLinksExtractor(SpanLinksExtractor<REQUEST> spanLinksExtractor)	Adds a SpanLinksExtractor to extract span links from requests.
Instrumenter<REQUEST,RESPONSE>	newClientInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)	Returns a new Instrumenter which will create client spans and inject context into requests.
Instrumenter<REQUEST,RESPONSE>	newConsumerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)	Returns a new Instrumenter which will create consumer spans and extract context from requests.
Instrumenter<REQUEST,RESPONSE>	newInstrumenter()	Returns a new Instrumenter which will create internal spans and do no context propagation.
Instrumenter<REQUEST,RESPONSE>	newInstrumenter(SpanKindExtractor<? super REQUEST> spanKindExtractor)	Returns a new Instrumenter which will create spans with kind determined by the passed spanKindExtractor and do no context propagation.
Instrumenter<REQUEST,RESPONSE>	newProducerInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)	Returns a new Instrumenter which will create producer spans and inject context into requests.
Instrumenter<REQUEST,RESPONSE>	newServerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)	Returns a new Instrumenter which will create server spans and extract context from requests.
InstrumenterBuilder<REQUEST,RESPONSE>	setDisabled(boolean disabled)	Deprecated. Use setEnabled(boolean) instead.
InstrumenterBuilder<REQUEST,RESPONSE>	setEnabled(boolean enabled)	Allows enabling/disabling the Instrumenter based on the enabled value passed as parameter.
InstrumenterBuilder<REQUEST,RESPONSE>	setErrorCauseExtractor(ErrorCauseExtractor errorCauseExtractor)	Sets the ErrorCauseExtractor to extract the root cause from an exception handling the request.
InstrumenterBuilder<REQUEST,RESPONSE>	setInstrumentationVersion(String instrumentationVersion)	Sets the instrumentation version that'll be associated with all telemetry produced by this Instrumenter.
InstrumenterBuilder<REQUEST,RESPONSE>	setSchemaUrl(String schemaUrl)	Sets the OpenTelemetry schema URL that'll be associated with all telemetry produced by this Instrumenter.
InstrumenterBuilder<REQUEST,RESPONSE>	setSpanStatusExtractor(SpanStatusExtractor<? super REQUEST,? super RESPONSE> spanStatusExtractor)	Sets the SpanStatusExtractor to use to determine the StatusCode for a response.
InstrumenterBuilder<REQUEST,RESPONSE>	setTimeExtractor(TimeExtractor<REQUEST,RESPONSE> timeExtractor)	Sets the TimeExtractor to extract the timestamp marking the start and end of processing.

Methods inherited from class java.lang.Object

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

Method Details

setInstrumentationVersion

public InstrumenterBuilder<REQUEST,RESPONSE> setInstrumentationVersion(String instrumentationVersion)

Sets the instrumentation version that'll be associated with all telemetry produced by this Instrumenter.

Parameters:

instrumentationVersion - is the version of the instrumentation library, not the version of the instrument*ed* library.

setSchemaUrl

public InstrumenterBuilder<REQUEST,RESPONSE> setSchemaUrl(String schemaUrl)

Sets the OpenTelemetry schema URL that'll be associated with all telemetry produced by this Instrumenter.

setSpanStatusExtractor

public InstrumenterBuilder<REQUEST,RESPONSE> setSpanStatusExtractor(SpanStatusExtractor<? super REQUEST,? super RESPONSE> spanStatusExtractor)

Sets the SpanStatusExtractor to use to determine the StatusCode for a response.

addAttributesExtractor

public InstrumenterBuilder<REQUEST,RESPONSE> addAttributesExtractor(AttributesExtractor<? super REQUEST,? super RESPONSE> attributesExtractor)

Adds a AttributesExtractor to extract attributes from requests and responses.

addAttributesExtractors

public InstrumenterBuilder<REQUEST,RESPONSE> addAttributesExtractors(Iterable<? extends AttributesExtractor<? super REQUEST,? super RESPONSE>> attributesExtractors)

Adds AttributesExtractors to extract attributes from requests and responses.

addAttributesExtractors

@SafeVarargs
public final InstrumenterBuilder<REQUEST,RESPONSE> addAttributesExtractors(AttributesExtractor<? super REQUEST,? super RESPONSE>... attributesExtractors)

Adds AttributesExtractors to extract attributes from requests and responses.

addSpanLinksExtractor

public InstrumenterBuilder<REQUEST,RESPONSE> addSpanLinksExtractor(SpanLinksExtractor<REQUEST> spanLinksExtractor)

Adds a SpanLinksExtractor to extract span links from requests.

addContextCustomizer

public InstrumenterBuilder<REQUEST,RESPONSE> addContextCustomizer(ContextCustomizer<? super REQUEST> contextCustomizer)

Adds a ContextCustomizer to customize the context during Instrumenter.start(Context, Object).

addRequestListener

public InstrumenterBuilder<REQUEST,RESPONSE> addRequestListener(RequestListener listener)

Adds a RequestListener which will be called for request start and end.

addRequestMetrics

public InstrumenterBuilder<REQUEST,RESPONSE> addRequestMetrics(RequestMetrics factory)

Adds a RequestMetrics whose metrics will be recorded for request start and end.

setErrorCauseExtractor

public InstrumenterBuilder<REQUEST,RESPONSE> setErrorCauseExtractor(ErrorCauseExtractor errorCauseExtractor)

Sets the ErrorCauseExtractor to extract the root cause from an exception handling the request.

setTimeExtractor

public InstrumenterBuilder<REQUEST,RESPONSE> setTimeExtractor(TimeExtractor<REQUEST,RESPONSE> timeExtractor)

Sets the TimeExtractor to extract the timestamp marking the start and end of processing. If unset, the constructed instrumenter will defer determining start and end timestamps to the OpenTelemetry SDK.

Note: if metrics are generated by the Instrumenter, the start and end times from the TimeExtractor will be used to generate any duration metrics, but the internal metric timestamp (when it occurred) will always be stamped with "now" when the metric is recorded (i.e. there is no way to back date a metric recording).

setEnabled

public InstrumenterBuilder<REQUEST,RESPONSE> setEnabled(boolean enabled)

Allows enabling/disabling the Instrumenter based on the enabled value passed as parameter. All instrumenters are enabled by default.

setDisabled

@Deprecated
public InstrumenterBuilder<REQUEST,RESPONSE> setDisabled(boolean disabled)

Deprecated.

Use setEnabled(boolean) instead.

Allows to disable the Instrumenter.

newClientInstrumenter

public Instrumenter<REQUEST,RESPONSE> newClientInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)

Returns a new Instrumenter which will create client spans and inject context into requests.

newServerInstrumenter

public Instrumenter<REQUEST,RESPONSE> newServerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)

Returns a new Instrumenter which will create server spans and extract context from requests.

newProducerInstrumenter

public Instrumenter<REQUEST,RESPONSE> newProducerInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)

Returns a new Instrumenter which will create producer spans and inject context into requests.

newConsumerInstrumenter

public Instrumenter<REQUEST,RESPONSE> newConsumerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)

Returns a new Instrumenter which will create consumer spans and extract context from requests.

newInstrumenter

public Instrumenter<REQUEST,RESPONSE> newInstrumenter()

Returns a new Instrumenter which will create internal spans and do no context propagation.

newInstrumenter

public Instrumenter<REQUEST,RESPONSE> newInstrumenter(SpanKindExtractor<? super REQUEST> spanKindExtractor)

Returns a new Instrumenter which will create spans with kind determined by the passed spanKindExtractor and do no context propagation.