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

A

AbstractSpanCollector - Class in com.github.kristofa.brave

Implemented AbstractSpanCollector.sendSpans(byte[]) to transport a encoded list of spans to Zipkin.

AbstractSpanCollector(SpanCodec, SpanCollectorMetricsHandler, int) - Constructor for class com.github.kristofa.brave.AbstractSpanCollector

addDefaultAnnotation(String, String) - Method in class com.github.kristofa.brave.EmptySpanCollector

Adds a fixed annotation that will be added to every span that is submitted to this collector.

addDefaultAnnotation(String, String) - Method in class com.github.kristofa.brave.FlushingSpanCollector

addDefaultAnnotation(String, String) - Method in class com.github.kristofa.brave.LoggingSpanCollector

Adds a fixed annotation that will be added to every span that is submitted to this collector.

addDefaultAnnotation(String, String) - Method in interface com.github.kristofa.brave.SpanCollector

Deprecated.

decorate SpanCollector.collect(Span), if you want to customize spans before they are sent.

address(String, Endpoint) - Static method in class com.twitter.zipkin.gen.BinaryAnnotation

Special-cased form supporting Constants.CLIENT_ADDR and Constants.SERVER_ADDR.

addSpanIdToRequest(SpanId) - Method in interface com.github.kristofa.brave.ClientRequestAdapter

Enrich the request with the Spanid so we pass the state to the service we are calling.

addToAnnotations(Annotation) - Method in class com.twitter.zipkin.gen.Span

addToBinary_annotations(BinaryAnnotation) - Method in class com.twitter.zipkin.gen.Span

ALWAYS_SAMPLE - Static variable in class com.github.kristofa.brave.Sampler

Annotation - Class in com.twitter.zipkin.gen

An annotation is similar to a log statement.

AnnotationSubmitter - Class in com.github.kristofa.brave

Used to submit application specific annotations.

AnnotationType - Enum in com.twitter.zipkin.gen

awaitTermination(long, TimeUnit) - Method in class com.github.kristofa.brave.BraveExecutorService

B

BinaryAnnotation - Class in com.twitter.zipkin.gen

Binary annotations are tags applied to a Span to give it context.

BoundarySampler - Class in com.github.kristofa.brave

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 - Class in com.github.kristofa.brave

Brave.Builder - Class in com.github.kristofa.brave

Builds Brave api objects with following defaults if not overridden:

BraveAnnotations - Class in com.github.kristofa.brave

Deprecated.

unused; will be removed in Brave 2.0

BraveAnnotations() - Constructor for class com.github.kristofa.brave.BraveAnnotations

Deprecated.

BraveCallable<T> - Class in com.github.kristofa.brave

Callable implementation that wraps another Callable and makes sure the wrapped Callable will be executed in the same Span/Trace context as the thread from which the Callable was executed.

BraveExecutorService - Class in com.github.kristofa.brave

ExecutorService that wraps around an existing ExecutorService and that makes sure the threads are executed in the same Span/Trace context as the the thread that invoked execution of the threads.

BraveExecutorService(ExecutorService, ServerSpanThreadBinder) - Constructor for class com.github.kristofa.brave.BraveExecutorService

Creates a new instance.

BraveRunnable - Class in com.github.kristofa.brave

Runnable implementation that wraps another Runnable and makes sure the wrapped Runnable will be executed in the same Span/Trace context as the thread from which the Runnable was executed.

BraveRunnable() - Constructor for class com.github.kristofa.brave.BraveRunnable

build() - Method in class com.github.kristofa.brave.Brave.Builder

build() - Method in class com.github.kristofa.brave.ClientTracer.Builder

build() - Method in class com.github.kristofa.brave.ServerTracer.Builder

build() - Method in class com.github.kristofa.brave.SpanId.Builder

build() - Method in interface com.github.kristofa.brave.TraceData.Builder

Builder() - Constructor for class com.github.kristofa.brave.Brave.Builder

Builder which initializes with serviceName = "unknown".

Builder(String) - Constructor for class com.github.kristofa.brave.Brave.Builder

Builder.

Builder(int, int, String) - Constructor for class com.github.kristofa.brave.Brave.Builder

Builder.

Builder(ServerClientAndLocalSpanState) - Constructor for class com.github.kristofa.brave.Brave.Builder

Use for control of how tracing state propagates across threads.

builder() - Static method in class com.github.kristofa.brave.ClientTracer

Builder() - Constructor for class com.github.kristofa.brave.ClientTracer.Builder

builder() - Static method in class com.github.kristofa.brave.ServerTracer

Builder() - Constructor for class com.github.kristofa.brave.ServerTracer.Builder

builder() - Static method in class com.github.kristofa.brave.SpanId

builder() - Static method in class com.github.kristofa.brave.TraceData

bytes() - Method in class com.github.kristofa.brave.SpanId

Serializes this into a big-endian byte array

C

call() - Method in class com.github.kristofa.brave.BraveCallable

checkNotBlank(String, String, Object...) - Static method in class com.github.kristofa.brave.internal.Util

