org.springframework.cloud.sleuth.trace

Class DefaultTracer

java.lang.Object

org.springframework.cloud.sleuth.trace.DefaultTracer

All Implemented Interfaces:

SpanAccessor, Tracer

public class DefaultTracer
extends Object
implements Tracer

Default implementation of Tracer

Since:

1.0.0

Author:

Spencer Gibb

Constructor Summary

Constructors

Constructor and Description
DefaultTracer(Sampler defaultSampler, Random random, SpanNamer spanNamer, SpanLogger spanLogger, SpanReporter spanReporter) Deprecated.
DefaultTracer(Sampler defaultSampler, Random random, SpanNamer spanNamer, SpanLogger spanLogger, SpanReporter spanReporter, boolean traceId128) Deprecated.
DefaultTracer(Sampler defaultSampler, Random random, SpanNamer spanNamer, SpanLogger spanLogger, SpanReporter spanReporter, boolean traceId128, TraceKeys traceKeys)
DefaultTracer(Sampler defaultSampler, Random random, SpanNamer spanNamer, SpanLogger spanLogger, SpanReporter spanReporter, TraceKeys traceKeys)

Method Summary

Modifier and Type	Method and Description
void	addTag(String key, String value) Adds a tag to the current span if tracing is currently on.
Span	close(Span span) Remove this span from the current thread, stop it and send it for collection.
Span	continueSpan(Span span) Contributes to a span started in another thread.
Span	createSpan(String name) Creates a new Span.
Span	createSpan(String name, Sampler sampler) Start a new span if the sampler allows it or if we are already tracing in this thread.
Span	createSpan(String name, Span parent) Creates a new Span with a specific parent.
Span	detach(Span span) Remove this span from the current thread, but don't stop it yet or send it for collection.
Span	getCurrentSpan()
boolean	isTracing()
<V> Callable<V>	wrap(Callable<V> callable) Wrap the callable in a TraceCallable, if tracing.
Runnable	wrap(Runnable runnable) Wrap the runnable in a TraceRunnable, if tracing.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTracer

@Deprecated
public DefaultTracer(Sampler defaultSampler,
                                 Random random,
                                 SpanNamer spanNamer,
                                 SpanLogger spanLogger,
                                 SpanReporter spanReporter)

Deprecated.

DefaultTracer

@Deprecated
public DefaultTracer(Sampler defaultSampler,
                                 Random random,
                                 SpanNamer spanNamer,
                                 SpanLogger spanLogger,
                                 SpanReporter spanReporter,
                                 boolean traceId128)

Deprecated.

DefaultTracer

public DefaultTracer(Sampler defaultSampler,
                     Random random,
                     SpanNamer spanNamer,
                     SpanLogger spanLogger,
                     SpanReporter spanReporter,
                     TraceKeys traceKeys)

DefaultTracer

public DefaultTracer(Sampler defaultSampler,
                     Random random,
                     SpanNamer spanNamer,
                     SpanLogger spanLogger,
                     SpanReporter spanReporter,
                     boolean traceId128,
                     TraceKeys traceKeys)

Method Detail

createSpan

public Span createSpan(String name,
                       Span parent)

Description copied from interface: Tracer

Creates a new Span with a specific parent. The parent might be in another process or thread.

If this thread has a currently active trace span, it must be the 'parent' span that you pass in here as a parameter. The trace scope we create here will contain a new span which is a child of 'parent'.

Specified by:

createSpan in interface Tracer

Parameters:

name - The name field for the new span to create.

createSpan

public Span createSpan(String name)

Description copied from interface: Tracer

Creates a new Span.

If this thread has a currently active span, it will be the parent of the span we create here. If there is no currently active trace span, the trace scope we create will be empty.

Specified by:

createSpan in interface Tracer

Parameters:

name - The name field for the new span to create.

createSpan

public Span createSpan(String name,
                       Sampler sampler)

Description copied from interface: Tracer

Start a new span if the sampler allows it or if we are already tracing in this thread. A sampler can be used to limit the number of traces created.

Specified by:

createSpan in interface Tracer

Parameters:

name - the name of the span

sampler - a sampler to decide whether to create the span or not

detach

public Span detach(Span span)

Description copied from interface: Tracer

Remove this span from the current thread, but don't stop it yet or send it for collection. This is useful if the span object is then passed to another thread for use with Tracer.continueSpan(Span).

Example of usage:

     // Span "A" was present in thread "X". Let's assume that we're in thread "Y" to which span "A" got passed
     Span continuedSpan = tracer.continueSpan(spanA);
     // Now span "A" got continued in thread "Y".
     ... // Some work is done... state of span "A" could get mutated
     Span previouslyStoredSpan = tracer.detach(continuedSpan);
     // Span "A" got removed from the thread Y but it wasn't yet sent for collection.
     // Additional work can be done on span "A" in thread "X" and finally it can get closed and sent for collection
     tracer.close(spanA);
 

Specified by:

detach in interface Tracer

Returns:

the saved trace if there was one before the trace started (null otherwise)

close

public Span close(Span span)

Description copied from interface: Tracer

Remove this span from the current thread, stop it and send it for collection.

Specified by:

close in interface Tracer

Parameters:

span - the span to close

Returns:

the saved span if there was one before the trace started (null otherwise)

continueSpan

public Span continueSpan(Span span)

Description copied from interface: Tracer

Contributes to a span started in another thread. The returned span shares mutable state with the input.

Specified by:

continueSpan in interface Tracer

getCurrentSpan

public Span getCurrentSpan()

Specified by:

getCurrentSpan in interface SpanAccessor

isTracing

public boolean isTracing()

Specified by:

isTracing in interface SpanAccessor

addTag

public void addTag(String key,
                   String value)

Description copied from interface: Tracer

Adds a tag to the current span if tracing is currently on.

Every span may also have zero or more key/value Tags, which do not have timestamps and simply annotate the spans. Check TraceKeys for examples of most common tag keys

Specified by:

addTag in interface Tracer

wrap

public <V> Callable<V> wrap(Callable<V> callable)

Wrap the callable in a TraceCallable, if tracing.

Specified by:

wrap in interface Tracer

Returns:

The callable provided, wrapped if tracing, 'callable' if not.

wrap

public Runnable wrap(Runnable runnable)

Wrap the runnable in a TraceRunnable, if tracing.

Specified by:

wrap in interface Tracer

Returns:

The runnable provided, wrapped if tracing, 'runnable' if not.