Index (Brave 5.10.0 API)

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

A

abandon() - Method in class brave.Span: Throws away the current span without reporting it.
accept(T, long, String) - Method in interface brave.handler.MutableSpan.AnnotationConsumer
accept(T, String, String) - Method in interface brave.handler.MutableSpan.TagConsumer
addExtra(Object) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder
addField(String) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Adds a field that is referenced the same in-process as it is on the wire.
addFinishedSpanHandler(FinishedSpanHandler) - Method in class brave.Tracing.Builder: Similar to Tracing.Builder.spanReporter(Reporter) except it can read the trace context and create more efficient or completely different data structures.
addPrefixedFields(String, Collection<String>) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Adds a prefix when fields are extracted or injected from headers.
addRedactedField(String) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Same as ExtraFieldPropagation.FactoryBuilder.addField(java.lang.String) except that this field is redacted from downstream propagation.
addScopeDecorator(CurrentTraceContext.ScopeDecorator) - Method in class brave.propagation.CurrentTraceContext.Builder: Implementations call decorators in order to add features like log correlation to a scope.
ALWAYS_SAMPLE - Static variable in class brave.sampler.Sampler
alwaysMatch() - Static method in class brave.sampler.Matchers
alwaysReportSpans() - Method in class brave.Tracing.Builder: When true, all spans sampled locally are reported to the span reporter, even if they aren't sampled remotely.
alwaysSampleLocal() - Method in class brave.handler.FinishedSpanHandler: 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
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: 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.

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
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.
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.handler - package brave.handler
brave.propagation - package brave.propagation
brave.sampler - package brave.sampler
build() - Method in class brave.propagation.B3Propagation.FactoryBuilder
build() - Method in class brave.propagation.CurrentTraceContext.Builder
build() - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder
build() - Method in class brave.propagation.SamplingFlags.Builder: Deprecated.
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.