checkNotNull(T, String, Object...) - Static method in class com.github.kristofa.brave.internal.Util

Copy of com.google.common.base.Preconditions#checkNotNull.

clearCurrentSpan() - Method in class com.github.kristofa.brave.ServerTracer

Clears current span.

CLIENT_ADDR - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Indicates a client address ("ca") in a span.

CLIENT_RECV - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

The client received ("cr") a response from a server.

CLIENT_RECV_FRAGMENT - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs progress of a (CLIENT_RECV, WIRE_RECV).

CLIENT_SEND - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

The client sent ("cs") a request to a server.

CLIENT_SEND_FRAGMENT - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs progress of a (CLIENT_SEND, WIRE_SEND).

ClientRequestAdapter - Interface in com.github.kristofa.brave

Adapter used to get tracing information from and add tracing information to a new request.

clientRequestInterceptor() - Method in class com.github.kristofa.brave.Brave

ClientRequestInterceptor - Class in com.github.kristofa.brave

Contains logic for handling an outgoing client request.

ClientRequestInterceptor(ClientTracer) - Constructor for class com.github.kristofa.brave.ClientRequestInterceptor

ClientResponseAdapter - Interface in com.github.kristofa.brave

clientResponseInterceptor() - Method in class com.github.kristofa.brave.Brave

ClientResponseInterceptor - Class in com.github.kristofa.brave

Contains logic for dealing with response from client request.

ClientResponseInterceptor(ClientTracer) - Constructor for class com.github.kristofa.brave.ClientResponseInterceptor

ClientSpanAndEndpoint() - Constructor for class com.github.kristofa.brave.SpanAndEndpoint.ClientSpanAndEndpoint

ClientSpanState - Interface in com.github.kristofa.brave

Maintains state for a single client span.

clientSpanThreadBinder() - Method in class com.github.kristofa.brave.Brave

Helper object that can be used to propagate client trace state.

ClientSpanThreadBinder - Class in com.github.kristofa.brave

Allows binding span from client request thread to a async callback thread that process the result.

ClientSpanThreadBinder(ClientSpanState) - Constructor for class com.github.kristofa.brave.ClientSpanThreadBinder

Creates a new instance.

clientTracer() - Method in class com.github.kristofa.brave.Brave

Client Tracer.

ClientTracer - Class in com.github.kristofa.brave

Low level api that deals with client side of a request: Decide on tracing or not (sampling) Sending client set / client received annotations It is advised that you use ClientRequestInterceptor and ClientResponseInterceptor which build upon ClientTracer and provide a higher level api.

ClientTracer.Builder - Class in com.github.kristofa.brave

close() - Method in class com.github.kristofa.brave.BraveExecutorService

Convenience for try-with-resources, or frameworks such as Spring that automatically process this.

close() - Method in class com.github.kristofa.brave.FixedSampleRateTraceFilter

Deprecated.

Should be called when TraceFilter will not be used anymore.

close() - Method in class com.github.kristofa.brave.FlushingSpanCollector

Requests a cease of delivery.

close() - Method in interface com.github.kristofa.brave.TraceFilter

Deprecated.

Should be called when TraceFilter will not be used anymore.

collect(Span) - Method in class com.github.kristofa.brave.EmptySpanCollector

Collect span.

collect(Span) - Method in class com.github.kristofa.brave.FlushingSpanCollector

Queues the span for collection, or drops it if the queue is full.

collect(Span) - Method in class com.github.kristofa.brave.LoggingSpanCollector

Collect span.

collect(Span) - Method in interface com.github.kristofa.brave.SpanCollector

Collect span.

com.github.kristofa.brave - package com.github.kristofa.brave

com.github.kristofa.brave.internal - package com.github.kristofa.brave.internal

com.twitter.zipkin.gen - package com.twitter.zipkin.gen

CommonSpanState - Interface in com.github.kristofa.brave

Keeps track of common trace/span state information.

convertToLong(String) - Static method in class com.github.kristofa.brave.IdConversion

Converts String trace or span id to long.

convertToString(long) - Static method in class com.github.kristofa.brave.IdConversion

Converts long trace or span id to String.

CountingSampler - Class in com.github.kristofa.brave

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(SpanAndEndpoint) - Static method in class com.github.kristofa.brave.AnnotationSubmitter

create(float) - Static method in class com.github.kristofa.brave.BoundarySampler

create(Callable<T>, ServerSpanThreadBinder) - Static method in class com.github.kristofa.brave.BraveCallable

Creates a new instance.

create(Runnable, ServerSpanThreadBinder) - Static method in class com.github.kristofa.brave.BraveRunnable

Creates a new instance.

create(float) - Static method in class com.github.kristofa.brave.CountingSampler

create(String, String) - Static method in class com.github.kristofa.brave.KeyValueAnnotation

create(float) - Static method in class com.github.kristofa.brave.Sampler

Returns a sampler, given a rate expressed as a percentage.

create(long, long, Long) - Static method in class com.github.kristofa.brave.SpanId

Deprecated.

Please use SpanId.Builder

