Package io.opentelemetry.instrumentation.api.instrumenter

Interface SpanKindExtractor<REQUEST>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SpanKindExtractor<REQUEST>

Extractor of the SpanKind. In most cases, the span kind will be constant for server or client requests, but you may need to implement a custom SpanKindExtractor if a framework can generate different kinds of spans, for example both HTTP and messaging spans.

Method Summary

Modifier and Type	Method	Description
static <REQUEST> SpanKindExtractor<REQUEST>	alwaysClient()	Returns a SpanNameExtractor which always returns SpanKind.CLIENT.
static <REQUEST> SpanKindExtractor<REQUEST>	alwaysConsumer()	Returns a SpanNameExtractor which always returns SpanKind.CONSUMER.
static <REQUEST> SpanKindExtractor<REQUEST>	alwaysInternal()	Returns a SpanNameExtractor which always returns SpanKind.INTERNAL.
static <REQUEST> SpanKindExtractor<REQUEST>	alwaysProducer()	Returns a SpanNameExtractor which always returns SpanKind.PRODUCER.
static <REQUEST> SpanKindExtractor<REQUEST>	alwaysServer()	Returns a SpanNameExtractor which always returns SpanKind.SERVER.
io.opentelemetry.api.trace.SpanKind	extract(REQUEST request)	Returns the SpanKind corresponding to the SpanKindExtractor.

Method Details

extract

io.opentelemetry.api.trace.SpanKind extract(REQUEST request)

Returns the SpanKind corresponding to the SpanKindExtractor.

alwaysInternal

static <REQUEST> SpanKindExtractor<REQUEST> alwaysInternal()

Returns a SpanNameExtractor which always returns SpanKind.INTERNAL.

alwaysClient

static <REQUEST> SpanKindExtractor<REQUEST> alwaysClient()

Returns a SpanNameExtractor which always returns SpanKind.CLIENT.

alwaysServer

static <REQUEST> SpanKindExtractor<REQUEST> alwaysServer()

Returns a SpanNameExtractor which always returns SpanKind.SERVER.

alwaysProducer

static <REQUEST> SpanKindExtractor<REQUEST> alwaysProducer()

Returns a SpanNameExtractor which always returns SpanKind.PRODUCER.

alwaysConsumer

static <REQUEST> SpanKindExtractor<REQUEST> alwaysConsumer()

Returns a SpanNameExtractor which always returns SpanKind.CONSUMER.