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 an Instrumenter.

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

Method Summary

Modifier and Type	Method	Description
InstrumenterBuilder<REQUEST,RESPONSE>	addAttributesExtractor(AttributesExtractor<? super REQUEST,? super RESPONSE> attributesExtractor)	Adds a AttributesExtractor that will extract attributes from requests and responses.
InstrumenterBuilder<REQUEST,RESPONSE>	addAttributesExtractors(Iterable<? extends AttributesExtractor<? super REQUEST,? super RESPONSE>> attributesExtractors)	Adds AttributesExtractors that will extract attributes from requests and responses.
InstrumenterBuilder<REQUEST,RESPONSE>	addContextCustomizer(ContextCustomizer<? super REQUEST> contextCustomizer)	Adds a ContextCustomizer that will customize the context during Instrumenter.start(Context, Object).
InstrumenterBuilder<REQUEST,RESPONSE>	addOperationListener(OperationListener listener)	Adds a OperationListener that will be called when an instrumented operation starts and ends.
InstrumenterBuilder<REQUEST,RESPONSE>	addOperationMetrics(OperationMetrics factory)	Adds a OperationMetrics that will produce a OperationListener capturing the requests processing metrics.
InstrumenterBuilder<REQUEST,RESPONSE>	addSpanLinksExtractor(SpanLinksExtractor<REQUEST> spanLinksExtractor)	Adds a SpanLinksExtractor that will extract span links from requests.
Instrumenter<REQUEST,RESPONSE>	buildClientInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)	Returns a new Instrumenter which will create client spans and inject context into requests.
Instrumenter<REQUEST,RESPONSE>	buildConsumerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)	Returns a new Instrumenter which will create consumer spans and extract context from requests.
Instrumenter<REQUEST,RESPONSE>	buildInstrumenter()	Returns a new Instrumenter which will create internal spans and do no context propagation.
Instrumenter<REQUEST,RESPONSE>	buildInstrumenter(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>	buildProducerInstrumenter(io.opentelemetry.context.propagation.TextMapSetter<REQUEST> setter)	Returns a new Instrumenter which will create producer spans and inject context into requests.
Instrumenter<REQUEST,RESPONSE>	buildServerInstrumenter(io.opentelemetry.context.propagation.TextMapGetter<REQUEST> getter)	Returns a new Instrumenter which will create server spans and extract context from requests.
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 that will extract the root cause of an error thrown during request processing.
InstrumenterBuilder<REQUEST,RESPONSE>	setInstrumentationVersion(String instrumentationVersion)	Sets the instrumentation version that will be associated with all telemetry produced by this Instrumenter.
InstrumenterBuilder<REQUEST,RESPONSE>	setSchemaUrl(String schemaUrl)	Sets the OpenTelemetry schema URL that will be associated with all telemetry produced by this Instrumenter.
InstrumenterBuilder<REQUEST,RESPONSE>	setSpanStatusExtractor(SpanStatusExtractor<? super REQUEST,? super RESPONSE> spanStatusExtractor)	Sets the SpanStatusExtractor that will determine the StatusCode for a response.

Methods inherited from class java.lang.Object

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

Method Details

setInstrumentationVersion

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

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

Parameters:

instrumentationVersion - is the version of the instrumentation library, not the version of the instrumented library.

setSchemaUrl

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

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

setSpanStatusExtractor

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

Sets the SpanStatusExtractor that will determine the StatusCode for a response.

addAttributesExtractor

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

Adds a AttributesExtractor that will extract attributes from requests and responses.

addAttributesExtractors

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

Adds AttributesExtractors that will extract attributes from requests and responses.

addSpanLinksExtractor

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

Adds a SpanLinksExtractor that will extract span links from requests.

addContextCustomizer

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

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

addOperationListener

@CanIgnoreReturnValue
public InstrumenterBuilder<REQUEST,RESPONSE> addOperationListener(OperationListener listener)

Adds a OperationListener that will be called when an instrumented operation starts and ends.

addOperationMetrics

@CanIgnoreReturnValue
public InstrumenterBuilder<REQUEST,RESPONSE> addOperationMetrics(OperationMetrics factory)

Adds a OperationMetrics that will produce a OperationListener capturing the requests processing metrics.

setErrorCauseExtractor

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

Sets the ErrorCauseExtractor that will extract the root cause of an error thrown during request processing.

setEnabled

@CanIgnoreReturnValue
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.

buildClientInstrumenter

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

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

buildServerInstrumenter

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

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

buildProducerInstrumenter

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

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

buildConsumerInstrumenter

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

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

buildInstrumenter

public Instrumenter<REQUEST,RESPONSE> buildInstrumenter()

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

buildInstrumenter

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

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