Package brave.internal.propagation

Class CorrelationFieldScopeDecorator

java.lang.Object

brave.internal.propagation.CorrelationFieldScopeDecorator

All Implemented Interfaces:

CurrentTraceContext.ScopeDecorator

public abstract class CorrelationFieldScopeDecorator
extends Object
implements CurrentTraceContext.ScopeDecorator

Adds correlation properties "traceId", "parentId" and "spanId" when a span is current.

Constructor Summary

Constructors

Constructor	Description
CorrelationFieldScopeDecorator()

Method Summary

Modifier and Type	Method	Description
CurrentTraceContext.Scope	decorateScope(TraceContext currentSpan, CurrentTraceContext.Scope scope)	When the input is not null "traceId", "parentId" and "spanId" correlation properties are saved off and replaced with those of the current span.
protected abstract String	get(String key)	Returns the correlation property of the specified name iff it is a string, or null otherwise.
protected abstract void	put(String key, String value)	Replaces the correlation property of the specified name
protected abstract void	remove(String key)	Removes the correlation property of the specified name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CorrelationFieldScopeDecorator

public CorrelationFieldScopeDecorator()

Method Detail

decorateScope

public CurrentTraceContext.Scope decorateScope(@Nullable
                                               TraceContext currentSpan,
                                               CurrentTraceContext.Scope scope)

When the input is not null "traceId", "parentId" and "spanId" correlation properties are saved off and replaced with those of the current span. When the input is null, these properties are removed. Either way, "traceId", "parentId" and "spanId" properties are restored on CurrentTraceContext.Scope.close().

Specified by:

decorateScope in interface CurrentTraceContext.ScopeDecorator

get

@Nullable
protected abstract String get(String key)

Returns the correlation property of the specified name iff it is a string, or null otherwise.

put

protected abstract void put(String key,
                            String value)

Replaces the correlation property of the specified name

remove

protected abstract void remove(String key)

Removes the correlation property of the specified name