Index (Brave 4.19.1 API)

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

A

abandon() - Method in class brave.Span: Throws away the current span without reporting it.
abandon(TraceContext) - Method in class brave.internal.recorder.Recorder
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.
addPrefixedFields(String, Collection<String>) - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder: Adds a prefix when fields are extracted or injected from headers.
ALWAYS_SAMPLE - Static variable in class brave.sampler.Sampler
annotate(long, String) - Method in class brave.CurrentSpanCustomizer: Deprecated.
use CurrentSpanCustomizer.annotate(String) as this can result in clock skew
annotate(long, String) - Method in enum brave.NoopSpanCustomizer: Deprecated.
use NoopSpanCustomizer.annotate(String) as this can result in clock skew
annotate(long, String) - Method in class brave.Span: Like Span.annotate(String), except with a given timestamp in microseconds.
annotate(long, String) - Method in interface brave.SpanCustomizer: Deprecated.
use SpanCustomizer.annotate(String) as this can result in clock skew
annotate(TraceContext, long, String) - Method in class brave.internal.recorder.Recorder
annotate(TraceContext, String) - Method in class brave.internal.recorder.Recorder
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.
awaitTermination(long, TimeUnit) - Method in class brave.internal.WrappingExecutorService

B

B3 - Static variable in class brave.propagation.Propagation.Factory: Deprecated.
use B3Propagation.FACTORY to avoid initialization race condition
B3_STRING - Static variable in interface brave.propagation.Propagation
B3Propagation<K> - Class in brave.propagation: Implements B3 Propagation
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.internal - package brave.internal
brave.internal.recorder - package brave.internal.recorder
brave.propagation - package brave.propagation
brave.sampler - package brave.sampler
build() - Method in class brave.propagation.ExtraFieldPropagation.FactoryBuilder
build() - Method in class brave.propagation.SamplingFlags.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.Tracer.Builder: Deprecated.
build() - Method in class brave.Tracing.Builder
build(Boolean) - Static method in class brave.propagation.SamplingFlags.Builder: Allows you to create flags from a boolean value without allocating a builder instance
Builder() - Constructor for class brave.propagation.SamplingFlags.Builder
Builder() - Constructor for class brave.Tracer.Builder: Deprecated.

C

