com.github.kristofa.brave

Class LocalTracer

java.lang.Object

com.github.kristofa.brave.AnnotationSubmitter

com.github.kristofa.brave.LocalTracer

public abstract class LocalTracer
extends AnnotationSubmitter

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

For example, a local span could represent bootstrap, codec, file i/o or other activity that notably impacts performance.

Local spans always have a binary annotation "lc" which indicates the component name. Usings zipkin's UI or Api, you can query by for spans that use a component like this: lc=spring-boot.

Here's an example of allocating precise duration for a local span:

 tracer.startNewSpan("codec", "encode");
 try {
   return codec.encode(input);
 } finally {
   tracer.finishSpan();
 }
 

See Also:

Constants.LOCAL_COMPONENT

Method Summary

Modifier and Type	Method and Description
void	finishSpan() Completes the span, assigning the most precise duration possible.
void	finishSpan(long duration) Completes the span, which took duration microseconds.
SpanId	startNewSpan(String component, String operation) Request a new local span, which starts now.
SpanId	startNewSpan(String component, String operation, long timestamp) Request a new local span, which started at the given timestamp.

Methods inherited from class com.github.kristofa.brave.AnnotationSubmitter

create, submitAnnotation, submitAnnotation, submitBinaryAnnotation, submitBinaryAnnotation

Methods inherited from class java.lang.Object

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

Method Detail

startNewSpan

public SpanId startNewSpan(String component,
                           String operation)

Request a new local span, which starts now.

Parameters:

component - component responsible for the operation

operation - name of the operation that's begun

Returns:

metadata about the new span or null if one wasn't started due to sampling policy.

See Also:

Constants.LOCAL_COMPONENT

startNewSpan

public SpanId startNewSpan(String component,
                           String operation,
                           long timestamp)

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

Parameters:

component - component responsible for the operation

operation - name of the operation that's begun

timestamp - time the operation started, in epoch microseconds.

Returns:

metadata about the new span or null if one wasn't started due to sampling policy.

See Also:

Constants.LOCAL_COMPONENT

finishSpan

public void finishSpan()

Completes the span, assigning the most precise duration possible.

finishSpan

public void finishSpan(long duration)

Completes the span, which took duration microseconds.