create(long, String, Endpoint) - Static method in class com.twitter.zipkin.gen.Annotation

create(String, String, Endpoint) - Static method in class com.twitter.zipkin.gen.BinaryAnnotation

String values are the only queryable type of binary annotation.

create(String, byte[], AnnotationType, Endpoint) - Static method in class com.twitter.zipkin.gen.BinaryAnnotation

create(String, int, int) - Static method in class com.twitter.zipkin.gen.Endpoint

create(String, int) - Static method in class com.twitter.zipkin.gen.Endpoint

D

debug(boolean) - Method in class com.github.kristofa.brave.SpanId.Builder

debug() - Method in class com.github.kristofa.brave.SpanId

True is a request to store this span even if it overrides sampling policy.

DefaultSpanCodec - Class in com.github.kristofa.brave.internal

E

EMPTY - Static variable in class com.github.kristofa.brave.ServerSpan

EmptySpanCollector - Class in com.github.kristofa.brave

A SpanCollector implementation that does nothing with collected spans.

EmptySpanCollector() - Constructor for class com.github.kristofa.brave.EmptySpanCollector

EmptySpanCollectorMetricsHandler - Class in com.github.kristofa.brave

Empty implementation ignoring all events.

EmptySpanCollectorMetricsHandler() - Constructor for class com.github.kristofa.brave.EmptySpanCollectorMetricsHandler

endpoint() - Method in interface com.github.kristofa.brave.CommonSpanState

Gets the Endpoint (ip, port, service name) for this service.

endpoint() - Method in class com.github.kristofa.brave.SpanAndEndpoint.ClientSpanAndEndpoint

Indicates the network context of the local service being traced.

endpoint() - Method in interface com.github.kristofa.brave.SpanAndEndpoint

Indicates the network context of the local service being traced.

endpoint() - Method in class com.github.kristofa.brave.SpanAndEndpoint.LocalSpanAndEndpoint

endpoint() - Method in class com.github.kristofa.brave.SpanAndEndpoint.ServerSpanAndEndpoint

Indicates the network context of the local service being traced.

endpoint() - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Gets the Endpoint (ip, port, service name) for this service.

Endpoint - Class in com.twitter.zipkin.gen

Indicates the network context of a service recording an annotation with two exceptions.

equal(Object, Object) - Static method in class com.github.kristofa.brave.internal.Util

equals(Object) - Method in class com.github.kristofa.brave.SpanId

equals(Object) - Method in class com.twitter.zipkin.gen.Annotation

equals(Object) - Method in class com.twitter.zipkin.gen.BinaryAnnotation

equals(Object) - Method in class com.twitter.zipkin.gen.Endpoint

equals(Object) - Method in class com.twitter.zipkin.gen.Span

execute(Runnable) - Method in class com.github.kristofa.brave.BraveExecutorService

F

finishSpan() - Method in class com.github.kristofa.brave.LocalTracer

Completes the span, assigning the most precise duration possible.

finishSpan(long) - Method in class com.github.kristofa.brave.LocalTracer

Completes the span, which took duration microseconds.

FixedSampleRateTraceFilter - Class in com.github.kristofa.brave

Deprecated.

Use Sampler instead.

FixedSampleRateTraceFilter(int) - Constructor for class com.github.kristofa.brave.FixedSampleRateTraceFilter

Deprecated.

Creates a new instance.

FLAG_DEBUG - Static variable in class com.github.kristofa.brave.SpanId

FLAG_IS_ROOT - Static variable in class com.github.kristofa.brave.SpanId

When set, we can ignore the value of the SpanId.parentId

FLAG_SAMPLED - Static variable in class com.github.kristofa.brave.SpanId

FLAG_SAMPLING_SET - Static variable in class com.github.kristofa.brave.SpanId

When set, we can interpret SpanId.FLAG_SAMPLED as a set value.

flags(long) - Method in class com.github.kristofa.brave.SpanId.Builder

flags - Variable in class com.github.kristofa.brave.SpanId

Raw flags encoded in SpanId.bytes()

flush() - Method in class com.github.kristofa.brave.FlushingSpanCollector

Calling this will flush any pending spans to the transport on the current thread.

FlushingSpanCollector - Class in com.github.kristofa.brave

Extend this class to offload the task of reporting spans to separate thread.

FlushingSpanCollector(SpanCollectorMetricsHandler, int) - Constructor for class com.github.kristofa.brave.FlushingSpanCollector

fromBytes(byte[]) - Static method in class com.github.kristofa.brave.SpanId

Deserializes this from a big-endian byte array

fromValue(int) - Static method in enum com.twitter.zipkin.gen.AnnotationType

Returns AnnotationType.BYTES if unknown.

G

getAnnotations() - Method in class com.twitter.zipkin.gen.Span

getBinary_annotations() - Method in class com.twitter.zipkin.gen.Span

getCurrentClientSpan() - Method in interface com.github.kristofa.brave.ClientSpanState

Gets the Span for the client request that was started as part of current request.

getCurrentClientSpan() - Method in class com.github.kristofa.brave.ClientSpanThreadBinder

