brave

Class Tracing

java.lang.Object

brave.Tracing

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class Tracing
extends Object
implements Closeable

This provides utilities needed for trace instrumentation. For example, a Tracer.

Instances built via newBuilder() are registered automatically such that statically configured instrumentation like JDBC drivers can use current().

This type can be extended so that the object graph can be built differently or overridden, for example via spring or when mocking.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tracing.Builder

Constructor Summary

Constructors

Constructor and Description
Tracing()

Method Summary

Modifier and Type	Method and Description
abstract Clock	clock() This exposes the microsecond clock used by operations such as Span.finish().
abstract void	close() Ensures this component can be garbage collected, by making it not current()
static Tracing	current() Returns the most recently created tracing component iff it hasn't been closed.
abstract CurrentTraceContext	currentTraceContext() This supports in-process propagation, typically across thread boundaries.
static Tracer	currentTracer() Returns the most recently created tracer iff its component hasn't been closed.
boolean	isNoop() When true, no recording is done and nothing is reported to zipkin.
static Tracing.Builder	newBuilder()
Propagation<String>	propagation() When a trace leaves the process, it needs to be propagated, usually via headers.
abstract Propagation.Factory	propagationFactory() This supports edge cases like GRPC Metadata propagation which doesn't use String keys.
void	setNoop(boolean noop) Set true to drop data and only return noop spans regardless of sampling policy.
abstract Tracer	tracer() All tracing commands start with a Span.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tracing

public Tracing()

Method Detail

newBuilder

public static Tracing.Builder newBuilder()

tracer

public abstract Tracer tracer()

All tracing commands start with a Span. Use a tracer to create spans.

propagation

public Propagation<String> propagation()

When a trace leaves the process, it needs to be propagated, usually via headers. This utility is used to inject or extract a trace context from remote requests.

propagationFactory

public abstract Propagation.Factory propagationFactory()

This supports edge cases like GRPC Metadata propagation which doesn't use String keys.

currentTraceContext

public abstract CurrentTraceContext currentTraceContext()

This supports in-process propagation, typically across thread boundaries. This includes utilities for concurrent types like ExecutorService.

clock

public abstract Clock clock()

This exposes the microsecond clock used by operations such as Span.finish(). This is helpful when you want to time things manually.

currentTracer

@Nullable
public static Tracer currentTracer()

Returns the most recently created tracer iff its component hasn't been closed. null otherwise.

This object should not be cached.

isNoop

public boolean isNoop()

When true, no recording is done and nothing is reported to zipkin. However, trace context is still injected into outgoing requests.

See Also:

Span.isNoop()

setNoop

public void setNoop(boolean noop)

Set true to drop data and only return noop spans regardless of sampling policy. This allows operators to stop tracing in risk scenarios.

See Also:

isNoop()

current

@Nullable
public static Tracing current()

Returns the most recently created tracing component iff it hasn't been closed. null otherwise.

This object should not be cached.

close

public abstract void close()

Ensures this component can be garbage collected, by making it not current()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable