com.github.kristofa.brave

Class AnnotationSubmitter

java.lang.Object

com.github.kristofa.brave.AnnotationSubmitter

Direct Known Subclasses:

ClientTracer, LocalTracer, ServerTracer

public abstract class AnnotationSubmitter
extends Object

Used to submit application specific annotations.

Author:

kristof

Method Summary

Modifier and Type	Method and Description
static AnnotationSubmitter	create(SpanAndEndpoint spanAndEndpoint)
void	submitAnnotation(String value) Associates an event that explains latency with the current system time.
void	submitAnnotation(String value, long timestamp) Associates an event that explains latency with a timestamp.
void	submitBinaryAnnotation(String key, int value) Submits a binary (key/value) annotation with int value.
void	submitBinaryAnnotation(String key, String value) Binary annotations are tags applied to a Span to give it context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AnnotationSubmitter create(SpanAndEndpoint spanAndEndpoint)

submitAnnotation

public void submitAnnotation(String value)

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

Parameters:

value - A short tag indicating the event, like "finagle.retry"

submitAnnotation

public void submitAnnotation(String value,
                             long timestamp)

Associates an event that explains latency with a timestamp.

This is an alternative to submitAnnotation(String), when you have a timestamp more precise or accurate than System.currentTimeMillis().

Parameters:

value - A short tag indicating the event, like "finagle.retry"

timestamp - microseconds from epoch

submitBinaryAnnotation

public void submitBinaryAnnotation(String key,
                                   String value)

Binary annotations are tags applied to a Span to give it context. For example, a key "your_app.version" would let you lookup spans by version.

Parameters:

key - Name used to lookup spans, such as "your_app.version"

value - String value, should not be null.

submitBinaryAnnotation

public void submitBinaryAnnotation(String key,
                                   int value)

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

Parameters:

key - Key, should not be blank.

value - Integer value.