micrometer-tracing 1.2.3 · io.micrometer.tracing.BaggageManager

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

Method Summary

Modifier and Type	Method and Description
public Baggage	Returns: new or already created baggage createBaggage(String baggage name name) Deprecated use `BaggageManager#createBaggageInScope(String, String)` Creates a new `Baggage` entry for the given name or returns an existing one if it's already present.
public Baggage	Returns: new or already created baggage createBaggage(String baggage name name, String baggage value value) Deprecated use `BaggageManager#createBaggageInScope(String, String)` Creates a new `Baggage` entry for the given name or returns an existing one if it's already present.
public default BaggageInScope	Returns: baggage with value createBaggageInScope(String baggage name name, String baggage value value) Creates a new `Baggage` entry, sets a value on it and puts it in scope.
public default BaggageInScope	Returns: baggage with value createBaggageInScope(TraceContext trace context with baggage attached to it traceContext, String baggage name name, String baggage value value) Creates a new `Baggage` entry, sets a value on it and puts it in scope.
public Map<String, String>	Returns: mapping of all baggage entries from the given scope getAllBaggage()
public default Map<String, String>	Returns: mapping of all baggage entries from the given scope getAllBaggage(TraceContext trace context with baggage. If `null` will try to get all baggage from current available context traceContext)
public Baggage	Returns: baggage if present or creates a new one if missing with `null` value getBaggage(String baggage name name) Retrieves `Baggage` for the given name.
public Baggage	Returns: baggage or `null` if not present on the `TraceContext` getBaggage(TraceContext trace context with baggage attached to it traceContext, String baggage name name) Retrieves `Baggage` for the given name.

NOOP	back to summary
public static final BaggageManager NOOP A noop implementation.

Method Detail

createBaggage back to summary

createBaggage	back to summary
public Baggage createBaggage(String name) Deprecated use `BaggageManager#createBaggageInScope(String, String)` Creates a new `Baggage` entry for the given name or returns an existing one if it's already present. Parameters name:String baggage name Returns:Baggage new or already created baggage Annotations @Deprecated

public Baggage createBaggage(String name)

Deprecated

use BaggageManager#createBaggageInScope(String, String)

Creates a new Baggage entry for the given name or returns an existing one if it's already present.

Parameters

name:String: baggage name

Returns:Baggage

new or already created baggage

Annotations

@Deprecated

createBaggage back to summary

createBaggage	back to summary
public Baggage createBaggage(String name, String value) Deprecated use `BaggageManager#createBaggageInScope(String, String)` Creates a new `Baggage` entry for the given name or returns an existing one if it's already present. Parameters name:String baggage name value:String baggage value Returns:Baggage new or already created baggage Annotations @Deprecated

public Baggage createBaggage(String name, String value)

Deprecated

use BaggageManager#createBaggageInScope(String, String)

Creates a new Baggage entry for the given name or returns an existing one if it's already present.

Parameters

name:String: baggage name
value:String: baggage value

Returns:Baggage

new or already created baggage

Annotations

@Deprecated

createBaggageInScope back to summary

createBaggageInScope	back to summary
public default BaggageInScope createBaggageInScope(String name, String value) Creates a new `Baggage` entry, sets a value on it and puts it in scope. Parameters name:String baggage name value:String baggage value Returns:BaggageInScope baggage with value

public default BaggageInScope createBaggageInScope(String name, String value)

Creates a new Baggage entry, sets a value on it and puts it in scope.

Parameters

name:String: baggage name
value:String: baggage value

Returns:BaggageInScope

baggage with value

createBaggageInScope back to summary

createBaggageInScope	back to summary
public default BaggageInScope createBaggageInScope(TraceContext traceContext, String name, String value) Creates a new `Baggage` entry, sets a value on it and puts it in scope. Parameters traceContext:TraceContext trace context with baggage attached to it name:String baggage name value:String baggage value Returns:BaggageInScope baggage with value

public default BaggageInScope createBaggageInScope(TraceContext traceContext, String name, String value)

Creates a new Baggage entry, sets a value on it and puts it in scope.

Parameters

traceContext:TraceContext: trace context with baggage attached to it
name:String: baggage name
value:String: baggage value

Returns:BaggageInScope

baggage with value

getAllBaggage	back to summary
public Map<String, String> getAllBaggage() Returns:Map<String, String> mapping of all baggage entries from the given scope

getAllBaggage	back to summary
public default Map<String, String> getAllBaggage(TraceContext traceContext) Parameters traceContext:TraceContext trace context with baggage. If `null` will try to get all baggage from current available context Returns:Map<String, String> mapping of all baggage entries from the given scope

getBaggage back to summary

getBaggage	back to summary
public Baggage getBaggage(String name) Retrieves `Baggage` for the given name. Parameters name:String baggage name Returns:Baggage baggage if present or creates a new one if missing with `null` value

public Baggage getBaggage(String name)

Retrieves Baggage for the given name.

Parameters

name:String: baggage name

Returns:Baggage

baggage if present or creates a new one if missing with null value

getBaggage back to summary

getBaggage	back to summary
public Baggage getBaggage(TraceContext traceContext, String name) Retrieves `Baggage` for the given name. Parameters traceContext:TraceContext trace context with baggage attached to it name:String baggage name Returns:Baggage baggage or `null` if not present on the `TraceContext` Annotations @Nullable

public Baggage getBaggage(TraceContext traceContext, String name)

Retrieves Baggage for the given name.

Parameters

traceContext:TraceContext: trace context with baggage attached to it
name:String: baggage name

Returns:Baggage

baggage or null if not present on the TraceContext

Annotations

@Nullable

public Interface BaggageManager

Field Summary

Method Summary

Field Detail

Method Detail