C

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.timestamp() and Annotation.timestamp().
close() - Method in interface brave.propagation.CurrentTraceContext.Scope: No exceptions are thrown when unbinding a span scope.
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()
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
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
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.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(Propagation.KeyFactory<K>) - Method in class brave.propagation.ExtraFieldPropagation.Factory
create(Propagation.KeyFactory<K>) - Method in class brave.propagation.Propagation.Factory
create(SamplingFlags) - Static method in class brave.propagation.TraceContextOrSamplingFlags
create(TraceContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags
create(TraceIdContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags
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
create(String) - Method in interface brave.propagation.Propagation.KeyFactory
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: Synonym for ExtraFieldPropagation.get(String)
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 fields 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(CurrentTraceContext.Builder) - Method in interface brave.propagation.CurrentTraceContextCustomizer
customize(ExtraFieldPropagation.FactoryBuilder) - Method in interface brave.propagation.ExtraFieldCustomizer
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.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
decorate(TraceContext) - Method in class brave.propagation.Propagation.Factory: Decorates the input such that it can propagate extra data, such as a timestamp or a carrier for extra fields.
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 assertion errors when a scope is closed on a different thread.
deferDecision() - Static method in class brave.sampler.SamplerFunctions: Ignores the argument and returns null.

E

EMPTY - Static variable in class brave.propagation.SamplingFlags
EMPTY - Static variable in class brave.propagation.TraceContextOrSamplingFlags
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.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
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
error(Throwable) - Method in class brave.ScopedSpan: Adds tags depending on the configured error parser
error(Throwable) - Method in class brave.Span: Adds tags depending on the configured error parser
error(Throwable, MutableSpan) - Method in class brave.ErrorParser: Used to parse errors on a subtype of MutableSpan
error(Throwable, ScopedSpan) - Method in class brave.ErrorParser: Used to parse errors on a subtype of ScopedSpan
error(Throwable, SpanCustomizer) - Method in class brave.ErrorParser: Used to parse errors on a subtype of SpanCustomizer
error(Throwable, Object) - Method in class brave.ErrorParser: Override to change what data from the error are parsed into the span modeling it.
errorParser() - Method in class brave.Tracing
errorParser(ErrorParser) - Method in class brave.Tracing.Builder
ErrorParser - Class in brave: This is a simplified type used for parsing errors.
ErrorParser() - Constructor for class brave.ErrorParser
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: Non-empty when TraceContextOrSamplingFlags.context() is null: A list of additional data extracted from the carrier.
extra(List<Object>) - Method in class brave.propagation.TraceContext.Builder: Shares the input with the builder, replacing any current data in the builder.
extra(List<Object>) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder: Shares the input with the builder, replacing any current data in the builder.
extract(C) - Method in interface brave.propagation.TraceContext.Extractor: Returns either a trace context or sampling flags parsed from the carrier.
extractor(Propagation.Getter<C, K>) - Method in class brave.propagation.B3Propagation
extractor(Propagation.Getter<C, K>) - Method in class brave.propagation.ExtraFieldPropagation
extractor(Propagation.Getter<C, K>) - Method in interface brave.propagation.Propagation
ExtraFieldCustomizer - Interface in brave.propagation: This allows configuration plugins to collaborate on building an instance of ExtraFieldPropagation.Factory.
ExtraFieldPropagation<K> - Class in brave.propagation: Allows you to propagate predefined request-scoped fields, usually but not always HTTP headers.
ExtraFieldPropagation.Factory - Class in brave.propagation
ExtraFieldPropagation.FactoryBuilder - Class in brave.propagation
extraKeys() - Method in class brave.propagation.ExtraFieldPropagation: Returns the extra keys this component can extract.

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.
findExtra(Class<T>) - Method in class brave.propagation.TraceContext: Returns an extra 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.
FinishedSpanHandler - Class in brave.handler: Triggered on each finished span except when spans that are no-op.
FinishedSpanHandler() - Constructor for class brave.handler.FinishedSpanHandler
finishTimestamp() - Method in class brave.handler.MutableSpan: Returns the span finish timestamp or zero
finishTimestamp(long) - Method in class brave.handler.MutableSpan
flush() - Method in class brave.Span: Reports the span, even if unfinished.
forEachAnnotation(MutableSpan.AnnotationConsumer<T>, T) - Method in class brave.handler.MutableSpan: Allows you to copy all data into a different target, such as a different span model or logs.
forEachAnnotation(MutableSpan.AnnotationUpdater) - Method in class brave.handler.MutableSpan: Allows you to update values for redaction purposes
forEachTag(MutableSpan.TagConsumer<T>, T) - Method in class brave.handler.MutableSpan
forEachTag(MutableSpan.TagUpdater) - Method in class brave.handler.MutableSpan: Allows you to update values for redaction purposes

G

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.ThreadLocalCurrentTraceContext
get(TraceContext, String) - Static method in class brave.propagation.ExtraFieldPropagation: Returns the value of the field with the specified key or null if not available
get(C, K) - Method in interface brave.propagation.Propagation.Getter
get(String) - Static method in class brave.propagation.ExtraFieldPropagation: Returns the value of the field with the specified key or null if not available.
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
getAll() - Static method in class brave.propagation.ExtraFieldPropagation: Returns a mapping of fields in the current trace context, or empty if there are none.
getAll(TraceContext) - Static method in class brave.propagation.ExtraFieldPropagation: Returns a mapping of any fields in the trace context.
getAll(TraceContextOrSamplingFlags) - Static method in class brave.propagation.ExtraFieldPropagation: Returns a mapping of any fields in the extraction result.

H

handle(TraceContext, MutableSpan) - Method in class brave.handler.FinishedSpanHandler: This is invoked after a span is finished, allowing data to be modified or reported out of process.
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

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, C) - 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 default format of B3Propagation.Format.MULTI.
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, but writes two formats.
injector(Propagation.Setter<C, K>) - Method in class brave.propagation.B3Propagation
injector(Propagation.Setter<C, K>) - Method in class brave.propagation.ExtraFieldPropagation
injector(Propagation.Setter<C, 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: Returns true if there was no data added.
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

keys() - Method in class brave.propagation.B3Propagation
keys() - Method in class brave.propagation.ExtraFieldPropagation: 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
kind(Span.Kind) - Method in class brave.Span: When present, the span is remote.

L

localIp() - Method in class brave.handler.MutableSpan: When null default will be used for zipkin.
localIp(String) - Method in class brave.handler.MutableSpan
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: When zero default will be used for zipkin.
localPort(int) - Method in class brave.handler.MutableSpan
localPort(int) - Method in class brave.Tracing.Builder: The primary listen port associated with this service.
localRootId() - Method in class brave.propagation.TraceContext: Returns the first TraceContext.spanId() in a partition of a trace: otherwise known as an entry span.
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: When null default is used.
localServiceName(String) - Method in class brave.handler.MutableSpan
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.
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.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

N

name() - Method in class brave.handler.MutableSpan: Returns the span name or null
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
name(String) - Method in enum brave.NoopSpanCustomizer
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.ThreadLocalCurrentTraceContext
newBuilder() - Static method in class brave.propagation.TraceContext
newBuilder() - Static method in class brave.propagation.TraceContextOrSamplingFlags
newBuilder() - Static method in class brave.propagation.TraceIdContext
newBuilder() - Static method in class brave.sampler.ParameterizedSampler
newBuilder() - Static method in class brave.Tracing
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: Wraps an underlying propagation implementation, pushing one or more fields
newFactory(Propagation.Factory, Collection<String>) - Static method in class brave.propagation.ExtraFieldPropagation: Wraps an underlying propagation implementation, pushing one or more fields
newFactoryBuilder() - Static method in class brave.propagation.B3Propagation
newFactoryBuilder(Propagation.Factory) - Static method in class brave.propagation.ExtraFieldPropagation
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.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 class brave.ErrorParser: Adds no tags to the span representing the operation in error.
NOOP - Static variable in class brave.handler.FinishedSpanHandler: 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.CurrentTraceContextCustomizer: Use to avoid comparing against null references
NOOP - Static variable in interface brave.propagation.ExtraFieldCustomizer: 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

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)
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
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
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 carriers that travel in-band across process boundaries.
Propagation.Factory - Class in brave.propagation
Propagation.Getter<C,K> - Interface in brave.propagation: Gets the first value of the given propagation key or returns null
Propagation.KeyFactory<K> - Interface in brave.propagation: Creates keys for use in propagated contexts
Propagation.Setter<C,K> - Interface in brave.propagation: Replaces a propagated key with the given value
propagationFactory() - Method in class brave.Tracing: This supports edge cases like GRPC Metadata propagation which doesn't use String keys.
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(C, 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.
remoteEndpoint(Endpoint) - Method in class brave.Span: Deprecated.
Use Span.remoteServiceName(String) Span.remoteIpAndPort(String, int). Will be removed in Brave v6.
remoteIp() - Method in class brave.handler.MutableSpan: The text representation of the primary IPv4 or IPv6 address associated with the remote side of this connection.
remoteIpAndPort(String, int) - Method in class brave.handler.MutableSpan
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: Port of the remote IP's socket or 0, if not known.
remoteServiceName() - Method in class brave.handler.MutableSpan
remoteServiceName(String) - Method in class brave.handler.MutableSpan
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.
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
requires128BitTraceId() - Method in class brave.propagation.Propagation.Factory
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
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.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
samplingFlags(SamplingFlags) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder
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: Sets the value of the field with the specified key, or drops if not a configured field
set(String, String) - Static method in class brave.propagation.ExtraFieldPropagation: Sets the current value of the field with the specified key, or drops if not a configured field.
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: Indicates we are contributing to a span started by another tracer (ex on a different host).
shared() - Method in class brave.handler.MutableSpan: Returns true if the span ID is shared with a remote client.
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).
Span - Class in brave: Used to model the latency of an operation.
Span.Kind - Enum in brave
SpanCustomizer - Interface in brave: Simple interface users can customize a span with.
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 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: Controls how spans are reported.
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
StrictCurrentTraceContext - Class in brave.propagation: Deprecated.
use StrictScopeDecorator. This will be removed in Brave v6.
StrictCurrentTraceContext() - Constructor for class brave.propagation.StrictCurrentTraceContext: Deprecated.
StrictScopeDecorator - Class in brave.propagation: Useful when developing instrumentation as state is enforced more strictly.
STRING - Static variable in interface brave.propagation.Propagation.KeyFactory
supportsJoin() - Method in class brave.propagation.ExtraFieldPropagation.Factory
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: Normally, FinishedSpanHandler.handle(TraceContext, MutableSpan) is only called upon explicit termination of a span: Span.finish(), Span.finish(long) or Span.flush().

T

tag(Object, String, String) - Method in class brave.ErrorParser: Same behaviour as SpanCustomizer.tag(String, String)
tag(String) - Method in class brave.handler.MutableSpan: Returns the last 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
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.
ThreadLocalCurrentTraceContext - Class in brave.propagation: In-process trace context propagation backed by a static thread local.
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.propagation.TraceContext
toBuilder() - Method in class brave.propagation.TraceContextOrSamplingFlags
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.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.Tracer.SpanInScope
toString() - Method in class brave.Tracer
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<C> - Interface in brave.propagation: Used to continue an incoming trace.
TraceContext.Injector<C> - 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.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
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
traceIdContext(TraceIdContext) - Method in class brave.propagation.TraceContextOrSamplingFlags.Builder
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
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, this 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

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.

V

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.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 carriers 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 carriers with byte array or byte buffer values.

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