| Interface | Description |
|---|---|
| Span |
An interface that represents a span.
|
| Span.Builder |
Span.Builder is used to construct Span instances which define arbitrary scopes of
code that are sampled for distributed tracing as a single atomic unit. |
| Tracer |
Tracer is a simple, interface for
Span creation and in-process context interaction. |
| Class | Description |
|---|---|
| AttributeValue |
A class that represents all the possible values for an attribute.
|
| BlankSpan |
The
BlankSpan is a singleton class, which is the default Span that is used when
no Span implementation is available. |
| Event |
A text annotation with a set of attributes.
|
| Link |
A link to a
Span from a different trace. |
| NoopTrace |
No-op implementations of trace classes.
|
| Sampler |
Sampler is used to make decisions on
Span sampling. |
| SpanContext |
A class that represents a span context.
|
| SpanData |
Immutable representation of all data collected by the
Span class. |
| SpanData.TimedEvent |
A timed event representation.
|
| SpanData.Timestamp |
A representation of an instant in time.
|
| SpanId |
A class that represents a span identifier.
|
| Status |
Defines the status of a
Span by providing a standard Status.CanonicalCode in conjunction
with an optional descriptive message. |
| Trace |
Class that manages a global instance of the
Tracer. |
| TraceId |
A class that represents a trace identifier.
|
| TraceOptions |
A class that represents global trace options.
|
| TraceOptions.Builder |
Builder class for
TraceOptions. |
| Tracestate |
Carries tracing-system specific context in a list of key-value pairs.
|
| Tracestate.Builder |
Builder class for
Tracestate. |
| Tracestate.Entry |
Immutable key-value pair for
Tracestate. |
| Enum | Description |
|---|---|
| AttributeValue.Type |
An enum that represents all the possible value types for an
AttributeValue. |
| Span.Kind |
Type of span.
|
| Status.CanonicalCode |
The set of canonical status codes.
|
Distributed tracing, also called distributed request tracing, is a technique that helps debugging distributed applications.
Trace represents a tree of spans. A trace has a root span that encapsulates all the spans from start to end, and the children spans being the distinct calls invoked in between.
Span represents a single operation within a trace.
Spans are propagated in-process in the io.grpc.Context and between process using one of the wire propagation formats supported in the
openconsensus.trace.propagation package.