Package brave.context.slf4j

Class MDCScopeDecorator

java.lang.Object

brave.internal.propagation.CorrelationFieldScopeDecorator

brave.context.slf4j.MDCScopeDecorator

All Implemented Interfaces:

CurrentTraceContext.ScopeDecorator

public final class MDCScopeDecorator
extends brave.internal.propagation.CorrelationFieldScopeDecorator

Adds MDC properties "traceId", "parentId", "spanId" and "sampled" when a span is current. "traceId" and "spanId" are used in log correlation. "parentId" is used for scenarios such as log parsing that reconstructs the trace tree. "sampled" is used as a hint that a span found in logs might be in Zipkin.

Ex.

 tracing = Tracing.newBuilder()
                  .currentTraceContext(ThreadLocalCurrentTraceContext.newBuilder()
                    .addScopeDecorator(MDCScopeDecorator.create())
                    .build()
                  )
                  ...
                  .build();
 

Method Summary

Modifier and Type	Method	Description
static CurrentTraceContext.ScopeDecorator	create()
protected String	get(String key)
protected void	put(String key, String value)
protected void	remove(String key)

Methods inherited from class brave.internal.propagation.CorrelationFieldScopeDecorator

decorateScope

Methods inherited from class java.lang.Object

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

Method Details

create

public static CurrentTraceContext.ScopeDecorator create()

get

protected String get(String key)

Specified by:

get in class brave.internal.propagation.CorrelationFieldScopeDecorator

put

protected void put(String key, String value)

Specified by:

put in class brave.internal.propagation.CorrelationFieldScopeDecorator

remove

protected void remove(String key)

Specified by:

remove in class brave.internal.propagation.CorrelationFieldScopeDecorator