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

A

accept(Iterator<Span>) - Method in interface io.zipkin.SpanStore

Sinks the given spans, ignoring duplicate annotations.

addAnnotation(String) - Method in class io.zipkin.QueryRequest.Builder

addAnnotation(Annotation) - Method in class io.zipkin.Span.Builder

addBinaryAnnotation(String, String) - Method in class io.zipkin.QueryRequest.Builder

addBinaryAnnotation(BinaryAnnotation) - Method in class io.zipkin.Span.Builder

address(String, Endpoint) - Static method in class io.zipkin.BinaryAnnotation

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

Annotation - Class in io.zipkin

Associates an event that explains latency with a timestamp.

Annotation.Builder - Class in io.zipkin

annotations - Variable in class io.zipkin.QueryRequest

Include traces whose Span.annotations include a value in this set.

annotations - Variable in class io.zipkin.Span

Associates events that explain latency with a timestamp.

annotations(Annotation...) - Method in class io.zipkin.Span.Builder

Replaces currently collected annotations.

B

BinaryAnnotation - Class in io.zipkin

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

BinaryAnnotation.Builder - Class in io.zipkin

BinaryAnnotation.Type - Enum in io.zipkin

A subset of thrift base types, except BYTES.

binaryAnnotations - Variable in class io.zipkin.QueryRequest

Include traces whose Span.binaryAnnotations include a String whose key and value are an entry in this set.

binaryAnnotations - Variable in class io.zipkin.Span

Tags a span with context, usually to support query or aggregation.

binaryAnnotations(BinaryAnnotation...) - Method in class io.zipkin.Span.Builder

Replaces currently collected binary annotations.

build() - Method in class io.zipkin.Annotation.Builder

build() - Method in class io.zipkin.BinaryAnnotation.Builder

build() - Method in class io.zipkin.DependencyLink.Builder

build() - Method in class io.zipkin.Endpoint.Builder

build() - Method in class io.zipkin.QueryRequest.Builder

build() - Method in class io.zipkin.Span.Builder

Builder() - Constructor for class io.zipkin.Annotation.Builder

Builder(Annotation) - Constructor for class io.zipkin.Annotation.Builder

Builder() - Constructor for class io.zipkin.BinaryAnnotation.Builder

Builder(BinaryAnnotation) - Constructor for class io.zipkin.BinaryAnnotation.Builder

Builder() - Constructor for class io.zipkin.DependencyLink.Builder

Builder(DependencyLink) - Constructor for class io.zipkin.DependencyLink.Builder

Builder() - Constructor for class io.zipkin.Endpoint.Builder

Builder(Endpoint) - Constructor for class io.zipkin.Endpoint.Builder

Builder(String) - Constructor for class io.zipkin.QueryRequest.Builder

Builder(QueryRequest) - Constructor for class io.zipkin.QueryRequest.Builder

Builder() - Constructor for class io.zipkin.Span.Builder

Builder(Span) - Constructor for class io.zipkin.Span.Builder

C

callCount(long) - Method in class io.zipkin.DependencyLink.Builder

callCount - Variable in class io.zipkin.DependencyLink

calls made during the duration (in microseconds) of this link

child(String) - Method in class io.zipkin.DependencyLink.Builder

child - Variable in class io.zipkin.DependencyLink

child service name (callee)

CLIENT_ADDR - Static variable in class io.zipkin.Constants

When present, BinaryAnnotation.endpoint indicates a client address ("ca") in a span.

CLIENT_RECV - Static variable in class io.zipkin.Constants

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

CLIENT_RECV_FRAGMENT - Static variable in class io.zipkin.Constants

Optionally logs progress of a (Constants.CLIENT_RECV, Constants.WIRE_RECV).

CLIENT_SEND - Static variable in class io.zipkin.Constants

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

CLIENT_SEND_FRAGMENT - Static variable in class io.zipkin.Constants

Optionally logs progress of a (Constants.CLIENT_SEND, Constants.WIRE_SEND).

Codec - Interface in io.zipkin

Methods make an attempt to perform codec operations, failing to null.

Codec.Factory - Interface in io.zipkin

compareTo(Annotation) - Method in class io.zipkin.Annotation

Compares by Annotation.timestamp, then Annotation.value.

compareTo(Span) - Method in class io.zipkin.Span

Compares by Span.timestamp, then Span.name.

Constants - Class in io.zipkin

create(long, String, Endpoint) - Static method in class io.zipkin.Annotation

create(String, String, Endpoint) - Static method in class io.zipkin.BinaryAnnotation

String values are the only queryable type of binary annotation.

create(String, byte[], BinaryAnnotation.Type, Endpoint) - Static method in class io.zipkin.BinaryAnnotation

create(String, String, long) - Static method in class io.zipkin.DependencyLink

create(String, int, int) - Static method in class io.zipkin.Endpoint

create(String, int) - Static method in class io.zipkin.Endpoint

