Package io.sentry

Class TransactionContext

java.lang.Object

io.sentry.SpanContext

io.sentry.TransactionContext

All Implemented Interfaces:

JsonSerializable, JsonUnknown

public final class TransactionContext
extends SpanContext

Nested Class Summary

Nested classes/interfaces inherited from class io.sentry.SpanContext

SpanContext.Deserializer, SpanContext.JsonKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull String	DEFAULT_TRANSACTION_NAME

Fields inherited from class io.sentry.SpanContext

baggage, DEFAULT_ORIGIN, description, op, origin, status, tags, TYPE

Constructor Summary

Constructors

Constructor	Description
TransactionContext(@NotNull SentryId traceId, @NotNull SpanId spanId, @Nullable SpanId parentSpanId, @Nullable TracesSamplingDecision parentSamplingDecision, @Nullable Baggage baggage)
TransactionContext(@NotNull String name, @NotNull TransactionNameSource transactionNameSource, @NotNull String operation)
TransactionContext(@NotNull String name, @NotNull TransactionNameSource transactionNameSource, @NotNull String operation, @Nullable TracesSamplingDecision samplingDecision)	Creates TransactionContext with explicit sampling decision and name source.
TransactionContext(@NotNull String name, @NotNull String operation)
TransactionContext(@NotNull String name, @NotNull String operation, @Nullable TracesSamplingDecision samplingDecision)	Creates TransactionContext with explicit sampling decision.

Method Summary

Modifier and Type	Method	Description
static TransactionContext	fromPropagationContext(@NotNull PropagationContext propagationContext)
static @NotNull TransactionContext	fromSentryTrace(@NotNull String name, @NotNull String operation, @NotNull SentryTraceHeader sentryTrace)	Deprecated. use Sentry.continueTrace(String, List) and setters for name and operation here instead.
@NotNull String	getName()
@Nullable Boolean	getParentSampled()
@Nullable TracesSamplingDecision	getParentSamplingDecision()
@NotNull TransactionNameSource	getTransactionNameSource()
boolean	isForNextAppStart()	Whether this TransactionContext evaluates for the next app start.
void	setForNextAppStart(boolean forNextAppStart)
void	setName(@NotNull String name)
void	setParentSampled(@Nullable Boolean parentSampled)
void	setParentSampled(@Nullable Boolean parentSampled, @Nullable Boolean parentProfileSampled)
void	setTransactionNameSource(@NotNull TransactionNameSource transactionNameSource)

Methods inherited from class io.sentry.SpanContext

copyForChild, equals, getBaggage, getDescription, getInstrumenter, getOperation, getOrigin, getParentSpanId, getProfileSampled, getSampled, getSamplingDecision, getSpanId, getStatus, getTags, getTraceId, getUnknown, hashCode, serialize, setDescription, setInstrumenter, setOperation, setOrigin, setSampled, setSampled, setSamplingDecision, setStatus, setTag, setUnknown

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TRANSACTION_NAME

@NotNull
public static final @NotNull String DEFAULT_TRANSACTION_NAME

See Also:

• Constant Field Values

Constructor Details

TransactionContext

public TransactionContext(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String operation)

TransactionContext

@Internal
public TransactionContext(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull TransactionNameSource transactionNameSource,
 @NotNull
 @NotNull String operation)

TransactionContext

public TransactionContext(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String operation,
 @Nullable
 @Nullable TracesSamplingDecision samplingDecision)

Creates TransactionContext with explicit sampling decision.

Parameters:

name - - transaction name

operation - - operation

samplingDecision - - sampling decision

TransactionContext

@Internal
public TransactionContext(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull TransactionNameSource transactionNameSource,
 @NotNull
 @NotNull String operation,
 @Nullable
 @Nullable TracesSamplingDecision samplingDecision)

Creates TransactionContext with explicit sampling decision and name source.

Parameters:

name - - transaction name

operation - - operation

samplingDecision - - sampling decision

TransactionContext

@Internal
public TransactionContext(@NotNull
 @NotNull SentryId traceId,
 @NotNull
 @NotNull SpanId spanId,
 @Nullable
 @Nullable SpanId parentSpanId,
 @Nullable
 @Nullable TracesSamplingDecision parentSamplingDecision,
 @Nullable
 @Nullable Baggage baggage)

Method Details

fromSentryTrace

@Deprecated
@NotNull
public static @NotNull TransactionContext fromSentryTrace(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String operation,
 @NotNull
 @NotNull SentryTraceHeader sentryTrace)

Deprecated.

use Sentry.continueTrace(String, List) and setters for name and operation here instead.

Creates TransactionContext from sentry-trace header.

Parameters:

name - - the transaction name

operation - - the operation

sentryTrace - - the sentry-trace header

Returns:

the transaction contexts

fromPropagationContext

@Internal
public static TransactionContext fromPropagationContext(@NotNull
 @NotNull PropagationContext propagationContext)

getName

@NotNull
public @NotNull String getName()

getParentSampled

@Nullable
public @Nullable Boolean getParentSampled()

getParentSamplingDecision

@Nullable
public @Nullable TracesSamplingDecision getParentSamplingDecision()

setParentSampled

public void setParentSampled(@Nullable
 @Nullable Boolean parentSampled)

setParentSampled

public void setParentSampled(@Nullable
 @Nullable Boolean parentSampled,
 @Nullable
 @Nullable Boolean parentProfileSampled)

getTransactionNameSource

@NotNull
public @NotNull TransactionNameSource getTransactionNameSource()

setName

public void setName(@NotNull
 @NotNull String name)

setTransactionNameSource

public void setTransactionNameSource(@NotNull
 @NotNull TransactionNameSource transactionNameSource)

setForNextAppStart

@Internal
public void setForNextAppStart(boolean forNextAppStart)

isForNextAppStart

public boolean isForNextAppStart()

Whether this TransactionContext evaluates for the next app start. If this is true, it gets called only once when the SDK initializes. This is set only if SentryOptions.isEnableAppStartProfiling() is true.

Returns:

True if this TransactionContext will be used for the next app start.