io.opencensus.exporter.trace

Class TimeLimitedHandler

java.lang.Object

io.opencensus.trace.export.SpanExporter.Handler

io.opencensus.exporter.trace.TimeLimitedHandler

public abstract class TimeLimitedHandler
extends io.opencensus.trace.export.SpanExporter.Handler

Copy-pasted from OpenCensus library handler to avoid package-private access. 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 and Description
protected	TimeLimitedHandler(io.opencensus.trace.Tracer tracer, io.opencensus.common.Duration deadline, String exportSpanName)

Method Summary

Modifier and Type	Method and Description
void	export(Collection<io.opencensus.trace.export.SpanData> spanDataList)
abstract void	timeLimitedExport(Collection<io.opencensus.trace.export.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 java.lang.Object

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

Constructor Detail

TimeLimitedHandler

protected TimeLimitedHandler(io.opencensus.trace.Tracer tracer,
                             io.opencensus.common.Duration deadline,
                             String exportSpanName)

Parameters:

tracer - Tracer.

deadline - Deadline.

exportSpanName - Export span name.

Method Detail

timeLimitedExport

public abstract void timeLimitedExport(Collection<io.opencensus.trace.export.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<io.opencensus.trace.export.SpanData> spanDataList)

Specified by:

export in class io.opencensus.trace.export.SpanExporter.Handler