This should be called in the thread in which the client request made after starting new client span.

getCurrentClientSpan() - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Gets the Span for the client request that was started as part of current request.

getCurrentLocalSpan() - Method in interface com.github.kristofa.brave.LocalSpanState

Gets the Span for the local request that was started as part of current request.

getCurrentLocalSpan() - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

getCurrentServerSpan() - Method in interface com.github.kristofa.brave.ServerSpanState

Gets the Span for the server request we are currently part of.

getCurrentServerSpan() - Method in class com.github.kristofa.brave.ServerSpanThreadBinder

This should be called in the thread in which the request was received before executing code in new threads.

getCurrentServerSpan() - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Gets the Span for the server request we are currently part of.

getDuration() - Method in class com.twitter.zipkin.gen.Span

Measurement of duration in microseconds, used to support queries.

getId() - Method in class com.twitter.zipkin.gen.Span

getInstance() - Static method in class com.github.kristofa.brave.NoAnnotationsClientResponseAdapter

getKey() - Method in class com.github.kristofa.brave.KeyValueAnnotation

getKey() - Method in class com.twitter.zipkin.gen.BinaryAnnotation

getName() - Method in class com.twitter.zipkin.gen.Span

Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".

getParent_id() - Method in class com.twitter.zipkin.gen.Span

getParentSpanId() - Method in class com.github.kristofa.brave.SpanId

Deprecated.

use SpanId.nullableParentId()

getSample() - Method in class com.github.kristofa.brave.ServerSpan

Indicates if we need to sample this request or not.

getSample() - Method in class com.github.kristofa.brave.TraceData

Indication of request should be sampled or not.

getSpan() - Method in class com.github.kristofa.brave.ServerSpan

Gets the Trace/Span context.

getSpanId() - Method in class com.github.kristofa.brave.SpanId

Deprecated.

use SpanId.spanId

getSpanId() - Method in class com.github.kristofa.brave.TraceData

Span id.

getSpanName() - Method in interface com.github.kristofa.brave.ClientRequestAdapter

Gets the span name for request.

getSpanName() - Method in interface com.github.kristofa.brave.ServerRequestAdapter

Gets the span name for request.

getTimestamp() - Method in class com.twitter.zipkin.gen.Span

Microseconds from epoch of the creation of this span.

getTrace_id() - Method in class com.twitter.zipkin.gen.Span

getTraceData() - Method in interface com.github.kristofa.brave.ServerRequestAdapter

Get the trace data from request.

getTraceId() - Method in class com.github.kristofa.brave.SpanId

Deprecated.

use SpanId.traceId

getValue() - Method in class com.github.kristofa.brave.KeyValueAnnotation

getValue() - Method in enum com.twitter.zipkin.gen.AnnotationType

Get the integer value of this enum value, as defined in the Thrift IDL.

getValue() - Method in class com.twitter.zipkin.gen.BinaryAnnotation

H

handle(ClientRequestAdapter) - Method in class com.github.kristofa.brave.ClientRequestInterceptor

Handles outgoing request.

handle(ClientResponseAdapter) - Method in class com.github.kristofa.brave.ClientResponseInterceptor

Handle a client response.

handle(ServerRequestAdapter) - Method in class com.github.kristofa.brave.ServerRequestInterceptor

Handles incoming request.

handle(ServerResponseAdapter) - Method in class com.github.kristofa.brave.ServerResponseInterceptor

hashCode() - Method in class com.github.kristofa.brave.SpanId

hashCode() - Method in class com.twitter.zipkin.gen.Annotation

hashCode() - Method in class com.twitter.zipkin.gen.BinaryAnnotation

hashCode() - Method in class com.twitter.zipkin.gen.Endpoint

hashCode() - Method in class com.twitter.zipkin.gen.Span

host - Variable in class com.twitter.zipkin.gen.Annotation

Always the host that recorded the event.

host - Variable in class com.twitter.zipkin.gen.BinaryAnnotation

The host that recorded tag, which allows you to differentiate between multiple tags with the same key.

HTTP_HOST - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_METHOD - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_PATH - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_REQUEST_SIZE - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_RESPONSE_SIZE - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_STATUS_CODE - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

HTTP_URL - Static variable in class com.github.kristofa.brave.TraceKeys

Deprecated.

I

IdConversion - Class in com.github.kristofa.brave

Contains conversion utilities for converting trace and span ids from long to string and vice versa.

IdConversion() - Constructor for class com.github.kristofa.brave.IdConversion

incrementAcceptedSpans(int) - Method in class com.github.kristofa.brave.EmptySpanCollectorMetricsHandler

incrementAcceptedSpans(int) - Method in interface com.github.kristofa.brave.SpanCollectorMetricsHandler

Called when spans are submitted to SpanCollector for processing.

incrementDroppedSpans(int) - Method in class com.github.kristofa.brave.EmptySpanCollectorMetricsHandler

incrementDroppedSpans(int) - Method in interface com.github.kristofa.brave.SpanCollectorMetricsHandler