CLIENT - brave.Span.Kind
clock() - Method in class brave.internal.Platform
clock() - Method in class brave.Tracer: Deprecated.
use Tracing.clock(TraceContext)
clock() - Method in class brave.Tracing: Deprecated.
use Tracing.clock(TraceContext)
clock(Clock) - Method in class brave.Tracer.Builder: Deprecated.
clock(Clock) - Method in class brave.Tracing.Builder: Assigns microsecond-resolution timestamp source for operations like Span.start().
clock(TraceContext) - Method in class brave.internal.recorder.Recorder: Returns a clock that ensures timestamp consistency across the trace
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.
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(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 rate expressed as a percentage.
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(TraceContext.Builder) - Static method in class brave.propagation.TraceContextOrSamplingFlags: Deprecated.
call one of the other factory methods vs allocating an exception
create(TraceIdContext) - Static method in class brave.propagation.TraceContextOrSamplingFlags
create(DeclarativeSampler.RateForMethod<M>) - Static method in class brave.sampler.DeclarativeSampler
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(String) - Method in interface brave.propagation.Propagation.KeyFactory
create(List<? extends ParameterizedSampler.Rule>) - Static method in class brave.sampler.ParameterizedSampler
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.Tracer.Builder: Deprecated.
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.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.
currentTracer() - Static method in class brave.Tracing: Returns the most recently created tracer if its component hasn't been closed.
customizer() - Method in class brave.Span: Returns a customizer appropriate for the current span.

D

debug() - Method in class brave.propagation.SamplingFlags: True is a request to store this span even if it overrides sampling policy.
debug() - Method in class brave.propagation.TraceContext: True is a request to store this span even if it overrides sampling policy.
debug() - Method in class brave.propagation.TraceIdContext: True is a request to store this span even if it overrides sampling policy.
debug(boolean) - Method in class brave.propagation.SamplingFlags.Builder
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
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.RateForMethod<M> - Interface in brave.sampler
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.
Default() - Constructor for class brave.propagation.CurrentTraceContext.Default: Deprecated.
prefer CurrentTraceContext.Default.create() as it isn't inheritable, so can't leak contexts.
delegate() - Method in class brave.internal.WrappingExecutorService

E

EMPTY - Static variable in class brave.propagation.SamplingFlags
EMPTY - Static variable in class brave.propagation.TraceContextOrSamplingFlags
endpoint() - Method in class brave.internal.Platform
endpoint(Endpoint) - Method in class brave.Tracer.Builder: Deprecated.
endpoint(Endpoint) - Method in class brave.Tracing.Builder: Sets the Endpoint of the local service being traced.
equals(Object) - Method in class brave.propagation.TraceContext: Only includes mandatory fields TraceContext.traceIdHigh(), TraceContext.traceId(), TraceContext.spanId()
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(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, 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
execute(Runnable) - Method in class brave.internal.WrappingExecutorService
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
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
ExtraFieldPropagation<K> - Class in brave.propagation: Allows you to propagate predefined request-scoped fields, usually but not always HTTP headers.
ExtraFieldPropagation.FactoryBuilder - Class in brave.propagation

F

Factory() - Constructor for class brave.propagation.Propagation.Factory
FACTORY - Static variable in class brave.propagation.B3Propagation
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.
finish(TraceContext) - Method in class brave.internal.recorder.Recorder
finish(TraceContext, long) - Method in class brave.internal.recorder.Recorder
flush() - Method in class brave.Span: Reports the span, even if unfinished.
flush(TraceContext) - Method in class brave.internal.recorder.Recorder

G

get() - Static method in class brave.internal.Platform
get() - Method in class brave.propagation.CurrentTraceContext.Default
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.StrictCurrentTraceContext
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.RateForMethod: Returns null if there's no configured rate for 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

hashCode() - Method in class brave.propagation.TraceContext: Only includes mandatory fields TraceContext.traceIdHigh(), TraceContext.traceId(), TraceContext.spanId()
hashCode() - Method in class brave.propagation.TraceContextOrSamplingFlags
hashCode() - Method in class brave.propagation.TraceIdContext: Only includes mandatory fields TraceIdContext.traceIdHigh() and TraceIdContext.traceId()
HexCodec - Class in brave.internal

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.
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
invokeAll(Collection<? extends Callable<T>>) - Method in class brave.internal.WrappingExecutorService
invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class brave.internal.WrappingExecutorService
invokeAny(Collection<? extends Callable<T>>) - Method in class brave.internal.WrappingExecutorService
invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class brave.internal.WrappingExecutorService
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.Sampler: Returns true if the trace ID should be measured.
isShutdown() - Method in class brave.internal.WrappingExecutorService
isTerminated() - Method in class brave.internal.WrappingExecutorService

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
keys() - Method in interface brave.propagation.Propagation: The propagation fields defined.
kind(TraceContext, Span.Kind) - Method in class brave.internal.recorder.Recorder
kind(Span.Kind) - Method in class brave.Span: The kind of span is optional.

L

lenientLowerHexToUnsignedLong(CharSequence, int, int) - Static method in class brave.internal.HexCodec: Like HexCodec.lowerHexToUnsignedLong(CharSequence, int), but returns zero on invalid input
localEndpoint(Endpoint) - Method in class brave.Tracer.Builder: Deprecated.
use Tracer.Builder.endpoint(Endpoint), possibly with Endpoint.toV2()
localEndpoint(Endpoint) - Method in class brave.Tracing.Builder: Deprecated.
use Tracing.Builder.endpoint(Endpoint), possibly with Endpoint.toV2()
localEndpoint(Endpoint) - Method in class brave.Tracer.Builder: Deprecated.
use Tracer.Builder.endpoint(Endpoint)
localEndpoint(Endpoint) - Method in class brave.Tracing.Builder: Deprecated.
use Tracing.Builder.endpoint(Endpoint) which compiles without io.zipkin.java:zipkin
localServiceName(String) - Method in class brave.Tracer.Builder: Deprecated.
localServiceName(String) - Method in class brave.Tracing.Builder: Controls the name of the service being traced, while still using a default site-local IP.
lowerHexEqualsTraceId(CharSequence, TraceContext) - Static method in class brave.internal.HexCodec
lowerHexEqualsUnsignedLong(CharSequence, long) - Static method in class brave.internal.HexCodec
lowerHexToUnsignedLong(CharSequence) - Static method in class brave.internal.HexCodec: Parses a 1 to 32 character lower-hex string with no prefix into an unsigned long, tossing any bits higher than 64.
lowerHexToUnsignedLong(CharSequence, int) - Static method in class brave.internal.HexCodec: Parses a 16 character lower-hex string with no prefix into an unsigned long, starting at the specified index.

M

matches(P) - Method in class brave.sampler.ParameterizedSampler.Rule: Returns true if this rule matches the input parameters
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.

N

name(TraceContext, String) - Method in class brave.internal.recorder.Recorder
name(String) - Method in class brave.CurrentSpanCustomizer: Sets the string name for the logical operation this span represents.
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
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.Tracer: Deprecated.
Please use Tracing.newBuilder()
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(Propagation.Factory) - Static method in class brave.propagation.ExtraFieldPropagation
newScope(TraceContext) - Method in class brave.propagation.CurrentTraceContext.Default
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: Identifies problems by throwing assertion errors when a scope is closed on a different thread.
newTrace() - Method in class brave.Tracer: Explicitly creates a new trace.
newTrace(SamplingFlags) - Method in class brave.Tracer: Deprecated.
Prefer Tracer.withSampler(Sampler)
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.
nextTraceIdHigh() - Method in class brave.internal.Platform: Returns the high 8-bytes for use in 128-bit trace IDs.
NOOP - Static variable in class brave.ErrorParser: Adds no tags to the span representing the operation in error.
NOOP - Static variable in interface brave.propagation.CurrentTraceContext.Scope: Returned when CurrentTraceContext.maybeScope(TraceContext) detected scope redundancy.
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
Nullable - Annotation Type in brave.internal: Libraries such as Guice and AutoValue will process any annotation named Nullable.

P

ParameterizedSampler - Class in brave.sampler: This is an implementation of how to decide whether to trace a request using ordered rules.
ParameterizedSampler.Rule - Class in brave.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.
Platform - Class in brave.internal: Access to platform-specific features and implements a default logging spanReporter.
Platform() - Constructor for class brave.internal.Platform
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

R

randomLong() - Method in class brave.internal.Platform: This class uses pseudo-random number generators to provision IDs.
Recorder - Class in brave.internal.recorder: Dispatches mutations on a span to a shared object per trace/span id.
Recorder(Endpoint, Clock, Reporter, AtomicBoolean) - Constructor for class brave.internal.recorder.Recorder
remoteEndpoint(TraceContext, Endpoint) - Method in class brave.internal.recorder.Recorder
remoteEndpoint(Endpoint) - Method in class brave.Span: Deprecated.
use Span.remoteEndpoint(Endpoint), possibly with Endpoint.toV2()
remoteEndpoint(Endpoint) - Method in class brave.Span: For a client span, this would be the server's address.
remove() - Method in class brave.propagation.ThreadLocalSpan: Returns the span set in scope via ThreadLocalSpan.next() or null if there was none.
reporter() - Method in class brave.internal.Platform
reporter(Reporter) - Method in class brave.Tracer.Builder: Deprecated.
use Tracer.Builder.spanReporter(Reporter)
reporter(Reporter) - Method in class brave.Tracing.Builder: Deprecated.
use Tracing.Builder.spanReporter(Reporter)
requires128BitTraceId() - Method in class brave.propagation.Propagation.Factory
Rule(float) - Constructor for class brave.sampler.ParameterizedSampler.Rule

S

sample(M) - Method in class brave.sampler.DeclarativeSampler
sample(P) - Method in class brave.sampler.ParameterizedSampler
sampled() - Method in class brave.propagation.SamplingFlags: Should we sample this request or not? True means sample, false means don't, null means we defer decision to someone further down in the stack.
sampled() - Method in class brave.propagation.TraceContext: Should we sample this request or not? True means sample, false means don't, null means we defer decision to someone further down in the stack.
sampled() - Method in class brave.propagation.TraceContextOrSamplingFlags: Returns SamplingFlags.sampled(), regardless of subtype.
sampled() - Method in class brave.propagation.TraceIdContext: Should we sample this request or not? True means sample, false means don't, null means we defer decision to someone further down in the stack.
sampled(boolean) - Method in class brave.propagation.TraceContext.Builder
sampled(boolean) - Method in class brave.propagation.TraceIdContext.Builder
sampled(Boolean) - Method in class brave.propagation.SamplingFlags.Builder
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 - Static variable in class brave.propagation.SamplingFlags
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.Tracer.Builder: Deprecated.
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
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
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(TraceContext) - Method in class brave.internal.recorder.Recorder: Indicates we are contributing to a span started by another tracer (ex on a different host).
shared() - Method in class brave.propagation.TraceContext: Deprecated.
it is unnecessary overhead to propagate this property
shared(boolean) - Method in class brave.propagation.TraceContext.Builder: Deprecated.
it is unnecessary overhead to propagate this property
shutdown() - Method in class brave.internal.WrappingExecutorService
shutdownNow() - Method in class brave.internal.WrappingExecutorService
snapshot() - Method in class brave.internal.recorder.Recorder: Exposes which spans are in-flight, mostly for testing.
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
spanReporter(Reporter) - Method in class brave.Tracer.Builder: Deprecated.
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.
start(TraceContext) - Method in class brave.internal.recorder.Recorder
start(TraceContext, long) - Method in class brave.internal.recorder.Recorder
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.
startScopedSpanWithParent(String, TraceContext) - Method in class brave.Tracer: Same as Tracer.startScopedSpan(String), except ignores the current trace context.
StrictCurrentTraceContext - Class in brave.propagation: Useful when developing instrumentation as state is enforced more strictly.
StrictCurrentTraceContext() - Constructor for class brave.propagation.StrictCurrentTraceContext
STRING - Static variable in interface brave.propagation.Propagation.KeyFactory
submit(Runnable) - Method in class brave.internal.WrappingExecutorService
submit(Runnable, T) - Method in class brave.internal.WrappingExecutorService
submit(Callable<T>) - Method in class brave.internal.WrappingExecutorService
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.Tracer.Builder: Deprecated.
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.

T

tag(TraceContext, String, String) - Method in class brave.internal.recorder.Recorder
tag(Object, String, String) - Method in class brave.ErrorParser: Same behaviour as SpanCustomizer.tag(String, String)
tag(String, String) - Method in class brave.CurrentSpanCustomizer: Tags give your span context for search, viewing and analysis.
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.
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
toLowerHex(long) - Static method in class brave.internal.HexCodec: Inspired by okio.Buffer.writeLong
toLowerHex(long, long) - Static method in class brave.internal.HexCodec: Returns 16 or 32 character hex string depending on if high is zero.
toSampler(M) - Method in class brave.sampler.DeclarativeSampler: Used with Tracer.withSampler(Sampler) to override the default sampling decision.
toSampler(M, Sampler) - Method in class brave.sampler.DeclarativeSampler: Like DeclarativeSampler.toSampler(Object), except allows a fallback decision, usually from Tracing.sampler(), when there was no rate for an input
toSpan(TraceContext) - Method in class brave.Tracer: Converts the context as-is to a Span object
toSpan(Span) - Static method in class brave.internal.V2SpanConverter: Converts the input, parsing Span.kind() into RPC annotations.
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.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 join 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.Tracer.Builder: Deprecated.
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.Builder - Class in brave: Deprecated.
Please use Tracing.Builder
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

V

V2SpanConverter - Class in brave.internal: This converts Span instances to Span and visa versa.
V2SpanConverter() - Constructor for class brave.internal.V2SpanConverter
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.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.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: Use this to temporarily override the sampler used when starting new traces.
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.internal.WrappingExecutorService
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.internal.WrappingExecutorService
wrap(Callable<C>) - Method in class brave.propagation.CurrentTraceContext: Wraps the input so that it executes with the same context as now.
WrappingExecutorService - Class in brave.internal: Used to implement a context propagating executor service which wraps tasks
WrappingExecutorService() - Constructor for class brave.internal.WrappingExecutorService
writeHexByte(char[], int, byte) - Static method in class brave.internal.HexCodec
writeHexLong(char[], int, long) - Static method in class brave.internal.HexCodec: Inspired by okio.Buffer.writeLong

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