com.lightstep.tracer.shared

Class AbstractTracer

java.lang.Object

com.lightstep.tracer.shared.AbstractTracer

All Implemented Interfaces:

io.opentracing.Tracer, Closeable, AutoCloseable

public abstract class AbstractTracer
extends Object
implements io.opentracing.Tracer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTracer.InternalLogLevel For mapping internal logs to Android log levels without importing Android packages.

Nested classes/interfaces inherited from interface io.opentracing.Tracer

io.opentracing.Tracer.SpanBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LIGHTSTEP_TRACER_PLATFORM_KEY
protected static String	LIGHTSTEP_TRACER_PLATFORM_VERSION_KEY
protected static String	LIGHTSTEP_TRACER_VERSION_KEY
protected Object	mutex

Constructor Summary

Constructors

Constructor and Description
AbstractTracer(Options options)

Method Summary

Modifier and Type	Method and Description
io.opentracing.Scope	activateSpan(io.opentracing.Span span)
io.opentracing.Span	activeSpan()
protected void	addTracerTag(String key, Object value)
io.opentracing.Tracer.SpanBuilder	buildSpan(String operationName)
void	close() Closes this Tracer.
protected void	debug(String s) Internal logging.
protected void	debug(String msg, Throwable throwable) Internal logging.
protected void	error(String s) Internal logging.
protected void	error(String msg, Throwable throwable) Internal error.
<C> io.opentracing.SpanContext	extract(io.opentracing.propagation.Format<C> format, C carrier)
Boolean	flush(long timeoutMillis) Initiates a flush of data to the collectors.
protected abstract SimpleFuture<Boolean>	flushInternal(boolean explicitRequest)
protected void	info(String s) Internal logging.
protected void	info(String msg, Throwable throwable) Internal logging.
<C> void	inject(io.opentracing.SpanContext spanContext, io.opentracing.propagation.Format<C> format, C carrier)
boolean	isDisabled()
protected abstract void	printLogToConsole(AbstractTracer.InternalLogLevel level, String msg, Throwable throwable)
io.opentracing.ScopeManager	scopeManager()
protected boolean	sendReport(boolean explicitRequest) Does the work of a flush by sending spans to the collector.
Status	status() Internal method used primarily for unit testing and debugging.
protected void	warn(String s) Internal logging.
protected void	warn(String msg, Throwable throwable) Internal warning.

Methods inherited from class java.lang.Object

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

Field Detail

LIGHTSTEP_TRACER_PLATFORM_KEY

protected static final String LIGHTSTEP_TRACER_PLATFORM_KEY

See Also:

Constant Field Values

LIGHTSTEP_TRACER_PLATFORM_VERSION_KEY

protected static final String LIGHTSTEP_TRACER_PLATFORM_VERSION_KEY

See Also:

Constant Field Values

LIGHTSTEP_TRACER_VERSION_KEY

protected static final String LIGHTSTEP_TRACER_VERSION_KEY

See Also:

Constant Field Values

mutex

protected final Object mutex

Constructor Detail

AbstractTracer

public AbstractTracer(Options options)

Method Detail

isDisabled

public boolean isDisabled()

scopeManager

public io.opentracing.ScopeManager scopeManager()

Specified by:

scopeManager in interface io.opentracing.Tracer

activeSpan

public io.opentracing.Span activeSpan()

Specified by:

activeSpan in interface io.opentracing.Tracer

activateSpan

public io.opentracing.Scope activateSpan(io.opentracing.Span span)

Specified by:

activateSpan in interface io.opentracing.Tracer

buildSpan

public io.opentracing.Tracer.SpanBuilder buildSpan(String operationName)

Specified by:

buildSpan in interface io.opentracing.Tracer

inject

public <C> void inject(io.opentracing.SpanContext spanContext,
                       io.opentracing.propagation.Format<C> format,
                       C carrier)

Specified by:

inject in interface io.opentracing.Tracer

extract

public <C> io.opentracing.SpanContext extract(io.opentracing.propagation.Format<C> format,
                                              C carrier)

Specified by:

extract in interface io.opentracing.Tracer

close

public void close()

Closes this Tracer. Method tries to flush pending Spans, and closes the Tracer afterwards, turning subsequent method invocations into no-ops.

Specified by:

close in interface io.opentracing.Tracer

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

flush

public Boolean flush(long timeoutMillis)

Initiates a flush of data to the collectors. Method does not return until the flush is complete, or has timed out.

Parameters:

timeoutMillis - The amount of time, in milliseconds, to allow for the flush to complete

Returns:

True if the flush completed within the time allotted, false otherwise.

flushInternal

protected abstract SimpleFuture<Boolean> flushInternal(boolean explicitRequest)

sendReport

protected boolean sendReport(boolean explicitRequest)

Does the work of a flush by sending spans to the collector.

Parameters:

explicitRequest - if true, the report request was made explicitly rather than implicitly (via a reporting loop) and therefore the code should make a 'best effort' to truly report (i.e. send even if the clock state is not ready).

Returns:

true if the report was sent successfully

addTracerTag

protected void addTracerTag(String key,
                            Object value)

debug

protected void debug(String s)

Internal logging.

debug

protected void debug(String msg,
                     Throwable throwable)

Internal logging.

info

protected void info(String s)

Internal logging.

info

protected void info(String msg,
                    Throwable throwable)

Internal logging.

warn

protected void warn(String s)

Internal logging.

warn

protected void warn(String msg,
                    Throwable throwable)

Internal warning.

error

protected void error(String s)

Internal logging.

error

protected void error(String msg,
                     Throwable throwable)

Internal error.

printLogToConsole

protected abstract void printLogToConsole(AbstractTracer.InternalLogLevel level,
                                          String msg,
                                          Throwable throwable)

status

public Status status()

Internal method used primarily for unit testing and debugging. This is not part of the OpenTracing API and is not a supported API. Copies the internal state/status into an object that's easier to check against in unit tests.