com.marklogic.hub.util.metrics.tracer

Class JaegerConfig

java.lang.Object

com.marklogic.hub.util.metrics.tracer.JaegerConfig

public class JaegerConfig
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JaegerConfig()

Method Summary

Modifier and Type	Method and Description
static io.opentracing.Scope	activate(io.opentracing.Span span) Make a Span instance active for the current context (usually a thread).
static io.opentracing.Span	activeSpan()
static io.opentracing.Tracer.SpanBuilder	buildSpan(java.lang.Class spanClass) Builds a span with the current class as the operation name.
static io.opentracing.Tracer.SpanBuilder	buildSpan(java.lang.String operationName) Builds a span with the operation name
static io.opentracing.Tracer.SpanBuilder	buildSpanFromMethod(java.lang.Object enclosed) Builds a span with the current class and method name.
static io.opentracing.Tracer.SpanBuilder	buildSpanFromMethod(java.lang.Object enclosed, io.opentracing.Span parentSpan) Builds a child span with the current class and method name
static boolean	enabled() Returns true when tracing is configured to report spans vs just producing a noop.
static io.opentracing.Tracer	getTracer() Returns the currently configured tracer
static io.opentracing.Tracer	init(java.lang.String service) Initialize a tracer

Methods inherited from class java.lang.Object

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

Constructor Detail

JaegerConfig

public JaegerConfig()

Method Detail

getTracer

public static io.opentracing.Tracer getTracer()

Returns the currently configured tracer

Returns:

a tracer

enabled

public static boolean enabled()

Returns true when tracing is configured to report spans vs just producing a noop.

Returns:

tracer is registered or not

activate

public static io.opentracing.Scope activate(io.opentracing.Span span)

Make a Span instance active for the current context (usually a thread). This is a shorthand for Tracer.scopeManager().activate(span).

Parameters:

span - the built span

Returns:

a Scope instance to control the end of the active period for the Span.

activeSpan

public static io.opentracing.Span activeSpan()

Returns:

the active Span. This is a shorthand for Tracer.scopeManager().activeSpan()

buildSpanFromMethod

public static io.opentracing.Tracer.SpanBuilder buildSpanFromMethod(java.lang.Object enclosed,
                                                                    io.opentracing.Span parentSpan)

Builds a child span with the current class and method name

Parameters:

enclosed - a type created in the current method scope

parentSpan - parent span of the built span

Returns:

a span builder

buildSpan

public static io.opentracing.Tracer.SpanBuilder buildSpan(java.lang.String operationName)

Builds a span with the operation name

Parameters:

operationName - span operation name

Returns:

a span builder

buildSpan

public static io.opentracing.Tracer.SpanBuilder buildSpan(java.lang.Class spanClass)

Builds a span with the current class as the operation name. Usage: JaegerConfig.buildFromMethod(new Object(){})

Parameters:

spanClass - used to set the operation name.

Returns:

a span builder

buildSpanFromMethod

public static io.opentracing.Tracer.SpanBuilder buildSpanFromMethod(java.lang.Object enclosed)

Builds a span with the current class and method name. Usage: JaegerConfig.buildFromMethod(new Object(){})

Parameters:

enclosed - a type created in the current method scope

Returns:

a span builder

init

public static io.opentracing.Tracer init(java.lang.String service)

Initialize a tracer

Parameters:

service - a service name

Returns:

a tracer