Top Description Interfaces Classes Enums
module io.opentelemetry.api

Package io.opentelemetry.api.trace

Annotations
@ParametersAreNonnullByDefault
Imports
javax.annotation.ParametersAreNonnullByDefault

API for distributed tracing.

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.

io.opentelemetry.api.trace.Span represents a single operation within a trace.

Spans are propagated in-process in the io.opentelemetry.context.Context and between process using one of the wire propagation formats supported in the opentelemetry.trace.propagation package.

Interface Summary

Modifier and TypeInterface and Description
public interface
Span

An interface that represents a span.

public interface
SpanBuilder

SpanBuilder is used to construct Span instances which define arbitrary scopes of code that are sampled for distributed tracing as a single atomic unit.

public interface
SpanContext

A class that represents a span context.

public interface
TraceFlags

A valid trace flags is a byte or 2 character lowercase hex (base16) String.

public interface
Tracer

Tracer is the interface for Span creation and interaction with the in-process context.

public interface
TracerBuilder

Builder class for creating Tracer instances.

public interface
TracerProvider

A registry for creating named Tracers.

public interface
TraceState

Carries tracing-system specific context in a list of key-value pairs.

public interface

Class Summary

Modifier and TypeClass and Description
pack-priv abstract class
pack-priv class
pack-priv class
DefaultTracer

No-op implementation of Tracer.

pack-priv class
pack-priv class
pack-priv class
pack-priv class
PropagatedSpan

The default Span that is used when no Span implementation is available.

pack-priv class
SpanContextKey

Util class to hold on to the key for storing a Span in the Context.

public class
SpanId

Helper methods for dealing with a span identifier.

public class
TraceId

Helper methods for dealing with a trace identifier.

Enum Summary

Modifier and TypeEnum and Description
public enum
SpanKind

Type of Span.

public enum
StatusCode

The set of canonical status codes.