Called when spans become lost for any reason and won't be delivered to the target collector.

invokeAll(Collection<? extends Callable<T>>) - Method in class com.github.kristofa.brave.BraveExecutorService

invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class com.github.kristofa.brave.BraveExecutorService

invokeAny(Collection<? extends Callable<T>>) - Method in class com.github.kristofa.brave.BraveExecutorService

invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class com.github.kristofa.brave.BraveExecutorService

ipv4 - Variable in class com.twitter.zipkin.gen.Endpoint

IPv4 host address packed into 4 bytes.

isDebug() - Method in class com.twitter.zipkin.gen.Span

isSampled(long) - Method in class com.github.kristofa.brave.BoundarySampler

Returns true when abs(traceId) <= boundary

isSampled(long) - Method in class com.github.kristofa.brave.CountingSampler

loops over the pre-canned decisions, resetting to zero when it gets to the end.

isSampled(long) - Method in class com.github.kristofa.brave.Sampler

Returns true if the trace ID should be measured.

isShutdown() - Method in class com.github.kristofa.brave.BraveExecutorService

isTerminated() - Method in class com.github.kristofa.brave.BraveExecutorService

J

JSON - Static variable in class com.github.kristofa.brave.internal.DefaultSpanCodec

JSON - Static variable in interface com.twitter.zipkin.gen.SpanCodec

K

key - Variable in class com.twitter.zipkin.gen.BinaryAnnotation

KeyValueAnnotation - Class in com.github.kristofa.brave

L

LOCAL_COMPONENT - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

The value of "lc" is the component or namespace of a local span.

LocalSpanAndEndpoint() - Constructor for class com.github.kristofa.brave.SpanAndEndpoint.LocalSpanAndEndpoint

LocalSpanState - Interface in com.github.kristofa.brave

Maintains state for a single local span.

localTracer() - Method in class com.github.kristofa.brave.Brave

Returns a tracer used to log in-process activity.

LocalTracer - Class in com.github.kristofa.brave

Local tracer is designed for in-process activity that explains latency.

LoggingSpanCollector - Class in com.github.kristofa.brave

Simple SpanCollector implementation which logs the span through jul at INFO level.

LoggingSpanCollector() - Constructor for class com.github.kristofa.brave.LoggingSpanCollector

LoggingSpanCollector(String) - Constructor for class com.github.kristofa.brave.LoggingSpanCollector

N

NEVER_SAMPLE - Static variable in class com.github.kristofa.brave.Sampler

NoAnnotationsClientResponseAdapter - Class in com.github.kristofa.brave

Nullable - Annotation Type in com.github.kristofa.brave.internal

Libraries such as Guice and AutoValue will process any annotation named Nullable.

nullableParentId() - Method in class com.github.kristofa.brave.SpanId

Returns null when this is a root span.

P

parentId(Long) - Method in class com.github.kristofa.brave.SpanId.Builder

If your trace ids are not span ids, you must call this method to indicate absent parent.

parentId - Variable in class com.github.kristofa.brave.SpanId

The parent's SpanId.spanId or SpanId.spanId if this the root span in a trace.

port - Variable in class com.twitter.zipkin.gen.Endpoint

IPv4 port Note: this is to be treated as an unsigned integer, so watch for negatives.

R

randomGenerator(Random) - Method in class com.github.kristofa.brave.ClientTracer.Builder

Used to generate new trace/span ids.

randomGenerator(Random) - Method in class com.github.kristofa.brave.ServerTracer.Builder

Used to generate new trace/span ids.

readSpan(byte[]) - Method in class com.github.kristofa.brave.internal.DefaultSpanCodec

readSpan(byte[]) - Method in interface com.twitter.zipkin.gen.SpanCodec

throws IllegalArgumentException if the span couldn't be decoded

reportSpans(List<Span>) - Method in class com.github.kristofa.brave.AbstractSpanCollector

reportSpans(List<Span>) - Method in class com.github.kristofa.brave.FlushingSpanCollector

Reports a list of spans over the current transport.

requestAnnotations() - Method in interface com.github.kristofa.brave.ClientRequestAdapter

Returns a collection of annotations that should be added to span for given request.

requestAnnotations() - Method in interface com.github.kristofa.brave.ServerRequestAdapter

Returns a collection of annotations that should be added to span for incoming request.

responseAnnotations() - Method in interface com.github.kristofa.brave.ClientResponseAdapter

Returns a collection of annotations that should be added to span based on response.

responseAnnotations() - Method in class com.github.kristofa.brave.NoAnnotationsClientResponseAdapter

responseAnnotations() - Method in interface com.github.kristofa.brave.ServerResponseAdapter

Returns a collection of annotations that should be added to span before returning response.

root() - Method in class com.github.kristofa.brave.SpanId

Returns true if this is the root span.

run() - Method in class com.github.kristofa.brave.BraveRunnable

S

sample() - Method in interface com.github.kristofa.brave.CommonSpanState

Indicates if we should sample current request.

sample() - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

sample(Boolean) - Method in interface com.github.kristofa.brave.TraceData.Builder

