org.honton.chas.datadog.apm

Class SpanBuilder

java.lang.Object

org.honton.chas.datadog.apm.SpanBuilder

public class SpanBuilder
extends Object

An active Span builder. Provides methods to get and set the Span attributes. Some attributes, such as the start time, traceId, and parentId are final and cannot be modified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpanBuilder.SpanContext The context of an active Span builder.

Constructor Summary

Constructors

Constructor and Description
SpanBuilder()

Method Summary

Modifier and Type	Method and Description
SpanBuilder	createChild() Create a child of this span
static SpanBuilder	createChild(long traceId, long parentSpanId) Create a builder for a span which is a child of another span.
static SpanBuilder	createRoot() Create a builder for a root span.
SpanBuilder	error(boolean error)
SpanBuilder	exception(Throwable e) Add exception information to the metadata.
SpanBuilder.SpanContext	exportSpan()
Span	finishSpan(String service) Finish building the span.
SpanBuilder	meta(String key, String value) Add meta information.
SpanBuilder	metric(String key, Number value) Add a metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanBuilder

public SpanBuilder()

Method Detail

error

public SpanBuilder error(boolean error)

metric

public SpanBuilder metric(String key,
                          Number value)

Add a metric.

Parameters:

key - The name of the metric

value - The value of the metric

Returns:

The builder, for fluent style programming

meta

public SpanBuilder meta(String key,
                        String value)

Add meta information.

Parameters:

key - The name of the meta information

value - The value of the meta information

Returns:

The builder, for fluent style programming

exception

public SpanBuilder exception(Throwable e)

Add exception information to the metadata. Any previous exception information will be overwritten.

Parameters:

e - The exception to add

Returns:

The builder, for fluent style programming

createChild

public SpanBuilder createChild()

Create a child of this span

Returns:

The child span

createRoot

public static SpanBuilder createRoot()

Create a builder for a root span.

Returns:

A builder for a root span

createChild

public static SpanBuilder createChild(long traceId,
                                      long parentSpanId)

Create a builder for a span which is a child of another span.

Parameters:

traceId - The id of the trace

parentSpanId - The id of the parent span

Returns:

The span which is a child the the imported span.

finishSpan

public Span finishSpan(String service)

Finish building the span. Sets the duration of the span.

Parameters:

service - The service value

Returns:

The immutable Span that was completed

exportSpan

public SpanBuilder.SpanContext exportSpan()