org.ballerinalang.util.tracer

Class OpenTracerBallerinaWrapper

java.lang.Object

org.ballerinalang.util.tracer.OpenTracerBallerinaWrapper

public class OpenTracerBallerinaWrapper
extends Object

This class wraps opentracing apis and exposes native functions to use within ballerina.

Constructor Summary

Constructors

Constructor and Description
OpenTracerBallerinaWrapper()

Method Summary

Modifier and Type	Method and Description
void	addTags(String spanId, String tagKey, String tagValue) Method to add tags to an existing span.
Map<String,io.opentracing.SpanContext>	extract(String encodedHeader) Method to create an entry in span store by extracting a spanContext from a Map carrier.
void	finishSpan(String spanId) Method to mark a span as finished.
String	getBaggageItem(String spanId, String baggageKey) Method to get a baggage value from an existing span.
static OpenTracerBallerinaWrapper	getInstance()
Map<String,String>	inject(String suffix, String spanId) Method to inject the span context of a span into a map carrier.
void	log(String spanId, Map<String,String> logs) Method to add logs to an existing span.
void	setBaggageItem(String spanId, String baggageKey, String baggageValue) Method to add baggage item to an existing span.
String	startSpan(String serviceName, String spanName, Map<String,String> tags, ReferenceType referenceType, Map<String,io.opentracing.SpanContext> parentSpanContext) Method to start a span using parent span context.
String	startSpan(String serviceName, String spanName, Map<String,String> tags, ReferenceType referenceType, String parentSpanId) Method to start a span using parent span id.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenTracerBallerinaWrapper

public OpenTracerBallerinaWrapper()

Method Detail

getInstance

public static OpenTracerBallerinaWrapper getInstance()

extract

public Map<String,io.opentracing.SpanContext> extract(String encodedHeader)

Method to create an entry in span store by extracting a spanContext from a Map carrier.

Parameters:

encodedHeader - map of headers used to extract a spanContext

Returns:

the map of span contexts for each tracer implementation

inject

public Map<String,String> inject(String suffix,
                                 String spanId)

Method to inject the span context of a span into a map carrier.

Parameters:

suffix - trace header suffix to distinguish between OOTB headers and user defined headers.

spanId - the span Id of the span to be injected

Returns:

the map carrier holding the span context

startSpan

public String startSpan(String serviceName,
                        String spanName,
                        Map<String,String> tags,
                        ReferenceType referenceType,
                        String parentSpanId)

Method to start a span using parent span id.

Parameters:

serviceName - name of the service the span should belong to

spanName - name of the span

tags - key value paired tags to attach to the span

referenceType - type of reference to any parent span

parentSpanId - id of the parent span

Returns:

unique id of the created span

startSpan

public String startSpan(String serviceName,
                        String spanName,
                        Map<String,String> tags,
                        ReferenceType referenceType,
                        Map<String,io.opentracing.SpanContext> parentSpanContext)

Method to start a span using parent span context.

Parameters:

serviceName - name of the service the span should belong to

spanName - name of the span

tags - key value paired tags to attach to the span

referenceType - type of reference to any parent span

parentSpanContext - map of the parent span context

Returns:

unique id of the created span

finishSpan

public void finishSpan(String spanId)

Method to mark a span as finished.

Parameters:

spanId - the id of the span to finish

addTags

public void addTags(String spanId,
                    String tagKey,
                    String tagValue)

Method to add tags to an existing span.

Parameters:

spanId - the id of the span

tagKey - the key of the tag

tagValue - the value of the tag

log

public void log(String spanId,
                Map<String,String> logs)

Method to add logs to an existing span.

Parameters:

spanId - the id of the span

logs - the map (event, message) to be logged

setBaggageItem

public void setBaggageItem(String spanId,
                           String baggageKey,
                           String baggageValue)

Method to add baggage item to an existing span.

Parameters:

spanId - the id of the span

baggageKey - the key of the baggage item

baggageValue - the value of the baggage item

getBaggageItem

public String getBaggageItem(String spanId,
                             String baggageKey)

Method to get a baggage value from an existing span.

Parameters:

spanId - the id of the span

baggageKey - the key of the baggage item. null of no baggage key or tracing disabled

Returns:

baggage item value