sampled(Boolean) - Method in class com.github.kristofa.brave.SpanId.Builder

sampled() - Method in class com.github.kristofa.brave.SpanId

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.

Sampler - Class in com.github.kristofa.brave

Sampler is responsible for deciding if a particular trace should be "sampled", i.e.

Sampler() - Constructor for class com.github.kristofa.brave.Sampler

sendSpans(byte[]) - Method in class com.github.kristofa.brave.AbstractSpanCollector

Sends a encoded list of spans over the current transport.

SERVER_ADDR - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Indicates a server address ("sa") in a span.

SERVER_RECV - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

The server received ("sr") a request from a client.

SERVER_RECV_FRAGMENT - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs progress of a (SERVER_RECV, WIRE_RECV).

SERVER_SEND - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

The server sent ("ss") a response to a client.

SERVER_SEND_FRAGMENT - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs progress of a (SERVER_SEND, WIRE_SEND).

serverAddress() - Method in interface com.github.kristofa.brave.ClientRequestAdapter

Provides the remote server address information for additional tracking.

ServerClientAndLocalSpanState - Interface in com.github.kristofa.brave

Combines server and client span state.

ServerRequestAdapter - Interface in com.github.kristofa.brave

Provides properties needed for dealing with server request.

serverRequestInterceptor() - Method in class com.github.kristofa.brave.Brave

ServerRequestInterceptor - Class in com.github.kristofa.brave

Contains logic for handling an incoming server request.

ServerRequestInterceptor(ServerTracer) - Constructor for class com.github.kristofa.brave.ServerRequestInterceptor

ServerResponseAdapter - Interface in com.github.kristofa.brave

serverResponseInterceptor() - Method in class com.github.kristofa.brave.Brave

ServerResponseInterceptor - Class in com.github.kristofa.brave

Contains logic for dealing with response being returned at server side.

ServerResponseInterceptor(ServerTracer) - Constructor for class com.github.kristofa.brave.ServerResponseInterceptor

ServerSpan - Class in com.github.kristofa.brave

The ServerSpan is initialized by ServerTracer and keeps track of Trace/Span state of our service request.

ServerSpanAndEndpoint() - Constructor for class com.github.kristofa.brave.SpanAndEndpoint.ServerSpanAndEndpoint

serverSpanAnnotationSubmitter() - Method in class com.github.kristofa.brave.Brave

Can be used to submit application specific annotations to the current server span.

ServerSpanState - Interface in com.github.kristofa.brave

Maintains state for a single server span.

serverSpanThreadBinder() - Method in class com.github.kristofa.brave.Brave

Helper object that can be used to propogate server trace state.

ServerSpanThreadBinder - Class in com.github.kristofa.brave

Allows binding span from request thread to a new executor thread.

ServerSpanThreadBinder(ServerSpanState) - Constructor for class com.github.kristofa.brave.ServerSpanThreadBinder

Creates a new instance.

serverTracer() - Method in class com.github.kristofa.brave.Brave

Server Tracer.

ServerTracer - Class in com.github.kristofa.brave

Used for setting up trace information for a request.

ServerTracer.Builder - Class in com.github.kristofa.brave

service_name - Variable in class com.twitter.zipkin.gen.Endpoint

Service name in lowercase, such as "memcache" or "zipkin-web" Conventionally, when the service name isn't known, service_name = "unknown".

setAnnotations(List<Annotation>) - Method in class com.twitter.zipkin.gen.Span

setBinaryAnnotations(List<BinaryAnnotation>) - Method in class com.twitter.zipkin.gen.Span

setClientReceived() - Method in class com.github.kristofa.brave.ClientTracer

Sets the 'client received' event for current thread.

setClientSent() - Method in class com.github.kristofa.brave.ClientTracer

Sets 'client sent' event for current thread.

setClientSent(int, int, String) - Method in class com.github.kristofa.brave.ClientTracer

Like ClientTracer.setClientSent(), except you can log the network context of the destination.

setCurrentClientSpan(Span) - Method in interface com.github.kristofa.brave.ClientSpanState

Sets current client span.

setCurrentClientSpan(Span) - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Sets current client span.

setCurrentLocalSpan(Span) - Method in interface com.github.kristofa.brave.LocalSpanState

Sets current local span.

setCurrentLocalSpan(Span) - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

setCurrentServerSpan(ServerSpan) - Method in interface com.github.kristofa.brave.ServerSpanState

Set span for current request.

setCurrentServerSpan(ServerSpan) - Method in class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Set span for current request.

setCurrentSpan(Span) - Method in class com.github.kristofa.brave.ClientSpanThreadBinder

Binds given span to current thread.

setCurrentSpan(ServerSpan) - Method in class com.github.kristofa.brave.ServerSpanThreadBinder

Binds given span to current thread.

setDebug(Boolean) - Method in class com.twitter.zipkin.gen.Span

setDuration(Long) - Method in class com.twitter.zipkin.gen.Span

Measurement of duration in microseconds, used to support queries.