create(float) - Static method in class io.zipkin.Sampler

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

D

debug(Boolean) - Method in class io.zipkin.Span.Builder

debug - Variable in class io.zipkin.Span

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

DependencyLink - Class in io.zipkin

DependencyLink.Builder - Class in io.zipkin

duration(Long) - Method in class io.zipkin.Span.Builder

duration - Variable in class io.zipkin.Span

Measurement in microseconds of the critical path, if known.

E

endpoint(Endpoint) - Method in class io.zipkin.Annotation.Builder

endpoint - Variable in class io.zipkin.Annotation

The host that recorded Annotation.value, primarily for query by service name.

endpoint(Endpoint) - Method in class io.zipkin.BinaryAnnotation.Builder

endpoint - Variable in class io.zipkin.BinaryAnnotation

The host that recorded BinaryAnnotation.value, allowing query by service name or address.

Endpoint - Class in io.zipkin

Indicates the network context of a service involved in a span.

Endpoint.Builder - Class in io.zipkin

endTs(Long) - Method in class io.zipkin.QueryRequest.Builder

endTs - Variable in class io.zipkin.QueryRequest

Only return traces where all Span.timestamp are at or before this time in epoch milliseconds.

equals(Object) - Method in class io.zipkin.Annotation

equals(Object) - Method in class io.zipkin.BinaryAnnotation

equals(Object) - Method in class io.zipkin.DependencyLink

equals(Object) - Method in class io.zipkin.Endpoint

equals(Object) - Method in class io.zipkin.QueryRequest

equals(Object) - Method in class io.zipkin.Span

F

FACTORY - Static variable in interface io.zipkin.Codec

fromValue(int) - Static method in enum io.zipkin.BinaryAnnotation.Type

Returns BinaryAnnotation.Type.BYTES if unknown.

G

get(String) - Method in interface io.zipkin.Codec.Factory

