Package io.micrometer.tracing

Interface Baggage

All Superinterfaces:

BaggageView

public interface Baggage
extends BaggageView

Inspired by OpenZipkin Brave's BaggageField. Since some tracer implementations require a scope to be wrapped around baggage, baggage must be closed so that the scope does not leak, see BaggageInScope. Some tracer implementations make baggage immutable (e.g. OpenTelemetry), so when the value gets updated they might create new scope (others will return the same one - e.g. OpenZipkin Brave).

Represents a single baggage entry.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final Baggage	NOOP	A noop implementation.

Method Summary

Modifier and Type	Method	Description
BaggageInScope	makeCurrent()	Sets the current baggage in scope.
default BaggageInScope	makeCurrent(TraceContext traceContext, String value)	Sets the current baggage in scope with given value.
default BaggageInScope	makeCurrent(String value)	Sets the current baggage in scope with given value.
Baggage	set(TraceContext traceContext, String value)	Deprecated. use makeCurrent(TraceContext, String)
Baggage	set(String value)	Deprecated. use makeCurrent(String)

Methods inherited from interface io.micrometer.tracing.BaggageView

get, get, name

Field Details

NOOP

static final Baggage NOOP

A noop implementation.

Method Details

set

@Deprecated
Baggage set(String value)

Deprecated.

use makeCurrent(String)

Sets the baggage value.

Parameters:

value - to set

Returns:

itself

set

@Deprecated
Baggage set(TraceContext traceContext,
 String value)

Deprecated.

use makeCurrent(TraceContext, String)

Sets the baggage value for the given TraceContext.

Parameters:

traceContext - context containing baggage

value - to set

Returns:

itself

makeCurrent

BaggageInScope makeCurrent()

Sets the current baggage in scope.

Returns:

a BaggageInScope instance

makeCurrent

default BaggageInScope makeCurrent(String value)

Sets the current baggage in scope with given value.

Parameters:

value - to set

Returns:

a BaggageInScope instance

makeCurrent

default BaggageInScope makeCurrent(TraceContext traceContext,
 String value)

Sets the current baggage in scope with given value.

Parameters:

traceContext - context containing baggage

value - to set

Returns:

a BaggageInScope instance