Index (Brave 5.12.3 API)

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes All Packages

A

abandon() - Method in class brave.Span: Throws away the current span without reporting it.
ABANDONED - brave.handler.SpanHandler.Cause: Called on Span.abandon().
accept(T, long, String) - Method in interface brave.handler.MutableSpan.AnnotationConsumer
accept(T, String, String) - Method in interface brave.handler.MutableSpan.TagConsumer
add(BaggagePropagationConfig) - Method in class brave.baggage.BaggagePropagation.FactoryBuilder
add(CorrelationScopeConfig) - Method in class brave.baggage.CorrelationScopeDecorator.Builder
addExtra(Object) - Method in class brave.propagation.TraceContext.Builder
addExtra(Object) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder
addField(String) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Deprecated.
Since 5.11, use BaggagePropagationConfig.SingleBaggageField.remote(BaggageField)
addFinishedSpanHandler(FinishedSpanHandler) - Method in class brave.Tracing.Builder: Deprecated.
Since 5.12 add a span handler that implements SpanHandler.end(TraceContext, MutableSpan, SpanHandler.Cause) with SpanHandler.Cause.FINISHED
addKeyName(String) - Method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField.Builder: Configures a key name for remote propagation.
addPrefixedFields(String, Collection<String>) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Deprecated.
Since 5.11, use BaggagePropagationConfig.SingleBaggageField.Builder.addKeyName(String)
addRedactedField(String) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Deprecated.
Since 5.11, use BaggagePropagationConfig.SingleBaggageField.local(BaggageField)
addScopeDecorator(CurrentTraceContext.ScopeDecorator) - Method in class brave.propagation.CurrentTraceContext.Builder: Implementations call decorators in order to add features like log correlation to a scope.
addScopeDecorator(CurrentTraceContext.ScopeDecorator) - Method in class brave.propagation.StrictCurrentTraceContext.Builder
addScopeDecorator(CurrentTraceContext.ScopeDecorator) - Method in class brave.propagation.ThreadLocalCurrentTraceContext.Builder
addSpanHandler(SpanHandler) - Method in class brave.Tracing.Builder: Inputs receive {code (context, span)} pairs for every locally sampled span.
allKeyNames(Propagation<String>) - Static method in class brave.baggage.BaggagePropagation: Returns the key names used for propagation, including those used for the trace context and baggage.
ALWAYS_SAMPLE - Static variable in class brave.sampler.Sampler
alwaysMatch() - Static method in class brave.sampler.Matchers
alwaysReportSpans() - Method in class brave.Tracing.Builder: Deprecated.
Since 5.12, use ZipkinSpanHandler.Builder.alwaysReportSpans(boolean)
alwaysSampleLocal() - Method in class brave.handler.FinishedSpanHandler: Deprecated.
Since 5.12, set Tracing.Builder.alwaysSampleLocal(). Tip: the same TracingCustomizer that adds this handler can also also set Tracing.Builder.alwaysSampleLocal().
alwaysSampleLocal() - Method in class brave.Tracing.Builder: When true, all spans become real spans even if they aren't sampled remotely.
and(Matcher...) - Static method in class brave.sampler.Matchers
and(Iterable<? extends Matcher>) - Static method in class brave.sampler.Matchers
annotate(long, String) - Method in class brave.handler.MutableSpan: Calling this adds an annotation, such as done in SpanCustomizer.annotate(String).
annotate(long, String) - Method in class brave.Span: Like Span.annotate(String), except with a given timestamp in microseconds.
annotate(Object, String) - Method in class brave.ErrorParser: Deprecated.

Same behaviour as SpanCustomizer.annotate(String)
annotate(String) - Method in class brave.CurrentSpanCustomizer: Associates an event that explains latency with the current system time.
annotate(String) - Method in enum brave.NoopSpanCustomizer
annotate(String) - Method in class brave.ScopedSpan: Associates an event that explains latency with the current system time.
annotate(String) - Method in class brave.Span: Associates an event that explains latency with the current system time.
annotate(String) - Method in interface brave.SpanCustomizer: Associates an event that explains latency with the current system time.
annotationCount() - Method in class brave.handler.MutableSpan
annotations() - Method in class brave.handler.MutableSpan: A read-only view of the current annotations as a collection of (epochMicroseconds -> value).
annotationTimestampAt(int) - Method in class brave.handler.MutableSpan: Returns the epoch microseconds of the annotation at the given index or throws IndexOutOfBoundsException if the index is invalid.
annotationValueAt(int) - Method in class brave.handler.MutableSpan: Returns the possibly empty value of the annotation at the given index or throws IndexOutOfBoundsException if the index is invalid.

B

B3_SINGLE_STRING - Static variable in interface brave.propagation.Propagation: Deprecated.
Since 5.9, use B3Propagation.newFactoryBuilder() to control inject formats.
B3_STRING - Static variable in interface brave.propagation.Propagation: Defaults B3 formats based on Request type.
B3Propagation<K> - Class in brave.propagation: Implements B3 Propagation
B3Propagation.FactoryBuilder - Class in brave.propagation: Defaults to B3Propagation.Format.MULTI for client/server spans and B3Propagation.Format.SINGLE_NO_PARENT for messaging.
B3Propagation.Format - Enum in brave.propagation: Describes the formats used to inject headers.
B3SingleFormat - Class in brave.propagation: This format corresponds to the propagation key "b3" (or "B3"), which delimits fields in the following manner.
B3SinglePropagation - Class in brave.propagation: Deprecated.
Since 5.9, use B3Propagation.newFactoryBuilder() to control inject formats.
B3SinglePropagation() - Constructor for class brave.propagation.B3SinglePropagation: Deprecated.
BAGGAGE_FIELD - Static variable in class brave.Tags: This tags the baggage value using BaggageField.name() as the key.
baggageField() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField
BaggageField - Class in brave.baggage: Defines a trace context scoped field, usually but not always analogous to an HTTP header.
BaggageField.ValueUpdater - Interface in brave.baggage: Used to decouple baggage value updates from TraceContext or TraceContextOrSamplingFlags storage.
BaggageFields - Class in brave.baggage: This contains pre-defined fields, such as BaggageFields.TRACE_ID and a way to create a constant field.
BaggageFields() - Constructor for class brave.baggage.BaggageFields
BaggagePropagation<K> - Class in brave.baggage: This implements in-process and remote baggage propagation.
BaggagePropagation.FactoryBuilder - Class in brave.baggage
BaggagePropagationConfig - Class in brave.baggage: Holds BaggagePropagation configuration.
BaggagePropagationConfig.SingleBaggageField - Class in brave.baggage: Holds BaggagePropagation configuration for a baggage field.
BaggagePropagationConfig.SingleBaggageField.Builder - Class in brave.baggage
BaggagePropagationCustomizer - Interface in brave.baggage: This allows configuration plugins to collaborate on building an instance of BaggagePropagation.Factory.
begin(TraceContext, MutableSpan, TraceContext) - Method in class brave.handler.SpanHandler: This is called when a span is sampled, but before it is started.
BoundarySampler - Class in brave.sampler: 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.
brave - package brave
brave.baggage - package brave.baggage
brave.handler - package brave.handler
brave.propagation - package brave.propagation
brave.sampler - package brave.sampler
build() - Method in class brave.baggage.BaggagePropagation.FactoryBuilder: Returns the delegate if there are no fields to propagate.
build() - Method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField.Builder
build() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField.Builder
build() - Method in class brave.baggage.CorrelationScopeDecorator.Builder
build() - Method in class brave.propagation.B3Propagation.FactoryBuilder
build() - Method in class brave.propagation.CurrentTraceContext.Builder
build() - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Deprecated.

Returns a wrapper of the delegate if there are no fields to propagate.
build() - Method in class brave.propagation.SamplingFlags.Builder: Deprecated.
build() - Method in class brave.propagation.StrictCurrentTraceContext.Builder
build() - Method in class brave.propagation.ThreadLocalCurrentTraceContext.Builder
build() - Method in class brave.propagation.TraceContext.Builder
build() - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Returns an immutable result from the values currently in the builder
build() - Method in class brave.propagation.TraceIdContext.Builder
build() - Method in class brave.sampler.ParameterizedSampler.Builder
build() - Method in class brave.Tracing.Builder
build(Boolean) - Static method in class brave.propagation.SamplingFlags.Builder: Deprecated.

