Package com.amazonaws.xray.entities

Class SubsegmentImpl

java.lang.Object

com.amazonaws.xray.entities.EntityImpl

com.amazonaws.xray.entities.SubsegmentImpl

All Implemented Interfaces:

Entity, Subsegment, AutoCloseable

public class SubsegmentImpl
extends EntityImpl
implements Subsegment

Field Summary

Fields inherited from class com.amazonaws.xray.entities.EntityImpl

mapper, referenceCount, totalSize

Constructor Summary

Constructors

Constructor	Description
SubsegmentImpl(AWSXRayRecorder creator, String name, Segment parentSegment)
SubsegmentImpl(AWSXRayRecorder creator, String name, Segment parentSegment, SamplingStrategyOverride samplingStrategyOverride)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addPrecursorId(String precursorId)
void	close()	Implements the AutoCloseable interface.
boolean	end()	Ends the subsegment.
@Nullable String	getNamespace()
Segment	getParentSegment()
Set<String>	getPrecursorIds()
SamplingStrategyOverride	getSamplingStrategyOverride()	Deprecated.
TraceID	getTraceId()
boolean	isRecording()
boolean	isSampled()
String	prettyStreamSerialize()	Pretty-serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
void	setNamespace(String namespace)
void	setParentSegment(Segment parentSegment)
void	setPrecursorIds(Set<String> precursorIds)
void	setSampledFalse()
boolean	shouldPropagate()	Determines if this subsegment should propagate its trace context downstream
String	streamSerialize()	Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.

Methods inherited from class com.amazonaws.xray.entities.EntityImpl

addException, addSubsegment, checkAlreadyEmitted, compareAndSetEmitted, decrementReferenceCount, getAnnotations, getAws, getCause, getCreator, getEndTime, getHttp, getId, getMetadata, getName, getParent, getParentId, getReferenceCount, getSql, getStartTime, getSubsegments, getSubsegmentsCopy, getSubsegmentsLock, getTotalSize, incrementReferenceCount, isEmitted, isError, isFault, isInProgress, isThrottle, prettySerialize, putAllAws, putAllHttp, putAllSql, putAnnotation, putAnnotation, putAnnotation, putAws, putHttp, putMetadata, putMetadata, putSql, removeSubsegment, serialize, setAnnotations, setAws, setCreator, setEmitted, setEndTime, setError, setFault, setHttp, setId, setInProgress, setMetadata, setParent, setParentId, setSql, setStartTime, setSubsegmentsLock, setThrottle, setTraceId, validateNotNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.xray.entities.Entity

addException, addSubsegment, compareAndSetEmitted, decrementReferenceCount, getAnnotations, getAws, getCause, getCreator, getEndTime, getHttp, getId, getMetadata, getName, getParent, getParentId, getReferenceCount, getSql, getStartTime, getSubsegments, getSubsegmentsCopy, getSubsegmentsLock, getTotalSize, incrementReferenceCount, isEmitted, isError, isFault, isInProgress, isThrottle, prettySerialize, putAllAws, putAllHttp, putAllSql, putAnnotation, putAnnotation, putAnnotation, putAws, putHttp, putMetadata, putMetadata, putSql, removeSubsegment, run, run, serialize, setAnnotations, setAws, setCreator, setEmitted, setEndTime, setError, setFault, setHttp, setId, setInProgress, setMetadata, setParent, setParentId, setSql, setStartTime, setSubsegmentsLock, setThrottle, setTraceId

Constructor Details

SubsegmentImpl

public SubsegmentImpl(AWSXRayRecorder creator,
 String name,
 Segment parentSegment)

SubsegmentImpl

@Deprecated
public SubsegmentImpl(AWSXRayRecorder creator,
 String name,
 Segment parentSegment,
 SamplingStrategyOverride samplingStrategyOverride)

Deprecated.

Method Details

end

public boolean end()

Description copied from interface: Subsegment

Ends the subsegment. Sets the end time to the current time. Sets inProgress to false. Decrements its parent segment's segment-reference counter.

Specified by:

end in interface Subsegment

Returns:

true if 1) the parent segment now has a ref. count of zero and 2) the parent segment is sampled

getTraceId

public TraceID getTraceId()

Specified by:

getTraceId in interface Entity

Overrides:

getTraceId in class EntityImpl

Returns:

the traceId

getNamespace

public @Nullable String getNamespace()

Specified by:

getNamespace in interface Entity

Specified by:

getNamespace in interface Subsegment

Overrides:

getNamespace in class EntityImpl

Returns:

the namespace

setNamespace

public void setNamespace(String namespace)

Specified by:

setNamespace in interface Entity

Specified by:

setNamespace in interface Subsegment

Overrides:

setNamespace in class EntityImpl

Parameters:

namespace - the namespace to set

getParentSegment

public Segment getParentSegment()

Specified by:

getParentSegment in interface Entity

Specified by:

getParentSegment in interface Subsegment

Specified by:

getParentSegment in class EntityImpl

Returns:

the parentSegment

setParentSegment

public void setParentSegment(Segment parentSegment)

Specified by:

setParentSegment in interface Subsegment

Parameters:

parentSegment - the parentSegment to set

addPrecursorId

public void addPrecursorId(String precursorId)

Specified by:

addPrecursorId in interface Subsegment

Parameters:

precursorId - the precursor ID to add to the set

getPrecursorIds

public Set<String> getPrecursorIds()

Specified by:

getPrecursorIds in interface Subsegment

Returns:

the precursorIds

setPrecursorIds

public void setPrecursorIds(Set<String> precursorIds)

Specified by:

setPrecursorIds in interface Subsegment

Parameters:

precursorIds - the precursorIds to set

shouldPropagate

public boolean shouldPropagate()

Description copied from interface: Subsegment

Determines if this subsegment should propagate its trace context downstream

Specified by:

shouldPropagate in interface Subsegment

Returns:

true if its trace context should be propagated downstream, false otherwise

streamSerialize

public String streamSerialize()

Description copied from interface: Subsegment

Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.

Specified by:

streamSerialize in interface Subsegment

Returns:

the string representation of the subsegment with enough information for it to be streamed

prettyStreamSerialize

public String prettyStreamSerialize()

Description copied from interface: Subsegment

Pretty-serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own. Only used for debugging.

Specified by:

prettyStreamSerialize in interface Subsegment

Returns:

the pretty string representation of the subsegment with enough information for it to be streamed

close

public void close()

Description copied from interface: Subsegment

Implements the AutoCloseable interface. Warning. This method is intended to be private to the xray library and should not be used externally. Instead, use AWSXRay.endSubsegment(Subsegment).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Subsegment

isSampled

public boolean isSampled()

Specified by:

isSampled in interface Entity

isRecording

public boolean isRecording()

Specified by:

isRecording in interface Subsegment

setSampledFalse

public void setSampledFalse()

Specified by:

setSampledFalse in interface Subsegment

getSamplingStrategyOverride

@Deprecated
public SamplingStrategyOverride getSamplingStrategyOverride()

Deprecated.

Specified by:

getSamplingStrategyOverride in interface Subsegment