Module io.prometheus.metrics.tracer.common

Package io.prometheus.metrics.tracer.common

Interface SpanContext

public interface SpanContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXEMPLAR_ATTRIBUTE_NAME
static final String	EXEMPLAR_ATTRIBUTE_VALUE

Method Summary

Modifier and Type	Method	Description
String	getCurrentSpanId()
String	getCurrentTraceId()
boolean	isCurrentSpanSampled()
void	markCurrentSpanAsExemplar()

Field Details

EXEMPLAR_ATTRIBUTE_NAME

static final String EXEMPLAR_ATTRIBUTE_NAME

See Also:

• Constant Field Values

EXEMPLAR_ATTRIBUTE_VALUE

static final String EXEMPLAR_ATTRIBUTE_VALUE

See Also:

• Constant Field Values

Method Details

getCurrentTraceId

@Nullable
String getCurrentTraceId()

Returns:

the current trace id, or null if this call is not happening within a span context.

getCurrentSpanId

@Nullable
String getCurrentSpanId()

Returns:

the current span id, or null if this call is not happening within a span context.

isCurrentSpanSampled

boolean isCurrentSpanSampled()

Returns:

the state of the current Span. If this value is false a component before in the chain take the decision to not record it. Subsequent calling service have to respect this value in order not to have partial TraceID with only some Span in it. This value is important to be sure to choose a recorded Trace in Examplar sampling process

markCurrentSpanAsExemplar

void markCurrentSpanAsExemplar()