Allows you to create flags from a boolean value without allocating a builder instance
Builder() - Constructor for class brave.propagation.CurrentTraceContext.Builder
Builder() - Constructor for class brave.propagation.SamplingFlags.Builder: Deprecated.
Builder(CorrelationContext) - Constructor for class brave.baggage.CorrelationScopeDecorator.Builder: Internal constructor used by subtypes.

C

clear() - Method in class brave.baggage.BaggagePropagation.FactoryBuilder: Clears all state.
clear() - Method in class brave.baggage.CorrelationScopeDecorator.Builder: Invoke this to clear fields so that you can add the ones you need.
clear() - Method in class brave.propagation.ThreadLocalCurrentTraceContext: This component is backed by a possibly static shared thread local.
clearExtra() - Method in class brave.propagation.TraceContext.Builder: Allows you to control TraceContext.extra() explicitly.
clearSpanHandlers() - Method in class brave.Tracing.Builder: Clears all span handlers.
CLIENT - brave.Span.Kind
clock(Clock) - Method in class brave.Tracing.Builder: Assigns microsecond-resolution timestamp source for operations like Span.start().
clock(TraceContext) - Method in class brave.Tracing: This exposes the microsecond clock used by operations such as Span.finish().
Clock - Interface in brave: Epoch microseconds used for Span.start(long), Span.finish(long) and Span.annotate(long, String).
close() - Method in interface brave.propagation.CurrentTraceContext.Scope: No exceptions are thrown when unbinding a span scope.
close() - Method in class brave.propagation.StrictCurrentTraceContext: Calls StrictScopeDecorator.close()
close() - Method in class brave.propagation.StrictScopeDecorator: This is useful in tests to help ensure scopes are not leaked by instrumentation.
close() - Method in class brave.Tracer.SpanInScope: No exceptions are thrown when unbinding a span scope.
close() - Method in class brave.Tracing: Ensures this component can be garbage collected, by making it not Tracing.current()
configs() - Method in class brave.baggage.BaggagePropagation.FactoryBuilder: Returns an immutable copy of the current configuration.
configs() - Method in class brave.baggage.CorrelationScopeDecorator.Builder: Returns an immutable copy of the current configuration.
constant(String, String) - Static method in class brave.baggage.BaggageFields: Creates a local baggage field based on a possibly null constant, such as an ENV variable.
CONSUMER - brave.Span.Kind: When present, Span.start() is the moment a consumer received a message from an origin.
containsAnnotation(String) - Method in class brave.handler.MutableSpan: Returns true if an annotation with the given value exists in this span.
context() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns non-null when both a trace ID and span ID were extracted from a request.
context() - Method in class brave.ScopedSpan: Returns the trace context associated with this span
context() - Method in class brave.Span
context(TraceContext) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Deprecated.
Since 5.12, use TraceContextOrSamplingFlags.newBuilder(TraceIdContext)
CorrelationScopeConfig - Class in brave.baggage: Holds CorrelationScopeDecorator configuration.
CorrelationScopeConfig.SingleCorrelationField - Class in brave.baggage: Holds CorrelationScopeDecorator configuration for a baggage field.
CorrelationScopeConfig.SingleCorrelationField.Builder - Class in brave.baggage
CorrelationScopeCustomizer - Interface in brave.baggage: This allows configuration plugins to collaborate on building an instance of CorrelationScopeDecorator.
CorrelationScopeDecorator - Class in brave.baggage: Synchronizes fields such as BaggageFields.TRACE_ID with a correlation context, such as logging through decoration of a scope.
CorrelationScopeDecorator.Builder - Class in brave.baggage: Defaults to BaggageFields.TRACE_ID and BaggageFields.SPAN_ID.
CountingSampler - Class in brave.sampler: This sampler is appropriate for low-traffic instrumentation (ex servers that each receive <100K requests), or those who do not provision random trace ids.
create() - Static method in class brave.propagation.CurrentTraceContext.Default: Uses a non-inheritable static thread local
create() - Static method in class brave.propagation.StrictCurrentTraceContext
create() - Static method in class brave.propagation.StrictScopeDecorator
create() - Static method in class brave.propagation.ThreadLocalCurrentTraceContext
create(float) - Static method in class brave.sampler.BoundarySampler
create(float) - Static method in class brave.sampler.CountingSampler
create(float) - Static method in class brave.sampler.Sampler: Returns a sampler, given a probability expressed as a percentage.
create(int) - Static method in class brave.sampler.RateLimitingSampler
create(BaggageField) - Static method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField
create(Propagation.KeyFactory<K>) - Method in class brave.propagation.ExtraFieldPropagation.Factory: Deprecated.
create(Propagation.KeyFactory<K>) - Method in class brave.propagation.Propagation.Factory: Deprecated.
Since 5.12, use Propagation.Factory.get()
create(SamplingFlags) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Used to implement TraceContext.Extractor.extract(Object) when the format allows extracting only sampling flags.
create(TraceContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Used to implement TraceContext.Extractor.extract(Object) for a format that can extract a complete TraceContext, including a trace ID and span ID.
create(TraceIdContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Used to implement TraceContext.Extractor.extract(Object) when the format allows extracting a trace ID without a span ID
create(DeclarativeSampler.RateForMethod<M>) - Static method in class brave.sampler.DeclarativeSampler: Deprecated.
since 5.8, use DeclarativeSampler.createWithProbability(ProbabilityOfMethod)
create(Tracer) - Static method in class brave.propagation.ThreadLocalSpan
create(Tracing) - Static method in class brave.CurrentSpanCustomizer: Creates a span customizer that will affect the current span in scope if present
create(Boolean, boolean) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Deprecated.
Since 5.12, use constants defined on this type as needed.
create(String) - Static method in class brave.baggage.BaggageField
create(String) - Method in interface brave.propagation.Propagation.KeyFactory: Deprecated.
create(List<? extends ParameterizedSampler.Rule>) - Static method in class brave.sampler.ParameterizedSampler: Deprecated.
since 5.8, use ParameterizedSampler.newBuilder()
createWithProbability(DeclarativeSampler.ProbabilityOfMethod<M>) - Static method in class brave.sampler.DeclarativeSampler
createWithRate(DeclarativeSampler.RateOfMethod<M>) - Static method in class brave.sampler.DeclarativeSampler
current() - Static method in class brave.Tracing: Returns the most recently created tracing component iff it hasn't been closed.
current(String) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getByName(String) and BaggageField.getValue()
CURRENT_TRACER - Static variable in class brave.propagation.ThreadLocalSpan: This uses the Tracing.currentTracer(), which means calls to ThreadLocalSpan.next() may return null.
currentSpan() - Method in class brave.Tracer: Returns the current span in scope or null if there isn't one.
currentSpanCustomizer() - Method in class brave.Tracer: Returns a customizer for current span in scope or noop if there isn't one.
CurrentSpanCustomizer - Class in brave: Provides a mechanism for end users to be able to customise the current span.
currentTimeMicroseconds() - Method in interface brave.Clock
currentTraceContext() - Method in class brave.Tracing: This supports in-process propagation, typically across thread boundaries.
currentTraceContext(CurrentTraceContext) - Method in class brave.Tracing.Builder: Responsible for implementing Tracer.startScopedSpan(String), Tracer.currentSpanCustomizer(), Tracer.currentSpan() and Tracer.withSpanInScope(Span).
CurrentTraceContext - Class in brave.propagation: This makes a given span the current span by placing it in scope (usually but not always a thread local scope).
CurrentTraceContext() - Constructor for class brave.propagation.CurrentTraceContext
CurrentTraceContext(CurrentTraceContext.Builder) - Constructor for class brave.propagation.CurrentTraceContext
CurrentTraceContext.Builder - Class in brave.propagation: Implementations of this allow standardized configuration, for example scope decoration.
CurrentTraceContext.Default - Class in brave.propagation: Default implementation which is backed by a static thread local.
CurrentTraceContext.Scope - Interface in brave.propagation: A span remains in the scope it was bound to until close is called.
CurrentTraceContext.ScopeDecorator - Interface in brave.propagation: Use this to add features such as thread checks or log correlation when a scope is created or closed.
CurrentTraceContextCustomizer - Interface in brave.propagation: This allows configuration plugins to collaborate on building an instance of CurrentTraceContext.
currentTracer() - Static method in class brave.Tracing: Returns the most recently created tracer if its component hasn't been closed.
customize(BaggagePropagation.FactoryBuilder) - Method in interface brave.baggage.BaggagePropagationCustomizer
customize(CorrelationScopeDecorator.Builder) - Method in interface brave.baggage.CorrelationScopeCustomizer
customize(CurrentTraceContext.Builder) - Method in interface brave.propagation.CurrentTraceContextCustomizer
customize(ExtraFieldPropagation.FactoryBuilder) - Method in interface brave.propagation.ExtraFieldCustomizer: Deprecated.
customize(Tracing.Builder) - Method in interface brave.TracingCustomizer
customizer() - Method in class brave.Span: Returns a customizer appropriate for the current span.

D

debug() - Method in class brave.handler.MutableSpan: Returns true if the context was debug.
debug() - Method in class brave.propagation.SamplingFlags: True implies SamplingFlags.sampled(), and is additionally a request to override any storage or collector layer sampling.
debug(boolean) - Method in class brave.propagation.SamplingFlags.Builder: Deprecated.

Setting debug to true also sets sampled to true.
debug(boolean) - Method in class brave.propagation.TraceContext.Builder
debug(boolean) - Method in class brave.propagation.TraceIdContext.Builder
DEBUG - Static variable in class brave.propagation.SamplingFlags
DEBUG - Static variable in class brave.propagation.TraceContextOrSamplingFlags
DeclarativeSampler<M> - Class in brave.sampler: This is an implementation of how to decide whether to trace a request using annotations on a java method.
DeclarativeSampler.ProbabilityOfMethod<M> - Interface in brave.sampler
DeclarativeSampler.RateForMethod<M> - Interface in brave.sampler: Deprecated.
since 5.8, use DeclarativeSampler.ProbabilityOfMethod
DeclarativeSampler.RateOfMethod<M> - Interface in brave.sampler
decorate(TraceContext) - Method in class brave.propagation.ExtraFieldPropagation.Factory: Deprecated.
decorate(TraceContext) - Method in class brave.propagation.Propagation.Factory: Decorates the input such that it can propagate extra state, such as a timestamp or baggage.
decorateScope(TraceContext, CurrentTraceContext.Scope) - Method in class brave.propagation.CurrentTraceContext: When implementing CurrentTraceContext.newScope(TraceContext), decorate the result before returning it.
decorateScope(TraceContext, CurrentTraceContext.Scope) - Method in interface brave.propagation.CurrentTraceContext.ScopeDecorator
decorateScope(TraceContext, CurrentTraceContext.Scope) - Method in class brave.propagation.StrictScopeDecorator: Identifies problems by throwing IllegalStateException when a scope is closed on a different thread.
deferDecision() - Static method in class brave.sampler.SamplerFunctions: Ignores the argument and returns null.
dirty() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField.Builder
dirty() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: Adds a name in the underlying context which is updated directly.

E

EMPTY - Static variable in class brave.propagation.SamplingFlags
EMPTY - Static variable in class brave.propagation.TraceContextOrSamplingFlags
encode(MutableSpan) - Method in class brave.handler.MutableSpanBytesEncoder: Serializes an object into its binary form.
encodeList(List<MutableSpan>) - Method in class brave.handler.MutableSpanBytesEncoder: Serializes a list of objects into their binary form.
encodeList(List<MutableSpan>, byte[], int) - Method in class brave.handler.MutableSpanBytesEncoder: Allows you to encode a list of spans onto a specific offset.
end(TraceContext, MutableSpan, SpanHandler.Cause) - Method in class brave.handler.FinishedSpanHandler: Deprecated.
end(TraceContext, MutableSpan, SpanHandler.Cause) - Method in class brave.handler.SpanHandler: Called when data collection complete.
endpoint(Endpoint) - Method in class brave.Tracing.Builder: Deprecated.
Use Tracing.Builder.localServiceName(String) Tracing.Builder.localIp(String) and Tracing.Builder.localPort(int). Will be removed in Brave v6.
equals(Object) - Method in class brave.baggage.BaggageField: Returns true for any baggage field with the same name (case insensitive).
equals(Object) - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: Returns true for any config with the same baggage field.
equals(Object) - Method in class brave.handler.MutableSpan
equals(Object) - Method in class brave.propagation.TraceContext: Includes mandatory fields TraceContext.traceIdHigh(), TraceContext.traceId(), TraceContext.spanId() and the shared flag.
equals(Object) - Method in class brave.propagation.TraceContextOrSamplingFlags
equals(Object) - Method in class brave.propagation.TraceIdContext: Only includes mandatory fields TraceIdContext.traceIdHigh() and TraceIdContext.traceId()
error() - Method in class brave.handler.MutableSpan: Returns the error or null.
error() - Method in class brave.Response: The error raised during response processing or null if there was none.
error(Throwable) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as {@link brave.Span#error(Throwable).
error(Throwable) - Method in class brave.ScopedSpan: Records an error that impacted this operation.
error(Throwable) - Method in class brave.Span: Records an error that impacted this operation.
error(Throwable, MutableSpan) - Method in class brave.ErrorParser: Deprecated.

Used to parse errors on a subtype of MutableSpan
error(Throwable, SpanCustomizer) - Method in class brave.ErrorParser: Deprecated.

Used to parse errors on a subtype of SpanCustomizer
error(Throwable, Object) - Method in class brave.ErrorParser: Deprecated.

Override to change what data from the error are parsed into the span modeling it.
ERROR - Static variable in class brave.Tags: This tags "error" as the message or simple name of the throwable.
errorParser() - Method in class brave.Tracing: Deprecated.
This is only used in Zipkin reporting. Since 5.12, use ZipkinSpanHandler.Builder.errorTag(Tag)
errorParser(ErrorParser) - Method in class brave.Tracing.Builder: Deprecated.
This is only used in Zipkin reporting. Since 5.12, use ZipkinSpanHandler.Builder.errorTag(Tag)
ErrorParser - Class in brave: Deprecated.
Since 5.12 Use Tags#ERROR or defer to ZipkinSpanHandler
ErrorParser() - Constructor for class brave.ErrorParser: Deprecated.
executor(Executor) - Method in class brave.propagation.CurrentTraceContext: Decorates the input such that the current trace context at the time a task is scheduled is made current when the task is executed.
executorService(ExecutorService) - Method in class brave.propagation.CurrentTraceContext: Decorates the input such that the current trace context at the time a task is scheduled is made current when the task is executed.
extra() - Method in class brave.propagation.TraceContext: Returns a list of additional data propagated through this trace.
extra() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns a list of additional state extracted from the request.
extra(List<Object>) - Method in class brave.propagation.TraceContext.Builder: Deprecated.
Since 5.12, use TraceContext.Builder.addExtra(Object)
extra(List<Object>) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Deprecated.
Since 5.12, use TraceContextOrSamplingFlags.Builder.addExtra(Object)
extract(R) - Method in interface brave.propagation.TraceContext.Extractor: Returns either a trace context or sampling flags parsed from the request.
extractor(Propagation.Getter<R, K>) - Method in class brave.baggage.BaggagePropagation
extractor(Propagation.Getter<R, K>) - Method in class brave.propagation.ExtraFieldPropagation: Deprecated.
extractor(Propagation.Getter<R, K>) - Method in interface brave.propagation.Propagation
ExtraFieldCustomizer - Interface in brave.propagation: Deprecated.
Since 5.11 use BaggagePropagationCustomizer
ExtraFieldPropagation<K> - Class in brave.propagation: Deprecated.
Since 5.11 use BaggagePropagation
ExtraFieldPropagation.Factory - Class in brave.propagation: Deprecated.
Since 5.11 use Propagation.Factory
ExtraFieldPropagation.FactoryBuilder - Class in brave.propagation: Deprecated.
Since 5.11 use BaggagePropagation.FactoryBuilder
extraKeys() - Method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.12 use BaggagePropagation.allKeyNames(Propagation) instead.

F

Factory() - Constructor for class brave.propagation.Propagation.Factory
FACTORY - Static variable in class brave.propagation.B3Propagation
FACTORY - Static variable in class brave.propagation.B3SinglePropagation: Deprecated.
field() - Method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField
findExtra(Class<T>) - Method in class brave.propagation.TraceContext: Returns a propagated state of the given type if present or null if not.
finish() - Method in class brave.ScopedSpan: Closes the scope associated with this span, then reports the span complete, assigning the most precise duration possible.
finish() - Method in class brave.Span: Reports the span complete, assigning the most precise duration possible.
finish(long) - Method in class brave.Span: Like Span.finish(), except with a given timestamp in microseconds.
FINISHED - brave.handler.SpanHandler.Cause: Called on Span.finish() and is the simplest cause to reason with.
FinishedSpanHandler - Class in brave.handler: Deprecated.
Since 5.12 use SpanHandler.end(TraceContext, MutableSpan, Cause) with SpanHandler.Cause.FINISHED
FinishedSpanHandler() - Constructor for class brave.handler.FinishedSpanHandler: Deprecated.
finishTimestamp() - Method in class brave.handler.MutableSpan: Returns the span finish timestamp or zero.
finishTimestamp(long) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Span.finish(long) or ScopedSpan.finish().
flush() - Method in class brave.Span: Reports the span, even if unfinished.
FLUSHED - brave.handler.SpanHandler.Cause: Called on Span.flush().
flushOnUpdate() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField.Builder
flushOnUpdate() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: When true, updates made to this name via BaggageField.updateValue(TraceContext, String) flush immediately to the correlation context.
forEachAnnotation(MutableSpan.AnnotationConsumer<T>, T) - Method in class brave.handler.MutableSpan: Iterates over all annotations for purposes such as copying values.
forEachAnnotation(MutableSpan.AnnotationUpdater) - Method in class brave.handler.MutableSpan: Allows you to update or drop annotations for purposes such as redaction.
forEachTag(MutableSpan.TagConsumer<T>, T) - Method in class brave.handler.MutableSpan: Iterates over all tags for purposes such as copying values.
forEachTag(MutableSpan.TagUpdater) - Method in class brave.handler.MutableSpan: Allows you to update or drop tags for purposes such as redaction.

G

get() - Static method in class brave.propagation.B3Propagation: Returns a singleton default instance.
get() - Method in class brave.propagation.CurrentTraceContext: Returns the current span in scope or null if there isn't one.
get() - Method in class brave.propagation.ExtraFieldPropagation.Factory: Deprecated.

Returns a possibly cached propagation instance.
get() - Method in class brave.propagation.Propagation.Factory: Returns a possibly cached propagation instance.
get() - Method in class brave.propagation.StrictCurrentTraceContext
get() - Method in class brave.propagation.ThreadLocalCurrentTraceContext
get(TraceContext, String) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getByName(TraceContext, String) and BaggageField.getValue(TraceContext)
get(String) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getByName(String) and BaggageField.getValue()
get(M) - Method in interface brave.sampler.DeclarativeSampler.ProbabilityOfMethod: Returns null if there's no configured sample probability of this method
get(M) - Method in interface brave.sampler.DeclarativeSampler.RateOfMethod: Returns null if there's no configured sample rate (in traces per second) of this method
get(R, String) - Method in interface brave.propagation.Propagation.RemoteGetter: Gets the propagation field as a single value.
get(R, K) - Method in interface brave.propagation.Propagation.Getter
getAll() - Static method in class brave.baggage.BaggageField: Deprecated.
Since 5.12 use BaggageField.getAllValues(TraceContext)
getAll() - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getAll()
getAll(TraceContext) - Static method in class brave.baggage.BaggageField: Deprecated.
Since 5.12 use BaggageField.getAllValues(TraceContext)
getAll(TraceContext) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getAll(TraceContext)
getAll(TraceContextOrSamplingFlags) - Static method in class brave.baggage.BaggageField: Deprecated.
Since 5.12 use BaggageField.getAllValues(TraceContext)
getAll(TraceContextOrSamplingFlags) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getAll(TraceContextOrSamplingFlags)
getAllValues() - Static method in class brave.baggage.BaggageField: Like BaggageField.getAllValues(TraceContext) except against the current trace context.
getAllValues(TraceContext) - Static method in class brave.baggage.BaggageField: Returns a map of all name to non-{@code null} value pairs in the extracted result.
getAllValues(TraceContextOrSamplingFlags) - Static method in class brave.baggage.BaggageField: Returns a map of all name to non-{@code null} value pairs in the extracted result.
getByName(TraceContextOrSamplingFlags, String) - Static method in class brave.baggage.BaggageField: Looks up the field by name, useful for when you do not have a reference to it.
getByName(TraceContext, String) - Static method in class brave.baggage.BaggageField: Looks up the field by name, useful for when you do not have a reference to it.
getByName(String) - Static method in class brave.baggage.BaggageField: Like BaggageField.getByName(TraceContext, String) except against the current trace context.
getValue() - Method in class brave.baggage.BaggageField: Like BaggageField.getValue(TraceContext) except against the current trace context.
getValue(TraceContext) - Method in class brave.baggage.BaggageField: Returns the most recent value for this field in the context or null if unavailable.
getValue(TraceContextOrSamplingFlags) - Method in class brave.baggage.BaggageField: Like BaggageField.getValue(TraceContext) except for use cases that precede a span.

H

handle(TraceContext, MutableSpan) - Method in class brave.handler.FinishedSpanHandler: Deprecated.
Since 5.12 use SpanHandler.end(TraceContext, MutableSpan, Cause) with SpanHandler.Cause.FINISHED
handlesAbandoned() - Method in class brave.handler.SpanHandler: Span.abandon() means the data is not intended to be recorded.
hashCode() - Method in class brave.baggage.BaggageField: Returns the same value for any baggage field with the same name (case insensitive).
hashCode() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: Returns the same value for any config with the same baggage field.
hashCode() - Method in class brave.handler.MutableSpan
hashCode() - Method in class brave.propagation.TraceContext: Includes mandatory fields TraceContext.traceIdHigh(), TraceContext.traceId(), TraceContext.spanId() and the shared flag.
hashCode() - Method in class brave.propagation.TraceContextOrSamplingFlags
hashCode() - Method in class brave.propagation.TraceIdContext: Only includes mandatory fields TraceIdContext.traceIdHigh() and TraceIdContext.traceId()

I

id() - Method in class brave.handler.MutableSpan: Returns the span ID.
id(String) - Method in class brave.handler.MutableSpan: Calling this overrides the span ID.
inheritable() - Static method in class brave.propagation.CurrentTraceContext.Default: Uses an inheritable static thread local which allows arbitrary calls to Thread.start() to automatically inherit this context.
inject(TraceContext, R) - Method in interface brave.propagation.TraceContext.Injector: Usually calls a setter for each propagation field to send downstream.
injectFormat(B3Propagation.Format) - Method in class brave.propagation.B3Propagation.FactoryBuilder: Overrides the injection format for non-remote requests, such as message processors.
injectFormat(Span.Kind, B3Propagation.Format) - Method in class brave.propagation.B3Propagation.FactoryBuilder: Overrides the injection format used for the indicated span kind.
injectFormats(Span.Kind, B3Propagation.Format, B3Propagation.Format) - Method in class brave.propagation.B3Propagation.FactoryBuilder: Like B3Propagation.FactoryBuilder.injectFormat(brave.propagation.B3Propagation.Format), but writes two formats.
injector(Propagation.Setter<R, K>) - Method in class brave.baggage.BaggagePropagation
injector(Propagation.Setter<R, K>) - Method in class brave.propagation.ExtraFieldPropagation: Deprecated.
injector(Propagation.Setter<R, K>) - Method in interface brave.propagation.Propagation: Replaces a propagated field with the given value.
INSTANCE - brave.NoopSpanCustomizer
isEmpty() - Method in class brave.handler.MutableSpan: Deprecated.
Since 5.12 use MutableSpan.equals(Object) against a base value.
isLocalRoot() - Method in class brave.propagation.TraceContext
isNoop() - Method in class brave.ScopedSpan: When true, no recording will take place, so no data is reported on finish.
isNoop() - Method in class brave.Span: When true, no recording is done and nothing is reported to zipkin.
isNoop() - Method in class brave.Tracing: When true, no recording is done and nothing is reported to zipkin.
isSampled(long) - Method in class brave.sampler.BoundarySampler: Returns true when abs(traceId) <= boundary
isSampled(long) - Method in class brave.sampler.CountingSampler: loops over the pre-canned decisions, resetting to zero when it gets to the end.
isSampled(long) - Method in class brave.sampler.RateLimitingSampler
isSampled(long) - Method in class brave.sampler.Sampler: Returns true if the trace ID should be measured.

J

joinSpan(TraceContext) - Method in class brave.Tracer: Joining is re-using the same trace and span ids extracted from an incoming RPC request.

K

key() - Method in class brave.Tag
key(I) - Method in class brave.Tag: Overrides the tag key based on the input
key(Throwable) - Method in class brave.ErrorParser: Deprecated.
keyNames() - Method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField: Returns a possibly empty list of lower-case propagation key names.
keys() - Method in class brave.baggage.BaggagePropagation: Only returns trace context keys.
keys() - Method in class brave.propagation.ExtraFieldPropagation: Deprecated.

Only returns trace context keys.
keys() - Method in interface brave.propagation.Propagation: The propagation fields defined.
kind() - Method in class brave.handler.MutableSpan: Returns the span kind or null.
kind(Span.Kind) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as {@link brave.Span#kind(Kind).
kind(Span.Kind) - Method in class brave.Span: When present, the span is remote.

L

local(BaggageField) - Static method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField: Configures this field for only local propagation.
localIp() - Method in class brave.handler.MutableSpan: Returns the primary IP address associated with this service or null.
localIp(String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Tracing.Builder.localIp(String).
localIp(String) - Method in class brave.Tracing.Builder: The text representation of the primary IP address associated with this service.
localPort() - Method in class brave.handler.MutableSpan: Returns the primary listen port associated with this service or zero.
localPort(int) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Tracing.Builder.localPort(int).
localPort(int) - Method in class brave.Tracing.Builder: The primary listen port associated with this service.
localRootId() - Method in class brave.handler.MutableSpan: Returns the local root ID
localRootId() - Method in class brave.propagation.TraceContext: Returns the first TraceContext.spanId() in a partition of a trace: otherwise known as an entry span.
localRootId(String) - Method in class brave.handler.MutableSpan: Calling this overrides the local root ID.
localRootIdString() - Method in class brave.propagation.TraceContext: Returns the hex representation of the span's local root ID
localServiceName() - Method in class brave.handler.MutableSpan: Returns the label of this node in the service graph or null.
localServiceName(String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Tracing.Builder.localServiceName(String).
localServiceName(String) - Method in class brave.Tracing.Builder: Label of the remote node in the service graph, such as "favstar".

M

Matcher - Interface in brave.sampler: Returns true if this rule matches the input parameters
Matchers - Class in brave.sampler: Convenience functions to compose matchers for ParameterizedSampler.
Matchers() - Constructor for class brave.sampler.Matchers
matches(P) - Method in interface brave.sampler.Matcher
matches(P) - Method in class brave.sampler.ParameterizedSampler.Rule: Deprecated.
maybeScope(TraceContext) - Method in class brave.propagation.CurrentTraceContext: Like CurrentTraceContext.newScope(TraceContext), except returns CurrentTraceContext.Scope.NOOP if the given context is already in scope.
maybeScope(TraceContext) - Method in class brave.propagation.StrictCurrentTraceContext
MULTI - brave.propagation.B3Propagation.Format: The trace context is encoded with a several fields prefixed with "x-b3-".
MutableSpan - Class in brave.handler: This represents a span except for its TraceContext.
MutableSpan() - Constructor for class brave.handler.MutableSpan
MutableSpan(MutableSpan) - Constructor for class brave.handler.MutableSpan
MutableSpan(TraceContext, MutableSpan) - Constructor for class brave.handler.MutableSpan: Creates a new instance from the given context, and defaults in the span.
MutableSpan.AnnotationConsumer<T> - Interface in brave.handler
MutableSpan.AnnotationUpdater - Interface in brave.handler
MutableSpan.TagConsumer<T> - Interface in brave.handler
MutableSpan.TagUpdater - Interface in brave.handler
MutableSpanBytesEncoder - Class in brave.handler: Similar to zipkin2.MutableSpan.SpanBytesEncoder except no Zipkin dependency.
MutableSpanBytesEncoder() - Constructor for class brave.handler.MutableSpanBytesEncoder

N

name() - Method in class brave.baggage.BaggageField: The non-empty name of the field.
name() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: The name to use in the correlation context.
name() - Method in class brave.handler.MutableSpan: Returns the span name or null
name(String) - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField.Builder
name(String) - Method in class brave.CurrentSpanCustomizer: Sets the string name for the logical operation this span represents.
name(String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such asSpanCustomizer.name(String).
name(String) - Method in enum brave.NoopSpanCustomizer
name(String) - Method in class brave.ScopedSpan: Sets the string name for the logical operation this span represents.
name(String) - Method in class brave.Span: Sets the string name for the logical operation this span represents.
name(String) - Method in interface brave.SpanCustomizer: Sets the string name for the logical operation this span represents.
NEVER_SAMPLE - Static variable in class brave.sampler.Sampler
neverMatch() - Static method in class brave.sampler.Matchers
neverSample() - Static method in class brave.sampler.SamplerFunctions: Ignores the argument and returns false.
newBuilder() - Static method in class brave.propagation.StrictCurrentTraceContext
newBuilder() - Static method in class brave.propagation.ThreadLocalCurrentTraceContext
newBuilder() - Static method in class brave.propagation.TraceContext
newBuilder() - Static method in class brave.propagation.TraceContextOrSamplingFlags: Deprecated.
Since 5.12, use TraceContextOrSamplingFlags.newBuilder(TraceContext), TraceContextOrSamplingFlags.newBuilder(TraceIdContext) or TraceContextOrSamplingFlags.newBuilder(SamplingFlags).
newBuilder() - Static method in class brave.propagation.TraceIdContext
newBuilder() - Static method in class brave.sampler.ParameterizedSampler
newBuilder() - Static method in class brave.Tracing
newBuilder(BaggageField) - Static method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField
newBuilder(BaggageField) - Static method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField
newBuilder(SamplingFlags) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object).
newBuilder(TraceContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object).
newBuilder(TraceIdContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object).
newChild(TraceContext) - Method in class brave.Tracer: Explicitly creates a child within an existing trace.
newFactory(Propagation.Factory, String...) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggagePropagation.newFactoryBuilder(Propagation.Factory)
newFactory(Propagation.Factory, Collection<String>) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggagePropagation.newFactoryBuilder(Propagation.Factory)
newFactoryBuilder() - Static method in class brave.propagation.B3Propagation
newFactoryBuilder(Propagation.Factory) - Static method in class brave.baggage.BaggagePropagation: Wraps an underlying propagation implementation, pushing one or more fields.
newFactoryBuilder(Propagation.Factory) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggagePropagation.newFactoryBuilder(Propagation.Factory)
newScope(TraceContext) - Method in class brave.propagation.CurrentTraceContext: Sets the current span in scope until the returned object is closed.
newScope(TraceContext) - Method in class brave.propagation.StrictCurrentTraceContext
newScope(TraceContext) - Method in class brave.propagation.ThreadLocalCurrentTraceContext
newTrace() - Method in class brave.Tracer: Explicitly creates a new trace.
next() - Method in class brave.propagation.ThreadLocalSpan: Returns the Tracer.nextSpan() or null if ThreadLocalSpan.CURRENT_TRACER and tracing isn't available.
next(TraceContextOrSamplingFlags) - Method in class brave.propagation.ThreadLocalSpan: Returns the Tracer.nextSpan(TraceContextOrSamplingFlags) or null if ThreadLocalSpan.CURRENT_TRACER and tracing isn't available.
nextSpan() - Method in class brave.Tracer: Returns a new child span if there's a Tracer.currentSpan() or a new trace if there isn't.
nextSpan(TraceContextOrSamplingFlags) - Method in class brave.Tracer: This creates a new span based on parameters extracted from an incoming request.
nextSpan(SamplerFunction<T>, T) - Method in class brave.Tracer: Like Tracer.nextSpan() except when there is no trace in process, the sampler triggers against the supplied argument.
nextSpanWithParent(SamplerFunction<T>, T, TraceContext) - Method in class brave.Tracer: Like Tracer.nextSpan(SamplerFunction, Object) except this controls the parent context explicitly.
NOOP - Static variable in interface brave.baggage.BaggageField.ValueUpdater
NOOP - Static variable in interface brave.baggage.BaggagePropagationCustomizer: Use to avoid comparing against null references
NOOP - Static variable in interface brave.baggage.CorrelationScopeCustomizer: Use to avoid comparing against null references
NOOP - Static variable in class brave.ErrorParser: Deprecated.

Adds no tags to the span representing the operation in error.
NOOP - Static variable in class brave.handler.FinishedSpanHandler: Deprecated.
Since 5.12 use SpanHandler.NOOP
NOOP - Static variable in class brave.handler.SpanHandler: Use to avoid comparing against null references.
NOOP - Static variable in interface brave.propagation.CurrentTraceContext.Scope: Returned when CurrentTraceContext.maybeScope(TraceContext) detected scope redundancy.
NOOP - Static variable in interface brave.propagation.CurrentTraceContext.ScopeDecorator: Use this when configuration results in no decoration needed.
NOOP - Static variable in interface brave.propagation.CurrentTraceContextCustomizer: Use to avoid comparing against null references
NOOP - Static variable in interface brave.propagation.ExtraFieldCustomizer: Deprecated.

Use to avoid comparing against null references
NOOP - Static variable in interface brave.TracingCustomizer: Use to avoid comparing against null references
NoopSpanCustomizer - Enum in brave: Performs no operations as the span represented by this is not sampled to report to the tracing system.
NOT_SAMPLED - Static variable in class brave.propagation.SamplingFlags
NOT_SAMPLED - Static variable in class brave.propagation.TraceContextOrSamplingFlags
nullSafe(SamplerFunction<T>) - Static method in class brave.sampler.SamplerFunctions: Returns a function that returns null on null input instead of invoking the delegate with null.

O

or(Matcher...) - Static method in class brave.sampler.Matchers
or(Iterable<? extends Matcher>) - Static method in class brave.sampler.Matchers
ORPHANED - brave.handler.SpanHandler.Cause: Called when the trace context was garbage collected prior to completion.

P

ParameterizedSampler - Class in brave.sampler: This is an implementation of how to decide whether to trace a request using ordered rules.
ParameterizedSampler.Builder - Class in brave.sampler
ParameterizedSampler.Rule - Class in brave.sampler: Deprecated.
Since 5.8, use ParameterizedSampler.Builder.putRule(Matcher, Sampler)
PARENT_ID - Static variable in class brave.baggage.BaggageFields: Typically only useful when spans are parsed from log records.
parentId() - Method in class brave.handler.MutableSpan: Returns the parent ID or null
parentId() - Method in class brave.propagation.TraceContext: The parent's TraceContext.spanId or null if this the root span in a trace.
parentId(long) - Method in class brave.propagation.TraceContext.Builder
parentId(Long) - Method in class brave.propagation.TraceContext.Builder
parentId(String) - Method in class brave.handler.MutableSpan: Calling this overrides the parent ID.
parentIdAsLong() - Method in class brave.propagation.TraceContext: Like TraceContext.parentId() except returns a primitive where zero implies absent.
parentIdString() - Method in class brave.propagation.TraceContext: Returns the hex representation of the span's parent ID
parseB3SingleFormat(CharSequence) - Static method in class brave.propagation.B3SingleFormat
parseB3SingleFormat(CharSequence, int, int) - Static method in class brave.propagation.B3SingleFormat: This reads a trace context a sequence potentially larger than the format.
parseValue(I, TraceContext) - Method in class brave.Tag: Override to change what data from the input are parsed into the span modeling it.
parseValue(Throwable, TraceContext) - Method in class brave.ErrorParser: Deprecated.
PRODUCER - brave.Span.Kind: When present, Span.start() is the moment a producer sent a message to a destination.
propagation() - Method in class brave.Tracing: When a trace leaves the process, it needs to be propagated, usually via headers.
Propagation<K> - Interface in brave.propagation: Injects and extracts trace identifiers as text into requests that travel in-band across process boundaries.
Propagation.Factory - Class in brave.propagation
Propagation.Getter<R,K> - Interface in brave.propagation: Gets the first value of the given propagation key or returns null.
Propagation.KeyFactory<K> - Interface in brave.propagation: Deprecated.
since 5.12 non-string keys are no longer supported
Propagation.RemoteGetter<R> - Interface in brave.propagation: Used as an input to Propagation.extractor(Getter) extract the trace context and any baggage from propagated fields.
Propagation.RemoteSetter<R> - Interface in brave.propagation: Used as an input to Propagation.injector(Setter) inject the trace context and any baggage as propagated fields.
Propagation.Setter<R,K> - Interface in brave.propagation: Replaces a propagated key with the given value.
propagationFactory() - Method in class brave.Tracing: Deprecated.
Since 5.12 use Tracing.propagation() as non-string keys are unsupported.
propagationFactory(Propagation.Factory) - Method in class brave.Tracing.Builder: Controls how trace contexts are injected or extracted from remote requests, such as from http headers.
put(R, String, String) - Method in interface brave.propagation.Propagation.RemoteSetter: Replaces a propagation field with the given value.
put(R, K, String) - Method in interface brave.propagation.Propagation.Setter
putAllRules(ParameterizedSampler) - Method in class brave.sampler.ParameterizedSampler.Builder: Adds or replaces all rules in this sampler with those of the input.
putRule(Matcher, Sampler) - Method in class brave.sampler.ParameterizedSampler.Builder: Adds or replaces the sampler of the input matcher.

R

RateLimitingSampler - Class in brave.sampler: The rate-limited sampler allows you to choose an amount of traces to accept on a per-second interval.
readOnly() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: Returns true if this value is immutable within a TraceContext.
remote(BaggageField) - Static method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField: Configures this field for remote propagation using its lower-case BaggageField.name() as the only propagation key name.
remoteEndpoint(Endpoint) - Method in class brave.Span: Deprecated.
Since 5.0, use Span.remoteServiceName(String) Span.remoteIpAndPort(String, int).
remoteIp() - Method in class brave.handler.MutableSpan: Returns the IP of the remote service or null.
remoteIp(String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as from Span.remoteIpAndPort(String, int).
remoteIpAndPort(String, int) - Method in class brave.handler.MutableSpan: When remoteIp is not null, calling this overrides any previous value, such as Span.remoteIpAndPort(String, int).
remoteIpAndPort(String, int) - Method in class brave.Span: Sets the IP and port associated with the remote endpoint.
remotePort() - Method in class brave.handler.MutableSpan: Returns the port of the remote service or zero.
remotePort(int) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as from Span.remoteIpAndPort(String, int).
remoteServiceName() - Method in class brave.handler.MutableSpan: Returns the primary label of the remote service or null.
remoteServiceName(String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Span.remoteServiceName(String).
remoteServiceName(String) - Method in class brave.Span: Lower-case label of the remote node in the service graph, such as "favstar".
remove() - Method in class brave.propagation.ThreadLocalSpan: Returns the span set in scope via ThreadLocalSpan.next() or null if there was none.
removeTag(String) - Method in class brave.handler.MutableSpan: Removes and returns the last tag value associated with the key or returns null if it was never set.
request() - Method in class brave.Response: The request that initiated this response or null if unknown.
Request - Class in brave: Abstract request type used for parsing and sampling.
Request() - Constructor for class brave.Request
requires128BitTraceId() - Method in class brave.propagation.ExtraFieldPropagation.Factory: Deprecated.
requires128BitTraceId() - Method in class brave.propagation.Propagation.Factory: Returns true if the implementation cannot use 64-bit trace IDs.
Response - Class in brave: Abstract response type used for parsing.
Response() - Constructor for class brave.Response
Rule(float) - Constructor for class brave.sampler.ParameterizedSampler.Rule: Deprecated.

S

sample(M) - Method in class brave.sampler.DeclarativeSampler: Deprecated.
Since 5.8, use DeclarativeSampler.trySample(Object)
sample(P) - Method in class brave.sampler.ParameterizedSampler: Deprecated.
Since 5.8, use ParameterizedSampler.trySample(Object)
sampled() - Method in class brave.propagation.SamplingFlags: Sampled means send span data to Zipkin (or something else compatible with its data).
sampled() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns SamplingFlags.sampled(), regardless of subtype.
sampled(boolean) - Method in class brave.propagation.TraceContext.Builder
sampled(boolean) - Method in class brave.propagation.TraceContextOrSamplingFlags: This is used to apply a SamplerFunction decision with least overhead.
sampled(boolean) - Method in class brave.propagation.TraceIdContext.Builder
sampled(Boolean) - Method in class brave.propagation.SamplingFlags.Builder: Deprecated.
sampled(Boolean) - Method in class brave.propagation.TraceContext.Builder
sampled(Boolean) - Method in class brave.propagation.TraceContextOrSamplingFlags: Deprecated.
do not use object variant.. only set when you have a sampling decision
sampled(Boolean) - Method in class brave.propagation.TraceIdContext.Builder
SAMPLED - Static variable in class brave.baggage.BaggageFields: This is only useful when BaggageFields.TRACE_ID is also a baggage field.
SAMPLED - Static variable in class brave.propagation.SamplingFlags
SAMPLED - Static variable in class brave.propagation.TraceContextOrSamplingFlags
sampledLocal() - Method in class brave.propagation.SamplingFlags: True records this trace locally even if it is not sampled downstream.
sampledLocal() - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder
sampledLocal() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns SamplingFlags.sampledLocal(), regardless of subtype.
sampledLocal(boolean) - Method in class brave.propagation.TraceContext.Builder
sampler() - Method in class brave.Tracing: Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
sampler(Sampler) - Method in class brave.Tracing.Builder: Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
Sampler - Class in brave.sampler: Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
Sampler() - Constructor for class brave.sampler.Sampler
SamplerFunction<T> - Interface in brave.sampler: Decides whether to start a new trace based on request properties such as an HTTP path.
SamplerFunctions - Class in brave.sampler: Convenience sampling functions.
SamplerFunctions() - Constructor for class brave.sampler.SamplerFunctions
samplingFlags() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns non-null when a trace ID was not extracted from a request.
samplingFlags(SamplingFlags) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Deprecated.
Since 5.12, use TraceContextOrSamplingFlags.newBuilder(SamplingFlags)
SamplingFlags - Class in brave.propagation
SamplingFlags.Builder - Class in brave.propagation: Deprecated.
prefer using constants. This will be removed in Brave v6
ScopedSpan - Class in brave: Used to model the latency of an operation within a method block.
SERVER - brave.Span.Kind
set(TraceContext, String, String) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getByName(TraceContext, String) and BaggageField.updateValue(String)
set(String, String) - Static method in class brave.propagation.ExtraFieldPropagation: Deprecated.
Since 5.11 use BaggageField.getByName(String) and BaggageField.updateValue(String)
setDebug() - Method in class brave.handler.MutableSpan: Calling this is unexpected as it should only be initialized by SamplingFlags.debug().
setNoop(boolean) - Method in class brave.Tracing: Set true to drop data and only return noop spans regardless of sampling policy.
setShared() - Method in class brave.handler.MutableSpan: Calling this is unexpected as it should only be initialized by TraceContext.shared().
shared() - Method in class brave.handler.MutableSpan: Returns true if the context was shared.
shared() - Method in class brave.propagation.TraceContext: True if we are recording a server span with the same span ID parsed from incoming headers.
shared(boolean) - Method in class brave.propagation.TraceContext.Builder
SINGLE - brave.propagation.B3Propagation.Format: The trace context is encoded with B3SingleFormat.writeB3SingleFormat(TraceContext).
SINGLE_NO_PARENT - brave.propagation.B3Propagation.Format: The trace context is encoded with B3SingleFormat.writeB3SingleFormatWithoutParentId(TraceContext).
sizeInBytes(MutableSpan) - Method in class brave.handler.MutableSpanBytesEncoder
Span - Class in brave: Subtype of SpanCustomizer which can capture latency and remote context of an operation.
SPAN_ID - Static variable in class brave.baggage.BaggageFields: Used with BaggageFields.TRACE_ID to correlate a log line with a span.
Span.Kind - Enum in brave
SpanCustomizer - Interface in brave: Simple interface users can customize a span with.
SpanHandler - Class in brave.handler: This tracks one recording of a TraceContext.
SpanHandler() - Constructor for class brave.handler.SpanHandler
SpanHandler.Cause - Enum in brave.handler: What ended the data collection?
spanHandlers() - Method in class brave.Tracing.Builder: Returns an immutable copy of the current span handlers.
spanId() - Method in class brave.propagation.TraceContext: Unique 8-byte identifier of this span within a trace.
spanId(long) - Method in class brave.propagation.TraceContext.Builder
spanIdString() - Method in class brave.propagation.TraceContext: Returns the hex representation of the span's ID
spanKind() - Method in interface brave.propagation.Propagation.RemoteGetter: The only valid options are Span.Kind.SERVER, Span.Kind.PRODUCER, and Span.Kind.CONSUMER.
spanKind() - Method in interface brave.propagation.Propagation.RemoteSetter: The only valid options are Span.Kind.CLIENT, Span.Kind.PRODUCER, and Span.Kind.CONSUMER.
spanKind() - Method in class brave.Request: The remote Span.Kind describing the direction and type of the request.
spanKind() - Method in class brave.Response: The remote Span.Kind describing the direction and type of the response.
spanReporter(Reporter) - Method in class brave.Tracing.Builder: Deprecated.
Since 5.12, use Tracing.Builder.addSpanHandler(SpanHandler) with a ZipkinSpanHandler
start() - Method in class brave.Span: Starts the span with an implicit timestamp.
start(long) - Method in class brave.Span: Like Span.start(), except with a given timestamp in microseconds.
startScopedSpan(String) - Method in class brave.Tracer: Returns a new child span if there's a Tracer.currentSpan() or a new trace if there isn't.
startScopedSpan(String, SamplerFunction<T>, T) - Method in class brave.Tracer: Like Tracer.startScopedSpan(String) except when there is no trace in process, the sampler triggers against the supplied argument.
startScopedSpanWithParent(String, TraceContext) - Method in class brave.Tracer: Same as Tracer.startScopedSpan(String), except ignores the current trace context.
startTimestamp() - Method in class brave.handler.MutableSpan: Returns the span start timestamp or zero.
startTimestamp(long) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as Span.start(long) or Tracer.startScopedSpan(String).
StrictCurrentTraceContext - Class in brave.propagation: Useful when developing instrumentation as state is enforced more strictly.
StrictCurrentTraceContext() - Constructor for class brave.propagation.StrictCurrentTraceContext
StrictCurrentTraceContext.Builder - Class in brave.propagation
StrictScopeDecorator - Class in brave.propagation: Useful when developing instrumentation as state is enforced more strictly.
STRING - Static variable in interface brave.propagation.Propagation.KeyFactory: Deprecated.
supportsJoin() - Method in class brave.propagation.ExtraFieldPropagation.Factory: Deprecated.
supportsJoin() - Method in class brave.propagation.Propagation.Factory: Does the propagation implementation support sharing client and server span IDs.
supportsJoin(boolean) - Method in class brave.Tracing.Builder: True means the tracing system supports sharing a span ID between a Span.Kind.CLIENT and Span.Kind.SERVER span.
supportsOrphans() - Method in class brave.handler.FinishedSpanHandler: Deprecated.
Since 5.12 use SpanHandler.end(TraceContext, MutableSpan, Cause) with SpanHandler.Cause.ORPHANED

T

tag(I, TraceContext, MutableSpan) - Method in class brave.Tag: Tags the value parsed from the input.
tag(I, TraceContext, SpanCustomizer) - Method in class brave.Tag: Tags the value parsed from the input.
tag(I, ScopedSpan) - Method in class brave.Tag: Tags the value parsed from the input.
tag(I, Span) - Method in class brave.Tag: Tags the value parsed from the input.
tag(I, SpanCustomizer) - Method in class brave.Tag: Tags the value parsed from the input.
tag(Object, String, String) - Method in class brave.ErrorParser: Deprecated.

Same behaviour as SpanCustomizer.tag(String, String)
tag(String) - Method in class brave.handler.MutableSpan: Returns the last tag value associated with the key or null.
tag(String, String) - Method in class brave.CurrentSpanCustomizer: Tags give your span context for search, viewing and analysis.
tag(String, String) - Method in class brave.handler.MutableSpan: Calling this overrides any previous value, such as SpanCustomizer.tag(String, String).
tag(String, String) - Method in enum brave.NoopSpanCustomizer
tag(String, String) - Method in class brave.ScopedSpan: Tags give your span context for search, viewing and analysis.
tag(String, String) - Method in class brave.Span: Tags give your span context for search, viewing and analysis.
tag(String, String) - Method in interface brave.SpanCustomizer: Tags give your span context for search, viewing and analysis.
Tag - Class in brave: This is a centralized type to parse a tag into any variant of a span.
Tag(String) - Constructor for class brave.Tag
tagCount() - Method in class brave.handler.MutableSpan
tagKeyAt(int) - Method in class brave.handler.MutableSpan: Returns the tag key at the given index or throws IndexOutOfBoundsException if the index is invalid.
tags() - Method in class brave.handler.MutableSpan: A read-only view of the current tags a map.
Tags - Class in brave: Standard tags used in parsers
tagValueAt(int) - Method in class brave.handler.MutableSpan: Returns the possibly empty value at the given index or throws IndexOutOfBoundsException if the index is invalid.
ThreadLocalCurrentTraceContext - Class in brave.propagation: In-process trace context propagation backed by a static thread local.
ThreadLocalCurrentTraceContext.Builder - Class in brave.propagation
ThreadLocalSpan - Class in brave.propagation: This type allows you to place a span in scope in one method and access it in another without using an explicit request parameter.
toBuilder() - Method in class brave.baggage.BaggagePropagationConfig.SingleBaggageField: Allows decorators to reconfigure correlation of this BaggagePropagationConfig.SingleBaggageField.field()
toBuilder() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField: Allows decorators to reconfigure correlation of this CorrelationScopeConfig.SingleCorrelationField.baggageField()
toBuilder() - Method in class brave.propagation.TraceContext
toBuilder() - Method in class brave.propagation.TraceContextOrSamplingFlags: Use to decorate an extraction result with TraceContextOrSamplingFlags.sampledLocal() or additional TraceContextOrSamplingFlags.extra().
toBuilder() - Method in class brave.propagation.TraceIdContext
toSampler(M) - Method in class brave.sampler.DeclarativeSampler: Deprecated.
Since 5.8, use Tracer.startScopedSpan(String, SamplerFunction, Object)
toSampler(M, Sampler) - Method in class brave.sampler.DeclarativeSampler: Deprecated.
Since 5.8, use Tracer.startScopedSpan(String, SamplerFunction, Object)
toSpan(TraceContext) - Method in class brave.Tracer: Converts the context to a Span object after decorating it for propagation.
toString() - Method in class brave.baggage.BaggageField
toString() - Method in class brave.baggage.CorrelationScopeConfig.SingleCorrelationField
toString() - Method in class brave.handler.MutableSpan
toString() - Method in enum brave.NoopSpanCustomizer
toString() - Method in class brave.propagation.SamplingFlags
toString() - Method in class brave.propagation.TraceContext: Returns $traceId/$spanId
toString() - Method in class brave.propagation.TraceContextOrSamplingFlags
toString() - Method in class brave.propagation.TraceIdContext: Returns $traceId
toString() - Method in class brave.Request
toString() - Method in class brave.Response
toString() - Method in class brave.sampler.BoundarySampler
toString() - Method in class brave.sampler.CountingSampler
toString() - Method in class brave.Tag
toString() - Method in class brave.Tracer.SpanInScope
toString() - Method in class brave.Tracer
TRACE_ID - Static variable in class brave.baggage.BaggageFields: This is the most common log correlation field.
TraceContext - Class in brave.propagation: Contains trace identifiers and sampling data propagated in and out-of-process.
TraceContext.Builder - Class in brave.propagation
TraceContext.Extractor<R> - Interface in brave.propagation: Used to continue an incoming trace.
TraceContext.Injector<R> - Interface in brave.propagation: Used to send the trace context downstream.
TraceContextOrSamplingFlags - Class in brave.propagation: Union type that contains only one of trace context, trace ID context or sampling flags.
TraceContextOrSamplingFlags.Builder - Class in brave.propagation
traceId() - Method in class brave.handler.MutableSpan: Returns the trace ID
traceId() - Method in class brave.propagation.TraceContext: Unique 8-byte identifier for a trace, set on all spans within it.
traceId() - Method in class brave.propagation.TraceIdContext: Unique 8-byte identifier for a trace, set on all spans within it.
traceId(long) - Method in class brave.propagation.TraceContext.Builder
traceId(long) - Method in class brave.propagation.TraceIdContext.Builder
traceId(String) - Method in class brave.handler.MutableSpan: Calling this overrides the trace ID.
traceId128Bit(boolean) - Method in class brave.Tracing.Builder: When true, new root spans will have 128-bit trace IDs.
traceIdContext() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns non-null when a trace ID was extracted from a request, but a span ID was not.
traceIdContext(TraceIdContext) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Deprecated.
Since 5.12, use TraceContextOrSamplingFlags.newBuilder(TraceIdContext)
TraceIdContext - Class in brave.propagation: 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 - Class in brave.propagation
traceIdHigh() - Method in class brave.propagation.TraceContext: When non-zero, the trace containing this span uses 128-bit trace identifiers.
traceIdHigh() - Method in class brave.propagation.TraceIdContext: When non-zero, the trace containing this span uses 128-bit trace identifiers.
traceIdHigh(long) - Method in class brave.propagation.TraceContext.Builder
traceIdHigh(long) - Method in class brave.propagation.TraceIdContext.Builder
traceIdString() - Method in class brave.propagation.TraceContext: Returns the hex representation of the span's trace ID
traceIdString() - Method in class brave.propagation.TraceIdContext: Returns the hex representation of the span's trace ID
tracer() - Method in class brave.Tracing: All tracing commands start with a Span.
Tracer - Class in brave: Using a tracer, you can create a root span capturing the critical path of a request.
Tracer.SpanInScope - Class in brave: A span remains in the scope it was bound to until close is called.
Tracing - Class in brave: This provides utilities needed for trace instrumentation.
Tracing.Builder - Class in brave
TracingCustomizer - Interface in brave: This allows configuration plugins to collaborate on building an instance of Tracing.
trackOrphans() - Method in class brave.Tracing.Builder: When true, a SpanHandler is added that logs the caller which orphaned a span to the category "brave.Tracer" at Level.FINE.
trySample(M) - Method in class brave.sampler.DeclarativeSampler: Returns an overriding sampling decision for a new trace.
trySample(P) - Method in class brave.sampler.ParameterizedSampler: Returns an overriding sampling decision for a new trace.
trySample(T) - Method in interface brave.sampler.SamplerFunction: Returns an overriding sampling decision for a new trace.

U

unsetDebug() - Method in class brave.handler.MutableSpan
unsetShared() - Method in class brave.handler.MutableSpan
unwrap() - Method in class brave.Request: Returns the underlying request object or null if there is none.
unwrap() - Method in class brave.Response: Returns the underlying response object or null if there is none.
update(long, String) - Method in interface brave.handler.MutableSpan.AnnotationUpdater: Returns the same value, an updated one, or null to drop the annotation.
update(String, String) - Method in interface brave.handler.MutableSpan.TagUpdater: Returns the same value, an updated one, or null to drop the tag.
updateValue(BaggageField, String) - Method in interface brave.baggage.BaggageField.ValueUpdater: Updates the value of the field, or ignores if read-only or not configured.
updateValue(TraceContextOrSamplingFlags, String) - Method in class brave.baggage.BaggageField: Like BaggageField.updateValue(TraceContext, String) except for use cases that precede a span.
updateValue(TraceContext, String) - Method in class brave.baggage.BaggageField: Updates the value of this field, or ignores if read-only or not configured.
updateValue(String) - Method in class brave.baggage.BaggageField: Like BaggageField.updateValue(TraceContext, String) except against the current trace context.

V

validateNonEmpty(String, String) - Static method in class brave.Tag
value(I, TraceContext) - Method in class brave.Tag: Returns the value that would be tagged to the span or null.
valueOf(String) - Static method in enum brave.handler.SpanHandler.Cause: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum brave.NoopSpanCustomizer: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum brave.propagation.B3Propagation.Format: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum brave.Span.Kind: Returns the enum constant of this type with the specified name.
values() - Static method in enum brave.handler.SpanHandler.Cause: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum brave.NoopSpanCustomizer: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum brave.propagation.B3Propagation.Format: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum brave.Span.Kind: Returns an array containing the constants of this enum type, in the order they are declared.

W

withSampler(Sampler) - Method in class brave.Tracer: Deprecated.
Since 5.8, use Tracer.nextSpan(SamplerFunction, Object) or Tracer.startScopedSpan(String, SamplerFunction, Object)
withSpanInScope(Span) - Method in class brave.Tracer: Makes the given span the "current span" and returns an object that exits that scope on close.
wrap(Runnable) - Method in class brave.propagation.CurrentTraceContext: Wraps the input so that it executes with the same context as now.
wrap(Callable<C>) - Method in class brave.propagation.CurrentTraceContext: Wraps the input so that it executes with the same context as now.
writeB3SingleFormat(TraceContext) - Static method in class brave.propagation.B3SingleFormat: Writes all B3 defined fields in the trace context to a hyphen delimited string.
writeB3SingleFormatAsBytes(TraceContext) - Static method in class brave.propagation.B3SingleFormat: Like B3SingleFormat.writeB3SingleFormat(TraceContext), but for requests with byte array or byte buffer values.
writeB3SingleFormatWithoutParentId(TraceContext) - Static method in class brave.propagation.B3SingleFormat: Writes all B3 defined fields in the trace context, except parent ID, to a hyphen delimited string.
writeB3SingleFormatWithoutParentIdAsBytes(TraceContext) - Static method in class brave.propagation.B3SingleFormat: Like B3SingleFormat.writeB3SingleFormatWithoutParentId(TraceContext), but for requests with byte array or byte buffer values.

Z

zipkinJsonV2(Tag<Throwable>) - Static method in class brave.handler.MutableSpanBytesEncoder

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes All Packages