com.github.kristofa.brave

Interface AnnotationSubmitter

All Known Subinterfaces:

ClientTracer, ServerTracer

public interface AnnotationSubmitter

Used to submit application specific annotations.

Author:

kristof

Method Summary

Methods

Modifier and Type	Method and Description
void	submitAnnotation(String annotationName) Submits custom annotation for current span.
void	submitAnnotation(String annotationName, long startTime, long endTime) Submits custom annotation that represents an event with duration.
void	submitBinaryAnnotation(String key, int value) Submits a binary (key/value) annotation with int value.
void	submitBinaryAnnotation(String key, String value) Submits a binary (key/value) annotation with String value.

Method Detail

submitAnnotation

void submitAnnotation(String annotationName,
                    long startTime,
                    long endTime)

Submits custom annotation that represents an event with duration.

Parameters:

annotationName - Custom annotation.

startTime - Start time, Unix time in milliseconds. eg System.currentTimeMillis().

endTime - End time, Unix time in milliseconds. eg System.currentTimeMillis().

submitAnnotation

void submitAnnotation(String annotationName)

Submits custom annotation for current span. Use this method if your annotation has no duration assigned to it.

Parameters:

annotationName - Custom annotation for current span.

submitBinaryAnnotation

void submitBinaryAnnotation(String key,
                          String value)

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

Parameters:

key - Key, should not be blank.

value - String value, should not be null.

submitBinaryAnnotation

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.