io.opencensus.trace

Class EndSpanOptions.Builder

java.lang.Object

io.opencensus.trace.EndSpanOptions.Builder

Enclosing class:

EndSpanOptions

public abstract static class EndSpanOptions.Builder
extends Object

Builder class for EndSpanOptions.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
abstract EndSpanOptions	build() Builds and returns a EndSpanOptions with the desired settings.
abstract EndSpanOptions.Builder	setSampleToLocalSpanStore(boolean sampleToLocalSpanStore) If set to true this is equivalent with calling the SampledSpanStore.registerSpanNamesForCollection(Collection) in advance for the given span name.
abstract EndSpanOptions.Builder	setStatus(Status status) Sets the status for the Span.

Methods inherited from class java.lang.Object

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

Method Detail

setStatus

public abstract EndSpanOptions.Builder setStatus(Status status)

Sets the status for the Span.

If set, this will override the status set via Span.setStatus(Status).

Parameters:

status - the status.

Returns:

this.

Since:

0.5

setSampleToLocalSpanStore

@ExperimentalApi
public abstract EndSpanOptions.Builder setSampleToLocalSpanStore(boolean sampleToLocalSpanStore)

If set to true this is equivalent with calling the SampledSpanStore.registerSpanNamesForCollection(Collection) in advance for the given span name.

WARNING: setting this option to a randomly generated span name can OOM your process because the library will save samples for each name.

It is strongly recommended to use the SampledSpanStore.registerSpanNamesForCollection(Collection) API instead.

Returns:

this.

Since:

0.8

build

public abstract EndSpanOptions build()

Builds and returns a EndSpanOptions with the desired settings.

Returns:

a EndSpanOptions with the desired settings.

Since:

0.5