Package io.opencensus.trace
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.
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
io.opencensus.trace.propagation
package.
-
Interface Summary Interface Description ContextHandle ContextManager -
Class Summary Class Description Annotation A text annotation with a set of attributes.AttributeValue A class that represents all the possible values for an attribute.AttributeValue.AttributeValueBoolean AttributeValue.AttributeValueDouble AttributeValue.AttributeValueLong AttributeValue.AttributeValueString AutoValue_Annotation AutoValue_AttributeValue_AttributeValueBoolean AutoValue_AttributeValue_AttributeValueDouble AutoValue_AttributeValue_AttributeValueLong AutoValue_AttributeValue_AttributeValueString AutoValue_EndSpanOptions AutoValue_EndSpanOptions.Builder AutoValue_Link AutoValue_MessageEvent AutoValue_MessageEvent.Builder AutoValue_NetworkEvent Deprecated. AutoValue_NetworkEvent.Builder AutoValue_Tracestate AutoValue_Tracestate_Entry BaseMessageEvent Deprecated. This class is for internal use only.BigendianEncoding BlankSpan TheBlankSpan
is a singleton class, which is the defaultSpan
that is used when noSpan
implementation is available.CurrentSpanUtils Util methods/functionality to interact with theSpan
in theContext
.CurrentSpanUtils.CallableInSpan<V> CurrentSpanUtils.RunnableInSpan CurrentSpanUtils.ScopeInSpan EndSpanOptions A class that enables overriding the default values used when ending aSpan
.EndSpanOptions.Builder Builder class forEndSpanOptions
.Link A link to aSpan
from a different trace.MessageEvent A class that represents a generic messaging event.MessageEvent.Builder Builder class forMessageEvent
.NetworkEvent Deprecated. UseMessageEvent
.NetworkEvent.Builder Deprecated. NetworkEvent
is deprecated.Sampler Sampler is used to make decisions onSpan
sampling.Span An abstract class that represents a span.SpanBuilder SpanBuilder
is used to constructSpan
instances which define arbitrary scopes of code that are sampled for distributed tracing as a single atomic unit.SpanBuilder.NoopSpanBuilder SpanContext A class that represents a span context.SpanId A class that represents a span identifier.Status Defines the status of aSpan
by providing a standardStatus.CanonicalCode
in conjunction with an optional descriptive message.TraceComponent Class that holds the implementation instances forTracer
,PropagationComponent
,Clock
,ExportComponent
andTraceConfig
.TraceComponent.NoopTraceComponent TraceComponentImpl Deprecated. TraceComponentImplLite Deprecated. TraceId A class that represents a trace identifier.TraceOptions A class that represents global trace options.TraceOptions.Builder Builder class forTraceOptions
.Tracer Tracer is a simple, thin class forSpan
creation and in-process context interaction.Tracer.NoopTracer Tracestate Carries tracing-system specific context in a list of key-value pairs.Tracestate.Builder Builder class forMessageEvent
.Tracestate.Entry Immutable key-value pair forTracestate
.Tracing Class that manages a global instance of theTraceComponent
. -
Enum Summary Enum Description Link.Type The relationship with the linkedSpan
relative to the currentSpan
.MessageEvent.Type Available types for aMessageEvent
.NetworkEvent.Type Available types for aNetworkEvent
.Span.Kind Type of span.Span.Options Span
options.Status.CanonicalCode The set of canonical status codes.