zipkin

Class Annotation

java.lang.Object

zipkin.Annotation

All Implemented Interfaces:

Serializable, Comparable<Annotation>

public final class Annotation
extends Object
implements Comparable<Annotation>, Serializable

Associates an event that explains latency with a timestamp.

Unlike log statements, annotations are often codes: Ex. "sr".

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Annotation.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Endpoint	endpoint The host that recorded value, primarily for query by service name.
long	timestamp Microseconds from epoch.
String	value Usually a short tag indicating an event, like "sr".

Method Summary

Modifier and Type	Method and Description
static Annotation.Builder	builder()
int	compareTo(Annotation that) Compares by timestamp, then value.
static Annotation	create(long timestamp, String value, Endpoint endpoint)
boolean	equals(Object o)
int	hashCode()
Annotation.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

timestamp

public final long timestamp

Microseconds from epoch.

This value should be set directly by instrumentation, using the most precise value possible. For example, gettimeofday or multiplying System.currentTimeMillis() by 1000.

value

public final String value

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

endpoint

@Nullable
public final Endpoint endpoint

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

Method Detail

create

public static Annotation create(long timestamp,
                                String value,
                                @Nullable
                                Endpoint endpoint)

toBuilder

public Annotation.Builder toBuilder()

builder

public static Annotation.Builder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Annotation that)

Compares by timestamp, then value.

Specified by:

compareTo in interface Comparable<Annotation>

toString

public String toString()

Overrides:

toString in class Object