setId(long) - Method in class com.twitter.zipkin.gen.Span

setName(String) - Method in class com.twitter.zipkin.gen.Span

Span name in lowercase, rpc method for example Conventionally, when the span name isn't known, name = "unknown".

setParent_id(Long) - Method in class com.twitter.zipkin.gen.Span

setServerReceived() - Method in class com.github.kristofa.brave.ServerTracer

Sets server received event for current request.

setServerReceived(int, int, String) - Method in class com.github.kristofa.brave.ServerTracer

Like ServerTracer.setServerReceived(), except you can log the network context of the caller, for example an IP address from the X-Forwarded-For header.

setServerSend() - Method in class com.github.kristofa.brave.ServerTracer

Sets the server sent event for current thread.

setStateCurrentTrace(long, long, Long, String) - Method in class com.github.kristofa.brave.ServerTracer

Sets the current Trace/Span state.

setStateNoTracing() - Method in class com.github.kristofa.brave.ServerTracer

Sets the current Trace/Span state.

setStateUnknown(String) - Method in class com.github.kristofa.brave.ServerTracer

Sets the current Trace/Span state.

setTimestamp(Long) - Method in class com.twitter.zipkin.gen.Span

Microseconds from epoch of the creation of this span.

setTrace_id(long) - Method in class com.twitter.zipkin.gen.Span

shutdown() - Method in class com.github.kristofa.brave.BraveExecutorService

shutdownNow() - Method in class com.github.kristofa.brave.BraveExecutorService

span() - Method in class com.github.kristofa.brave.SpanAndEndpoint.ClientSpanAndEndpoint

Gets the span to which to add annotations.

span() - Method in class com.github.kristofa.brave.SpanAndEndpoint.LocalSpanAndEndpoint

span() - Method in class com.github.kristofa.brave.SpanAndEndpoint.ServerSpanAndEndpoint

Gets the span to which to add annotations.

span() - Method in interface com.github.kristofa.brave.SpanAndEndpoint

Gets the span to which to add annotations.

Span - Class in com.twitter.zipkin.gen

A trace is a series of spans (often RPC calls) which form a latency tree.

Span() - Constructor for class com.twitter.zipkin.gen.Span

SpanAndEndpoint - Interface in com.github.kristofa.brave

SpanAndEndpoint.ClientSpanAndEndpoint - Class in com.github.kristofa.brave

SpanAndEndpoint.LocalSpanAndEndpoint - Class in com.github.kristofa.brave

SpanAndEndpoint.ServerSpanAndEndpoint - Class in com.github.kristofa.brave

SpanAndEndpoint.StaticSpanAndEndpoint - Class in com.github.kristofa.brave

Span and endpoint never change reference.

SpanCodec - Interface in com.twitter.zipkin.gen

spanCollector(SpanCollector) - Method in class com.github.kristofa.brave.Brave.Builder

spanCollector(SpanCollector) - Method in class com.github.kristofa.brave.ClientTracer.Builder

spanCollector(SpanCollector) - Method in class com.github.kristofa.brave.ServerTracer.Builder

SpanCollector - Interface in com.github.kristofa.brave

Collects spans that are submitted by ServerTracer and ClientTracer.

SpanCollectorMetricsHandler - Interface in com.github.kristofa.brave

Monitor SpanCollector by implementing reactions to these events, e.g.

SpanId - Class in com.github.kristofa.brave

Contains trace data that's propagated in-band across requests, sometimes known as Baggage.

SpanId(long, long, long, long) - Constructor for class com.github.kristofa.brave.SpanId

Deprecated.

Please use SpanId.Builder

spanId(long) - Method in class com.github.kristofa.brave.SpanId.Builder

spanId - Variable in class com.github.kristofa.brave.SpanId

Unique 8-byte identifier of this span within a trace.

spanId(SpanId) - Method in interface com.github.kristofa.brave.TraceData.Builder

SpanId.Builder - Class in com.github.kristofa.brave

startNewSpan(String) - Method in class com.github.kristofa.brave.ClientTracer

Start a new span for a new client request that will be bound to current thread.

startNewSpan(String, String) - Method in class com.github.kristofa.brave.LocalTracer

Request a new local span, which starts now.

startNewSpan(String, String, long) - Method in class com.github.kristofa.brave.LocalTracer

Request a new local span, which started at the given timestamp.

startTick - Variable in class com.twitter.zipkin.gen.Span

Internal field, used for deriving duration with System.nanoTime().

state(ServerClientAndLocalSpanState) - Method in class com.github.kristofa.brave.ClientTracer.Builder

state(ServerSpanState) - Method in class com.github.kristofa.brave.ServerTracer.Builder

StaticSpanAndEndpoint() - Constructor for class com.github.kristofa.brave.SpanAndEndpoint.StaticSpanAndEndpoint

submit(Callable<T>) - Method in class com.github.kristofa.brave.BraveExecutorService

submit(Runnable) - Method in class com.github.kristofa.brave.BraveExecutorService

submit(Runnable, T) - Method in class com.github.kristofa.brave.BraveExecutorService

