io.sentry

Class Span

java.lang.Object

io.sentry.SpanContext

io.sentry.Span

All Implemented Interfaces:

ISpan, java.lang.Cloneable

public final class Span
extends SpanContext
implements ISpan

Field Summary

Fields inherited from class io.sentry.SpanContext

description, op, status, tags, TYPE

Method Summary

Modifier and Type	Method and Description
void	finish() Sets span timestamp marking this span as finished.
void	finish(@Nullable SpanStatus status) Sets span timestamp marking this span as finished.
@NotNull SpanContext	getSpanContext() Gets the span context.
@NotNull java.util.Date	getStartTimestamp()
@Nullable java.lang.Throwable	getThrowable() Gets the throwable that was thrown during the execution of the span.
@Nullable java.util.Date	getTimestamp()
boolean	isFinished() Returns if span has finished.
void	setThrowable(@Nullable java.lang.Throwable throwable) Sets the throwable that was thrown during the execution of the span.
@NotNull ISpan	startChild(@NotNull java.lang.String operation) Starts a child Span.
@NotNull ISpan	startChild(@NotNull java.lang.String operation, @Nullable java.lang.String description) Starts a child Span.
@NotNull SentryTraceHeader	toSentryTrace() Returns a string that could be sent as a sentry-trace header.

Methods inherited from class io.sentry.SpanContext

clone, getDescription, getOperation, getParentSpanId, getSampled, getSpanId, getStatus, getTags, getTraceId, setDescription, setOperation, setStatus, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sentry.ISpan

getDescription, getOperation, getStatus, setDescription, setOperation, setStatus, setTag

Method Detail

getStartTimestamp

@NotNull
public @NotNull java.util.Date getStartTimestamp()

getTimestamp

@Nullable
public @Nullable java.util.Date getTimestamp()

startChild

@NotNull
public @NotNull ISpan startChild(@NotNull
                                          @NotNull java.lang.String operation)

Description copied from interface: ISpan

Starts a child Span.

Specified by:

startChild in interface ISpan

Parameters:

operation - - new span operation name

Returns:

a new transaction span

startChild

@NotNull
public @NotNull ISpan startChild(@NotNull
                                          @NotNull java.lang.String operation,
                                          @Nullable
                                          @Nullable java.lang.String description)

Description copied from interface: ISpan

Starts a child Span.

Specified by:

startChild in interface ISpan

Parameters:

operation - - new span operation name

description - - new span description name

Returns:

a new transaction span

toSentryTrace

@NotNull
public @NotNull SentryTraceHeader toSentryTrace()

Description copied from interface: ISpan

Returns a string that could be sent as a sentry-trace header.

Specified by:

toSentryTrace in interface ISpan

Returns:

SentryTraceHeader.

finish

public void finish()

Description copied from interface: ISpan

Sets span timestamp marking this span as finished.

Specified by:

finish in interface ISpan

finish

public void finish(@Nullable
                   @Nullable SpanStatus status)

Description copied from interface: ISpan

Sets span timestamp marking this span as finished.

Specified by:

finish in interface ISpan

Parameters:

status - - the status

getSpanContext

@NotNull
public @NotNull SpanContext getSpanContext()

Description copied from interface: ISpan

Gets the span context.

Specified by:

getSpanContext in interface ISpan

Returns:

the span context

isFinished

public boolean isFinished()

Description copied from interface: ISpan

Returns if span has finished.

Specified by:

isFinished in interface ISpan

Returns:

if span has finished.

setThrowable

public void setThrowable(@Nullable
                         @Nullable java.lang.Throwable throwable)

Description copied from interface: ISpan

Sets the throwable that was thrown during the execution of the span.

Specified by:

setThrowable in interface ISpan

Parameters:

throwable - - the throwable.

getThrowable

@Nullable
public @Nullable java.lang.Throwable getThrowable()

Description copied from interface: ISpan

Gets the throwable that was thrown during the execution of the span.

Specified by:

getThrowable in interface ISpan

Returns:

throwable or null if none