Package io.honeycomb.beeline.tracing.propagation

Class PropagationContext

java.lang.Object

io.honeycomb.beeline.tracing.propagation.PropagationContext

public class PropagationContext
extends Object

This class represents the information that is needed to continue traces across process boundaries:

1. The traceId that identifies the trace as a whole.
2. The spanId that identifies the latest Span in the trace and will become the parentSpanId of the next Span in the trace.
3. Optional - Trace fields that propagate contextual information down the trace.
4. Optional - The name of the dataset to send the Spans to. This acts as an override for the application's configured dataset.

Thread-safety

Instances of this class are thread-safe.

Constructor Summary

Constructors

Constructor	Description
PropagationContext(String traceId, String spanId, String dataset, Map<String,?> traceFields)	Create a trace context with provided IDs and map of trace fields.

Method Summary

Modifier and Type	Method	Description
static PropagationContext	emptyContext()
boolean	equals(Object other)
String	getDataset()
String	getSpanId()
Map<String,Object>	getTraceFields()
String	getTraceId()
int	hashCode()
boolean	isTraced()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropagationContext

public PropagationContext(String traceId,
                          String spanId,
                          String dataset,
                          Map<String,?> traceFields)

Create a trace context with provided IDs and map of trace fields.

Parameters:

traceId - that identifies the trace - may be null.

spanId - that identifies the latest span - may only be null if span ID is also null.

dataset - that identifies an explicit dataset that spans should be sent to - may be null.

traceFields - to propagate to the next span - may be null.

See Also:

Span.getTraceContext()

Method Detail

emptyContext

public static PropagationContext emptyContext()

getTraceFields

public Map<String,Object> getTraceFields()

Returns:

immutable map of fields being propagated across the trace - may be empty.

getTraceId

public String getTraceId()

Returns:

Trace ID - may be null.

getSpanId

public String getSpanId()

Returns:

Span ID - may be null.

getDataset

public String getDataset()

Returns:

dataset - may be null.

isTraced

public boolean isTraced()

Returns:

true if this context has trace and span IDs.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object