submitAnnotation(String) - Method in class com.github.kristofa.brave.AnnotationSubmitter

Associates an event that explains latency with the current system time.

submitAnnotation(String, long) - Method in class com.github.kristofa.brave.AnnotationSubmitter

Associates an event that explains latency with a timestamp.

submitBinaryAnnotation(String, String) - Method in class com.github.kristofa.brave.AnnotationSubmitter

Binary annotations are tags applied to a Span to give it context.

submitBinaryAnnotation(String, int) - Method in class com.github.kristofa.brave.AnnotationSubmitter

Submits a binary (key/value) annotation with int value.

T

THREAD_DURATION - Static variable in class com.github.kristofa.brave.BraveAnnotations

Deprecated.

Thread duration.

ThreadLocalServerClientAndLocalSpanState - Class in com.github.kristofa.brave

ServerClientAndLocalSpanState implementation that keeps trace state using a ThreadLocal variable.

ThreadLocalServerClientAndLocalSpanState(InetAddress, int, String) - Constructor for class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Deprecated.

Please switch to constructor that takes 'int' for ip. This only does a conversion from the InetAddress to integer anyway and using InetAddress can result in ns lookup and nasty side effects.

ThreadLocalServerClientAndLocalSpanState(int, int, String) - Constructor for class com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

Constructor

THRIFT - Static variable in class com.github.kristofa.brave.internal.DefaultSpanCodec

THRIFT - Static variable in interface com.twitter.zipkin.gen.SpanCodec

timestamp - Variable in class com.twitter.zipkin.gen.Annotation

Microseconds from epoch.

toBuilder() - Method in class com.github.kristofa.brave.SpanId

toSpan() - Method in class com.github.kristofa.brave.SpanId

Preferred way to create spans, as it properly deals with the parent id

toString() - Method in class com.github.kristofa.brave.BoundarySampler

toString() - Method in class com.github.kristofa.brave.CountingSampler

toString() - Method in class com.github.kristofa.brave.SpanId

Returns $traceId.$spanId<:$parentId

toString() - Method in class com.twitter.zipkin.gen.Span

toZipkin() - Method in class com.twitter.zipkin.gen.Span

Changes this to a zipkin-native span object.

trace(long, String) - Method in class com.github.kristofa.brave.FixedSampleRateTraceFilter

Deprecated.

Indicates if we should trace request with given name.

trace(long, String) - Method in interface com.github.kristofa.brave.TraceFilter

Deprecated.

Indicates if we should trace request with given name.

TraceData - Class in com.github.kristofa.brave

Trace properties we potentially get from incoming request.

TraceData() - Constructor for class com.github.kristofa.brave.TraceData

TraceData.Builder - Interface in com.github.kristofa.brave

TraceFilter - Interface in com.github.kristofa.brave

Deprecated.

Use Sampler instead.

traceFilters(List<TraceFilter>) - Method in class com.github.kristofa.brave.Brave.Builder

Deprecated.

use Brave.Builder.traceSampler(Sampler) as filters here will be ignored.

traceId(long) - Method in class com.github.kristofa.brave.SpanId.Builder

traceId - Variable in class com.github.kristofa.brave.SpanId

Unique 8-byte identifier for a trace, set on all spans within it.

TraceKeys - Class in com.github.kristofa.brave

Deprecated.

use TraceKeys; will be removed in Brave 2.0

traceSampler(Sampler) - Method in class com.github.kristofa.brave.Brave.Builder

traceSampler(Sampler) - Method in class com.github.kristofa.brave.ClientTracer.Builder

traceSampler(Sampler) - Method in class com.github.kristofa.brave.ServerTracer.Builder

type - Variable in class com.twitter.zipkin.gen.BinaryAnnotation

U

UTF_8 - Static variable in class com.github.kristofa.brave.internal.Util

Util - Class in com.github.kristofa.brave.internal

Utilities, typically copied in from guava, so as to avoid dependency conflicts.

V

value - Variable in class com.twitter.zipkin.gen.Annotation

value - Variable in class com.twitter.zipkin.gen.BinaryAnnotation

valueOf(String) - Static method in enum com.twitter.zipkin.gen.AnnotationType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.twitter.zipkin.gen.AnnotationType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WIRE_RECV - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs an attempt to receive a message from the wire.

WIRE_SEND - Static variable in class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

Optionally logs an attempt to send a message on the wire.

writeSpan(Span) - Method in class com.github.kristofa.brave.internal.DefaultSpanCodec

writeSpan(Span) - Method in interface com.twitter.zipkin.gen.SpanCodec

writeSpans(List<Span>) - Method in class com.github.kristofa.brave.internal.DefaultSpanCodec

writeSpans(List<Span>) - Method in interface com.twitter.zipkin.gen.SpanCodec

Z

zipkinCoreConstants - Class in com.twitter.zipkin.gen

Deprecated.

use Constants; will be removed in Brave 2.0

zipkinCoreConstants() - Constructor for class com.twitter.zipkin.gen.zipkinCoreConstants

Deprecated.

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