Returns a codec for the given media type (ex.

getDependencies(long, Long) - Method in interface io.zipkin.SpanStore

Returns dependency links derived from spans.

getServiceNames() - Method in interface io.zipkin.SpanStore

Get all the service names.

getSpanNames(String) - Method in interface io.zipkin.SpanStore

Get all the span names for a particular Endpoint.serviceName.

getTraces(QueryRequest) - Method in interface io.zipkin.SpanStore

Get the available trace information from the storage system.

getTracesByIds(List<Long>) - Method in interface io.zipkin.SpanStore

Get the available trace information from the storage system.

H

hashCode() - Method in class io.zipkin.Annotation

hashCode() - Method in class io.zipkin.BinaryAnnotation

hashCode() - Method in class io.zipkin.DependencyLink

hashCode() - Method in class io.zipkin.Endpoint

hashCode() - Method in class io.zipkin.QueryRequest

hashCode() - Method in class io.zipkin.Span

I

id(long) - Method in class io.zipkin.Span.Builder

id - Variable in class io.zipkin.Span

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

io.zipkin - package io.zipkin

ipv4(int) - Method in class io.zipkin.Endpoint.Builder

ipv4 - Variable in class io.zipkin.Endpoint

IPv4 endpoint address packed into 4 bytes.

isSampled(long) - Method in class io.zipkin.Sampler

Returns true if the trace ID should be recorded.

isSampled(long) - Method in class io.zipkin.Sampler.ProbabilisticSampler

J

JSON - Static variable in interface io.zipkin.Codec

K

key(String) - Method in class io.zipkin.BinaryAnnotation.Builder

key - Variable in class io.zipkin.BinaryAnnotation

Name used to lookup spans, such as "http.uri" or "finagle.version".

L

limit(Integer) - Method in class io.zipkin.QueryRequest.Builder

limit - Variable in class io.zipkin.QueryRequest

Maximum number of traces to return.

LOCAL_COMPONENT - Static variable in class io.zipkin.Constants

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

lookback(Long) - Method in class io.zipkin.QueryRequest.Builder

lookback - Variable in class io.zipkin.QueryRequest

Only return traces where all Span.timestamp are at or after (endTs - lookback) in milliseconds.

M

maxDuration(Long) - Method in class io.zipkin.QueryRequest.Builder

maxDuration - Variable in class io.zipkin.QueryRequest

Only return traces whose Span.duration is less than or equal to maxDuration microseconds.

merge(Span) - Method in class io.zipkin.Span.Builder

minDuration(Long) - Method in class io.zipkin.QueryRequest.Builder

minDuration - Variable in class io.zipkin.QueryRequest

Only return traces whose Span.duration is greater than or equal to minDuration microseconds.

N

name(String) - Method in class io.zipkin.Span.Builder

name - Variable in class io.zipkin.Span

Span name in lowercase, rpc method for example.

P

parent(String) - Method in class io.zipkin.DependencyLink.Builder

parent - Variable in class io.zipkin.DependencyLink

parent service name (caller)

parentId(Long) - Method in class io.zipkin.Span.Builder

parentId - Variable in class io.zipkin.Span

The parent's Span.id or null if this the root span in a trace.

port(short) - Method in class io.zipkin.Endpoint.Builder

port - Variable in class io.zipkin.Endpoint

IPv4 port or null, if not known.

ProbabilisticSampler(float) - Constructor for class io.zipkin.Sampler.ProbabilisticSampler

Q

QueryRequest - Class in io.zipkin

Invoking this request retrieves traces matching the below filters.

QueryRequest.Builder - Class in io.zipkin

R

readDependencyLinks(byte[]) - Method in interface io.zipkin.Codec

Returns null if the dependency links couldn't be decoded

readSpan(byte[]) - Method in interface io.zipkin.Codec

Returns null if the span couldn't be decoded

readSpans(byte[]) - Method in interface io.zipkin.Codec

Returns null if the spans couldn't be decoded

S

Sampler - Class in io.zipkin

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

Sampler() - Constructor for class io.zipkin.Sampler

Sampler.ProbabilisticSampler - Class in io.zipkin

Accepts a percentage of trace ids by comparing their absolute value against a boundary.

SERVER_ADDR - Static variable in class io.zipkin.Constants

When present, BinaryAnnotation.endpoint indicates a server address ("sa") in a span.

SERVER_RECV - Static variable in class io.zipkin.Constants

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

SERVER_RECV_FRAGMENT - Static variable in class io.zipkin.Constants

Optionally logs progress of a (Constants.SERVER_RECV, Constants.WIRE_RECV).

SERVER_SEND - Static variable in class io.zipkin.Constants

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

SERVER_SEND_FRAGMENT - Static variable in class io.zipkin.Constants

Optionally logs progress of a (Constants.SERVER_SEND, Constants.WIRE_SEND).

serviceName(String) - Method in class io.zipkin.Endpoint.Builder

serviceName - Variable in class io.zipkin.Endpoint

Classifier of a source or destination in lowercase, such as "zipkin-web".

serviceName(String) - Method in class io.zipkin.QueryRequest.Builder

serviceName - Variable in class io.zipkin.QueryRequest

Mandatory Endpoint.serviceName and constrains all other parameters.

Span - Class in io.zipkin

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

Span.Builder - Class in io.zipkin

spanName(String) - Method in class io.zipkin.QueryRequest.Builder

spanName - Variable in class io.zipkin.QueryRequest

When present, only include traces with this Span.name

SpanStore - Interface in io.zipkin

T

THRIFT - Static variable in interface io.zipkin.Codec

timestamp(long) - Method in class io.zipkin.Annotation.Builder

timestamp - Variable in class io.zipkin.Annotation

Microseconds from epoch.

timestamp(Long) - Method in class io.zipkin.Span.Builder

timestamp - Variable in class io.zipkin.Span

Epoch microseconds of the start of this span, possibly absent if this an incomplete span.

toString() - Method in class io.zipkin.Annotation

toString() - Method in class io.zipkin.BinaryAnnotation

toString() - Method in class io.zipkin.DependencyLink

toString() - Method in class io.zipkin.Endpoint

toString() - Method in class io.zipkin.QueryRequest

toString() - Method in class io.zipkin.Sampler.ProbabilisticSampler

toString() - Method in class io.zipkin.Span

traceId(long) - Method in class io.zipkin.Span.Builder

traceId - Variable in class io.zipkin.Span

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

type(BinaryAnnotation.Type) - Method in class io.zipkin.BinaryAnnotation.Builder

type - Variable in class io.zipkin.BinaryAnnotation

The thrift type of value, most often STRING.

V

value(String) - Method in class io.zipkin.Annotation.Builder

value - Variable in class io.zipkin.Annotation

Usually a short tag indicating an event, like "sr".

value(byte[]) - Method in class io.zipkin.BinaryAnnotation.Builder

value(String) - Method in class io.zipkin.BinaryAnnotation.Builder

value - Variable in enum io.zipkin.BinaryAnnotation.Type

value - Variable in class io.zipkin.BinaryAnnotation

Serialized thrift bytes, in TBinaryProtocol format.

valueOf(String) - Static method in enum io.zipkin.BinaryAnnotation.Type

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

values() - Static method in enum io.zipkin.BinaryAnnotation.Type

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

W

WIRE_RECV - Static variable in class io.zipkin.Constants

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

WIRE_SEND - Static variable in class io.zipkin.Constants

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

writeDependencyLinks(List<DependencyLink>) - Method in interface io.zipkin.Codec

Returns null if the dependency links couldn't be encoded

writeSpan(Span) - Method in interface io.zipkin.Codec

Returns null if the span couldn't be encoded

writeSpans(List<Span>) - Method in interface io.zipkin.Codec

Returns null if the spans couldn't be encoded

writeTraces(List<List<Span>>) - Method in interface io.zipkin.Codec

Returns null if the traces couldn't be encoded

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