Tracing (Brave 5.2.0 API)

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 Description

static class Tracing.Builder

Nested Classes
Modifier and Type	Class	Description
`static class`	`Tracing.Builder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Clock`	`clock(TraceContext context)`	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 if its component hasn't been closed.
`abstract ErrorParser`	`errorParser()`
`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.
`abstract Sampler`	`sampler()`	Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
`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

- 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.
  - sampler
```
public abstract Sampler sampler()
```
    Sampler is responsible for deciding if a particular trace should be "sampled", i.e. whether the overhead of tracing will occur and/or if a trace will be reported to Zipkin.
    
    See Also:
    
    Tracer.withSampler(Sampler)
  - currentTraceContext
```
public abstract CurrentTraceContext currentTraceContext()
```
    This supports in-process propagation, typically across thread boundaries. This includes utilities for concurrent types like ExecutorService.
  - clock
```
public final Clock clock(TraceContext context)
```
    This exposes the microsecond clock used by operations such as Span.finish(). This is helpful when you want to time things manually. Notably, this clock will be coherent for all child spans in this trace (that use this tracing component). For example, NTP or system clock changes will not affect the result.
    
    Parameters:
    
    context - references a potentially unstarted span you'd like a clock correlated with
  - errorParser
```
public abstract ErrorParser errorParser()
```
  - currentTracer
```
@Nullable
public static Tracer currentTracer()
```
    Returns the most recently created tracer if 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 AutoCloseable
    
    Specified by:
    
    close in interface Closeable

Class Tracing

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newBuilder

tracer

propagation

propagationFactory

sampler

currentTraceContext

clock

errorParser

currentTracer

isNoop

setNoop

current

close