Class TimeLimitedHandler

java.lang.Object

io.opencensus.trace.export.SpanExporter.Handler

io.opencensus.exporter.trace.util.TimeLimitedHandler

public abstract class TimeLimitedHandler
extends SpanExporter.Handler

An abstract class that allows different tracing services to export recorded data for sampled spans in their own format within a given time frame. If export does not complete within the time frame, spans will be dropped and no retries will be performed.

Only extend this class if the client APIs don't support timeout natively. If there is a timeout option in the client APIs (for example Stackdriver Trace V2 API allows you to set timeout), use that instead.

To export data this MUST be register to to the ExportComponent using SpanExporter.registerHandler(String, Handler).

Since:

0.22

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimeLimitedHandler(Duration deadline, String exportSpanName)

Method Summary

Modifier and Type	Method	Description
void	export(Collection<SpanData> spanDataList)	Exports a list of sampled (see TraceOptions.isSampled()) Spans using the immutable representation SpanData.
abstract void	timeLimitedExport(Collection<SpanData> spanDataList)	Exports a list of sampled (see TraceOptions.isSampled()) Spans using the immutable representation SpanData, within the given deadline of this TimeLimitedHandler.

Methods inherited from class Object

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

Constructor Details

TimeLimitedHandler

protected TimeLimitedHandler(Duration deadline,
 String exportSpanName)

Method Details

timeLimitedExport

public abstract void timeLimitedExport(Collection<SpanData> spanDataList)
                                throws Exception

Exports a list of sampled (see TraceOptions.isSampled()) Spans using the immutable representation SpanData, within the given deadline of this TimeLimitedHandler.

Parameters:

spanDataList - a list of SpanData objects to be exported.

Throws:

Exception - throws exception when failed to export.

Since:

0.22

export

public void export(Collection<SpanData> spanDataList)

Description copied from class: SpanExporter.Handler

Exports a list of sampled (see TraceOptions.isSampled()) Spans using the immutable representation SpanData.

This may be called from a different thread than the one that called Span.end().

Implementation SHOULD not block the calling thread. It should execute the export on a different thread if possible.

Specified by:

export in class SpanExporter.Handler

Parameters:

spanDataList - a list of SpanData objects to be exported.