Package io.opentelemetry.instrumentation.api.internal

Class Experimental

java.lang.Object

io.opentelemetry.instrumentation.api.internal.Experimental

public final class Experimental
extends Object

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Method Summary

Modifier and Type	Method	Description
static <REQUEST, RESPONSE> void	addOperationListenerAttributesExtractor(InstrumenterBuilder<REQUEST,RESPONSE> builder, AttributesExtractor<? super REQUEST,? super RESPONSE> attributesExtractor)	Add an AttributesExtractor to the given InstrumenterBuilder that provides attributes that are passed to the OperationListeners.
static <REQUEST, RESPONSE> void	internalAddOperationListenerAttributesExtractor(BiConsumer<InstrumenterBuilder<REQUEST,RESPONSE>,AttributesExtractor<? super REQUEST,? super RESPONSE>> operationListenerAttributesExtractorAdder)
static void	internalSetClientSensitiveQueryParameters(BiConsumer<HttpClientAttributesExtractorBuilder<?,?>,Set<String>> clientSensitiveQueryParameters)
static <REQUEST> void	internalSetExceptionEventExtractor(BiConsumer<InstrumenterBuilder<REQUEST,?>,InternalExceptionEventExtractor<? super REQUEST>> exceptionEventExtractorSetter)
static void	internalSetServerSensitiveQueryParameters(BiConsumer<HttpServerAttributesExtractorBuilder<?,?>,Set<String>> serverSensitiveQueryParameters)
static void	internalSetSpanSuppressionStrategy(BiConsumer<InstrumenterBuilder<?,?>,String> spanSuppressionStrategySetter)
static <REQUEST> void	internalSetUrlTemplateExtractor(BiConsumer<HttpSpanNameExtractorBuilder<REQUEST>,Function<REQUEST,String>> urlTemplateExtractorSetter)
static <REQUEST> void	setExceptionEventExtractor(InstrumenterBuilder<REQUEST,?> builder, InternalExceptionEventExtractor<? super REQUEST> exceptionEventExtractor)	Sets the InternalExceptionEventExtractor that will determine the exception event name and severity.
static void	setSensitiveQueryParameters(HttpClientAttributesExtractorBuilder<?,?> builder, Set<String> sensitiveQueryParameters)
static void	setSensitiveQueryParameters(HttpServerAttributesExtractorBuilder<?,?> builder, Set<String> sensitiveQueryParameters)
static void	setSpanSuppressionStrategy(InstrumenterBuilder<?,?> builder, String spanSuppressionStrategy)	Sets the span suppression strategy.
static <REQUEST> void	setUrlTemplateExtractor(HttpSpanNameExtractorBuilder<REQUEST> builder, Function<REQUEST,String> urlTemplateExtractor)

Methods inherited from class java.lang.Object

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

Method Details

setSensitiveQueryParameters

public static void setSensitiveQueryParameters(HttpClientAttributesExtractorBuilder<?,?> builder,
 Set<String> sensitiveQueryParameters)

setSensitiveQueryParameters

public static void setSensitiveQueryParameters(HttpServerAttributesExtractorBuilder<?,?> builder,
 Set<String> sensitiveQueryParameters)

internalSetClientSensitiveQueryParameters

public static void internalSetClientSensitiveQueryParameters(BiConsumer<HttpClientAttributesExtractorBuilder<?,?>,Set<String>> clientSensitiveQueryParameters)

internalSetServerSensitiveQueryParameters

public static void internalSetServerSensitiveQueryParameters(BiConsumer<HttpServerAttributesExtractorBuilder<?,?>,Set<String>> serverSensitiveQueryParameters)

setUrlTemplateExtractor

public static <REQUEST> void setUrlTemplateExtractor(HttpSpanNameExtractorBuilder<REQUEST> builder,
 Function<REQUEST,String> urlTemplateExtractor)

internalSetUrlTemplateExtractor

public static <REQUEST> void internalSetUrlTemplateExtractor(BiConsumer<HttpSpanNameExtractorBuilder<REQUEST>,Function<REQUEST,String>> urlTemplateExtractorSetter)

addOperationListenerAttributesExtractor

public static <REQUEST,
RESPONSE> void addOperationListenerAttributesExtractor(InstrumenterBuilder<REQUEST,RESPONSE> builder,
 AttributesExtractor<? super REQUEST,? super RESPONSE> attributesExtractor)

Add an AttributesExtractor to the given InstrumenterBuilder that provides attributes that are passed to the OperationListeners. This can be used to add attributes to the metrics without adding them to the span. To add attributes to the span use InstrumenterBuilder.addAttributesExtractor(AttributesExtractor).

internalAddOperationListenerAttributesExtractor

public static <REQUEST,
RESPONSE> void internalAddOperationListenerAttributesExtractor(BiConsumer<InstrumenterBuilder<REQUEST,RESPONSE>,AttributesExtractor<? super REQUEST,? super RESPONSE>> operationListenerAttributesExtractorAdder)

setExceptionEventExtractor

public static <REQUEST> void setExceptionEventExtractor(InstrumenterBuilder<REQUEST,?> builder,
 InternalExceptionEventExtractor<? super REQUEST> exceptionEventExtractor)

Sets the InternalExceptionEventExtractor that will determine the exception event name and severity. Only used when emitting exceptions as logs is enabled via the otel.semconv.exception.signal.preview flag.

internalSetExceptionEventExtractor

public static <REQUEST> void internalSetExceptionEventExtractor(BiConsumer<InstrumenterBuilder<REQUEST,?>,InternalExceptionEventExtractor<? super REQUEST>> exceptionEventExtractorSetter)

setSpanSuppressionStrategy

public static void setSpanSuppressionStrategy(InstrumenterBuilder<?,?> builder,
 String spanSuppressionStrategy)

Sets the span suppression strategy. Supported values are none, span-kind, and semconv.

internalSetSpanSuppressionStrategy

public static void internalSetSpanSuppressionStrategy(BiConsumer<InstrumenterBuilder<?,?>,String> spanSuppressionStrategySetter)