All Classes
| Class | Description |
|---|---|
| B3Propagation<K> |
Implements B3 Propagation
|
| B3Propagation.FactoryBuilder |
Defaults to
B3Propagation.Format.MULTI for client/server spans and B3Propagation.Format.SINGLE_NO_PARENT
for messaging. |
| B3Propagation.Format |
Describes the formats used to inject headers.
|
| B3SingleFormat |
This format corresponds to the propagation key "b3" (or "B3"), which delimits fields in the
following manner.
|
| B3SinglePropagation | Deprecated.
Since 5.9, use
B3Propagation.newFactoryBuilder() to control inject formats. |
| BaggageField |
Defines a trace context scoped field, usually but not always analogous to an HTTP header.
|
| BaggageField.ValueUpdater |
Used to decouple baggage value updates from
TraceContext or TraceContextOrSamplingFlags storage. |
| BaggageFields |
This contains pre-defined fields, such as
BaggageFields.TRACE_ID and a way to create a constant field. |
| BaggagePropagation<K> |
This implements in-process and remote baggage propagation.
|
| BaggagePropagation.FactoryBuilder | |
| BaggagePropagationConfig |
Holds
BaggagePropagation configuration. |
| BaggagePropagationConfig.SingleBaggageField |
Holds
BaggagePropagation configuration for a baggage field. |
| BaggagePropagationConfig.SingleBaggageField.Builder | |
| BaggagePropagationCustomizer |
This allows configuration plugins to collaborate on building an instance of
BaggagePropagation.Factory. |
| BoundarySampler |
This sampler is appropriate for high-traffic instrumentation (ex edge web servers that each
receive >100K requests) who provision random trace ids, and make the sampling decision only once.
|
| Clock | |
| CorrelationScopeConfig |
Holds
CorrelationScopeDecorator configuration. |
| CorrelationScopeConfig.SingleCorrelationField |
Holds
CorrelationScopeDecorator configuration for a baggage
field. |
| CorrelationScopeConfig.SingleCorrelationField.Builder | |
| CorrelationScopeCustomizer |
This allows configuration plugins to collaborate on building an instance of
CorrelationScopeDecorator. |
| CorrelationScopeDecorator |
Synchronizes fields such as
BaggageFields.TRACE_ID with a correlation context, such as
logging through decoration of a scope. |
| CorrelationScopeDecorator.Builder |
Defaults to
BaggageFields.TRACE_ID and BaggageFields.SPAN_ID. |
| CountingSampler |
This sampler is appropriate for low-traffic instrumentation (ex servers that each receive <100K
requests), or those who do not provision random trace ids.
|
| CurrentSpanCustomizer |
Provides a mechanism for end users to be able to customise the current span.
|
| CurrentTraceContext |
This makes a given span the current span by placing it in scope (usually but not always a thread
local scope).
|
| CurrentTraceContext.Builder |
Implementations of this allow standardized configuration, for example scope decoration.
|
| CurrentTraceContext.Default |
Default implementation which is backed by a static thread local.
|
| CurrentTraceContext.Scope |
A span remains in the scope it was bound to until close is called.
|
| CurrentTraceContext.ScopeDecorator |
Use this to add features such as thread checks or log correlation when a scope is created or
closed.
|
| CurrentTraceContextCustomizer |
This allows configuration plugins to collaborate on building an instance of
CurrentTraceContext. |
| DeclarativeSampler<M> |
This is an implementation of how to decide whether to trace a request using annotations on a java
method.
|
| DeclarativeSampler.ProbabilityOfMethod<M> | |
| DeclarativeSampler.RateForMethod<M> | Deprecated.
since 5.8, use
DeclarativeSampler.ProbabilityOfMethod |
| DeclarativeSampler.RateOfMethod<M> | |
| ErrorParser | Deprecated.
Since 5.12 Use Tags#ERROR or defer to
ZipkinSpanHandler |
| ExtraFieldCustomizer | Deprecated.
Since 5.11 use
BaggagePropagationCustomizer |
| ExtraFieldPropagation<K> | Deprecated.
Since 5.11 use
BaggagePropagation |
| ExtraFieldPropagation.Factory | Deprecated.
Since 5.11 use
Propagation.Factory |
| ExtraFieldPropagation.FactoryBuilder | Deprecated.
Since 5.11 use
BaggagePropagation.FactoryBuilder |
| FinishedSpanHandler | Deprecated.
Since 5.12 use
SpanHandler.end(TraceContext, MutableSpan, Cause) with SpanHandler.Cause.FINISHED |
| Matcher<P> |
Returns true if this rule matches the input parameters
|
| Matchers |
Convenience functions to compose matchers for
ParameterizedSampler. |
| MutableSpan |
This represents a span except for its
TraceContext. |
| MutableSpan.AnnotationConsumer<T> | |
| MutableSpan.AnnotationUpdater | |
| MutableSpan.TagConsumer<T> | |
| MutableSpan.TagUpdater | |
| MutableSpanBytesEncoder |
Similar to
zipkin2.MutableSpan.SpanBytesEncoder except no Zipkin dependency. |
| NoopSpanCustomizer |
Performs no operations as the span represented by this is not sampled to report to the tracing
system.
|
| ParameterizedSampler<P> |
This is an implementation of how to decide whether to trace a request using ordered rules.
|
| ParameterizedSampler.Builder<P> | |
| ParameterizedSampler.Rule<P> | Deprecated.
Since 5.8, use
ParameterizedSampler.Builder.putRule(Matcher, Sampler) |
| Propagation<K> |
Injects and extracts
trace identifiers as text into requests that travel
in-band across process boundaries. |
| Propagation.Factory | |
| Propagation.Getter<R,K> |
Gets the first value of the given propagation key or returns
null. |
| Propagation.KeyFactory<K> | Deprecated.
since 5.12 non-string keys are no longer supported
|
| Propagation.RemoteGetter<R> |
Used as an input to
Propagation.extractor(Getter) extract the trace context and any baggage from propagated fields. |
| Propagation.RemoteSetter<R> |
Used as an input to
Propagation.injector(Setter) inject the trace context and any baggage as propagated fields. |
| Propagation.Setter<R,K> |
Replaces a propagated key with the given value.
|
| RateLimitingSampler |
The rate-limited sampler allows you to choose an amount of traces to accept on a per-second
interval.
|
| Request |
Abstract request type used for parsing and sampling.
|
| Response |
Abstract response type used for parsing.
|
| Sampler |
Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
|
| SamplerFunction<T> |
Decides whether to start a new trace based on request properties such as an HTTP path.
|
| SamplerFunctions |
Convenience sampling functions.
|
| SamplingFlags | |
| SamplingFlags.Builder | Deprecated.
prefer using constants.
|
| ScopedSpan |
Used to model the latency of an operation within a method block.
|
| Span |
Subtype of
SpanCustomizer which can capture latency and remote context of an operation. |
| Span.Kind | |
| SpanCustomizer |
Simple interface users can customize a span with.
|
| SpanHandler |
This tracks one recording of a
TraceContext. |
| SpanHandler.Cause |
What ended the data collection?
|
| StrictCurrentTraceContext |
Useful when developing instrumentation as state is enforced more strictly.
|
| StrictCurrentTraceContext.Builder | |
| StrictScopeDecorator |
Useful when developing instrumentation as state is enforced more strictly.
|
| Tag<I> |
This is a centralized type to parse a tag into any variant of a span.
|
| Tags |
Standard tags used in parsers
|
| ThreadLocalCurrentTraceContext |
In-process trace context propagation backed by a static thread local.
|
| ThreadLocalCurrentTraceContext.Builder | |
| ThreadLocalSpan |
This type allows you to place a span in scope in one method and access it in another without
using an explicit request parameter.
|
| TraceContext |
Contains trace identifiers and sampling data propagated in and out-of-process.
|
| TraceContext.Builder | |
| TraceContext.Extractor<R> |
Used to continue an incoming trace.
|
| TraceContext.Injector<R> |
Used to send the trace context downstream.
|
| TraceContextOrSamplingFlags |
Union type that contains only one of trace context, trace ID context or sampling flags.
|
| TraceContextOrSamplingFlags.Builder | |
| TraceIdContext |
Contains inbound trace ID and sampling flags, used when users control the root trace ID, but not
the span ID (ex Amazon X-Ray or other correlation).
|
| TraceIdContext.Builder | |
| Tracer |
Using a tracer, you can create a root span capturing the critical path of a request.
|
| Tracer.SpanInScope |
A span remains in the scope it was bound to until close is called.
|
| Tracing |
This provides utilities needed for trace instrumentation.
|
| Tracing.Builder | |
| TracingCustomizer |
This allows configuration plugins to collaborate on building an instance of
Tracing. |