com.amazonaws.xray.entities

Class DummySubsegment

java.lang.Object

com.amazonaws.xray.entities.DummySubsegment

All Implemented Interfaces:

Entity, Subsegment, AutoCloseable

public class DummySubsegment
extends Object
implements Subsegment

Constructor Summary

Constructors

Constructor and Description
DummySubsegment(AWSXRayRecorder creator)
DummySubsegment(AWSXRayRecorder creator, TraceID traceId)

Method Summary

Modifier and Type	Method and Description
void	addException(Throwable exception) Adds an exception to the entity's cause and sets fault to true.
void	addPrecursorId(String precursorId)
void	addSubsegment(Subsegment subsegment) Adds a subsegment.
void	close()
boolean	decrementReferenceCount() Decrements the subsegment-reference counter.
boolean	end() Ends the subsegment.
Map<String,Object>	getAnnotations()
Map<String,Object>	getAws()
Cause	getCause()
AWSXRayRecorder	getCreator()
double	getEndTime()
Map<String,Object>	getHttp()
String	getId()
Map<String,Map<String,Object>>	getMetadata()
String	getName()
String	getNamespace()
Entity	getParent()
String	getParentId()
Segment	getParentSegment()
Set<String>	getPrecursorIds()
int	getReferenceCount() Returns the reference count of the segment.
Map<String,Object>	getSql()
double	getStartTime()
List<Subsegment>	getSubsegments()
ReentrantLock	getSubsegmentsLock()
LongAdder	getTotalSize()
TraceID	getTraceId()
void	incrementReferenceCount() Increments the subsegment-reference counter.
boolean	isEmitted()
boolean	isError()
boolean	isFault()
boolean	isInProgress()
boolean	isThrottle()
String	prettySerialize()
String	prettyStreamSerialize() Pretty-serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
void	putAllAws(Map<String,Object> all) Puts AWS information.
void	putAllHttp(Map<String,Object> all) Puts HTTP information.
void	putAllSql(Map<String,Object> all) Puts SQL information.
void	putAnnotation(String key, Boolean value) Puts a Boolean annotation.
void	putAnnotation(String key, Number value) Puts a Number annotation.
void	putAnnotation(String key, String value) Puts a String annotation.
void	putAws(String key, Object value) Puts AWS information.
void	putHttp(String key, Object value) Puts HTTP information.
void	putMetadata(String key, Object object) Puts metadata under the namespace 'default'.
void	putMetadata(String namespace, String key, Object object) Puts metadata.
void	putSql(String key, Object value) Puts SQL information.
void	removeSubsegment(Subsegment subsegment) Removes a subsegment from the subsegment list.
String	serialize()
void	setAnnotations(Map<String,Object> annotations)
void	setAws(Map<String,Object> aws)
void	setCreator(AWSXRayRecorder creator)
void	setEmitted(boolean emitted)
void	setEndTime(double endTime)
void	setError(boolean error) Sets the error value of the entity.
void	setFault(boolean fault)
void	setHttp(Map<String,Object> http)
void	setId(String id)
void	setInProgress(boolean inProgress)
void	setMetadata(Map<String,Map<String,Object>> metadata)
void	setNamespace(String namespace)
void	setParent(Entity parent)
void	setParentId(String parentId)
void	setParentSegment(Segment parentSegment)
void	setPrecursorIds(Set<String> precursorIds)
void	setSql(Map<String,Object> sql)
void	setStartTime(double startTime)
void	setSubsegmentsLock(ReentrantLock subsegmentsLock)
void	setThrottle(boolean throttle) Sets the throttle value.
void	setTraceId(TraceID traceId)
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 java.lang.Object

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

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

generateId

Constructor Detail

DummySubsegment

public DummySubsegment(AWSXRayRecorder creator)

DummySubsegment

public DummySubsegment(AWSXRayRecorder creator,
                       TraceID traceId)

Method Detail

getName

public String getName()

Specified by:

getName in interface Entity

getId

public String getId()

Specified by:

getId in interface Entity

Returns:

the id

setId

public void setId(String id)

Specified by:

setId in interface Entity

Parameters:

id - the id to set

getStartTime

public double getStartTime()

Specified by:

getStartTime in interface Entity

Returns:

the startTime

setStartTime

public void setStartTime(double startTime)

Specified by:

setStartTime in interface Entity

Parameters:

startTime - the startTime to set

getEndTime

public double getEndTime()

Specified by:

getEndTime in interface Entity

Returns:

the endTime

setEndTime

public void setEndTime(double endTime)

Specified by:

setEndTime in interface Entity

Parameters:

endTime - the endTime to set

isFault

public boolean isFault()

Specified by:

isFault in interface Entity

Returns:

the fault

setFault

public void setFault(boolean fault)

Specified by:

setFault in interface Entity

Parameters:

fault - the fault to set

isError

public boolean isError()

Specified by:

isError in interface Entity

Returns:

the error

setError

public void setError(boolean error)

Description copied from interface: Entity

Sets the error value of the entity.

Specified by:

setError in interface Entity

Parameters:

error - the error to set

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Entity

Specified by:

getNamespace in interface Subsegment

Returns:

the namespace

setNamespace

public void setNamespace(String namespace)

Specified by:

setNamespace in interface Entity

Specified by:

setNamespace in interface Subsegment

Parameters:

namespace - the namespace to set

getCause

public Cause getCause()

Specified by:

getCause in interface Entity

Returns:

the cause

getHttp

public Map<String,Object> getHttp()

Specified by:

getHttp in interface Entity

Returns:

the http

setHttp

public void setHttp(Map<String,Object> http)

Specified by:

setHttp in interface Entity

Parameters:

http - the http to set

getAws

public Map<String,Object> getAws()

Specified by:

getAws in interface Entity

Returns:

the aws

setAws

public void setAws(Map<String,Object> aws)

Specified by:

setAws in interface Entity

Parameters:

aws - the aws to set

getSql

public Map<String,Object> getSql()

Specified by:

getSql in interface Entity

Returns:

the sql

setSql

public void setSql(Map<String,Object> sql)

Specified by:

setSql in interface Entity

Parameters:

sql - the sql to set

getMetadata

public Map<String,Map<String,Object>> getMetadata()

Specified by:

getMetadata in interface Entity

Returns:

the metadata

setMetadata

public void setMetadata(Map<String,Map<String,Object>> metadata)

Specified by:

setMetadata in interface Entity

Parameters:

metadata - the metadata to set

setAnnotations

public void setAnnotations(Map<String,Object> annotations)

Specified by:

setAnnotations in interface Entity

Parameters:

annotations - the annotations to set

getParent

public Entity getParent()

Specified by:

getParent in interface Entity

Returns:

the parent

setParent

public void setParent(Entity parent)

Specified by:

setParent in interface Entity

Parameters:

parent - the parent to set

isThrottle

public boolean isThrottle()

Specified by:

isThrottle in interface Entity

Returns:

the throttle

setThrottle

public void setThrottle(boolean throttle)

Description copied from interface: Entity

Sets the throttle value. When setting to true, error is also set to true and fault set to false.

Specified by:

setThrottle in interface Entity

Parameters:

throttle - the throttle to set

isInProgress

public boolean isInProgress()

Specified by:

isInProgress in interface Entity

Returns:

the inProgress

setInProgress

public void setInProgress(boolean inProgress)

Specified by:

setInProgress in interface Entity

Parameters:

inProgress - the inProgress to set

getTraceId

public TraceID getTraceId()

Specified by:

getTraceId in interface Entity

Returns:

the traceId

setTraceId

public void setTraceId(TraceID traceId)

Specified by:

setTraceId in interface Entity

Parameters:

traceId - the traceId to set

getCreator

public AWSXRayRecorder getCreator()

Specified by:

getCreator in interface Entity

Returns:

the creator

setCreator

public void setCreator(AWSXRayRecorder creator)

Specified by:

setCreator in interface Entity

Parameters:

creator - the creator to set

getParentId

public String getParentId()

Specified by:

getParentId in interface Entity

Returns:

the parentId

setParentId

public void setParentId(String parentId)

Specified by:

setParentId in interface Entity

Parameters:

parentId - the parentId to set

getSubsegments

public List<Subsegment> getSubsegments()

Specified by:

getSubsegments in interface Entity

Returns:

the subsegments

addSubsegment

public void addSubsegment(Subsegment subsegment)

Description copied from interface: Entity

Adds a subsegment.

Specified by:

addSubsegment in interface Entity

Parameters:

subsegment - the subsegment to add

addException

public void addException(Throwable exception)

Description copied from interface: Entity

Adds an exception to the entity's cause and sets fault to true.

Specified by:

addException in interface Entity

Parameters:

exception - the exception to add

putHttp

public void putHttp(String key,
                    Object value)

Description copied from interface: Entity

Puts HTTP information.

Specified by:

putHttp in interface Entity

Parameters:

key - the key under which the HTTP information is stored

value - the HTTP information

putAllHttp

public void putAllHttp(Map<String,Object> all)

Description copied from interface: Entity

Puts HTTP information.

Specified by:

putAllHttp in interface Entity

Parameters:

all - the HTTP information to put

putAws

public void putAws(String key,
                   Object value)

Description copied from interface: Entity

Puts AWS information.

Specified by:

putAws in interface Entity

Parameters:

key - the key under which the AWS information is stored

value - the AWS information

putAllAws

public void putAllAws(Map<String,Object> all)

Description copied from interface: Entity

Puts AWS information.

Specified by:

putAllAws in interface Entity

Parameters:

all - the AWS information to put

putSql

public void putSql(String key,
                   Object value)

Description copied from interface: Entity

Puts SQL information.

Specified by:

putSql in interface Entity

Parameters:

key - the key under which the SQL information is stored

value - the SQL information

putAllSql

public void putAllSql(Map<String,Object> all)

Description copied from interface: Entity

Puts SQL information.

Specified by:

putAllSql in interface Entity

Parameters:

all - the SQL information to put

putAnnotation

public void putAnnotation(String key,
                          String value)

Description copied from interface: Entity

Puts a String annotation.

Specified by:

putAnnotation in interface Entity

Parameters:

key - the key under which the annotation is stored

value - the String annotation

putAnnotation

public void putAnnotation(String key,
                          Number value)

Description copied from interface: Entity

Puts a Number annotation.

Specified by:

putAnnotation in interface Entity

Parameters:

key - the key under which the annotation is stored

value - the Number annotation

putAnnotation

public void putAnnotation(String key,
                          Boolean value)

Description copied from interface: Entity

Puts a Boolean annotation.

Specified by:

putAnnotation in interface Entity

Parameters:

key - the key under which the annotation is stored

value - the Boolean annotation

putMetadata

public void putMetadata(String key,
                        Object object)

Description copied from interface: Entity

Puts metadata under the namespace 'default'.

Specified by:

putMetadata in interface Entity

Parameters:

key - the key under which the metadata is stored

object - the metadata

putMetadata

public void putMetadata(String namespace,
                        String key,
                        Object object)

Description copied from interface: Entity

Puts metadata.

Specified by:

putMetadata in interface Entity

Parameters:

namespace - the namespace under which the metadata is stored

key - the key under which the metadata is stored

object - the metadata

isEmitted

public boolean isEmitted()

Specified by:

isEmitted in interface Entity

setEmitted

public void setEmitted(boolean emitted)

Specified by:

setEmitted in interface Entity

serialize

public String serialize()

Specified by:

serialize in interface Entity

prettySerialize

public String prettySerialize()

Specified by:

prettySerialize in interface Entity

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

getAnnotations

public Map<String,Object> getAnnotations()

Specified by:

getAnnotations in interface Entity

Returns:

the annotations

getParentSegment

public Segment getParentSegment()

Specified by:

getParentSegment in interface Entity

Specified by:

getParentSegment in interface Subsegment

Returns:

the parentSegment

close

public void close()

Specified by:

close in interface Subsegment

Specified by:

close in interface AutoCloseable

setParentSegment

public void setParentSegment(Segment parentSegment)

Specified by:

setParentSegment in interface Subsegment

Parameters:

parentSegment - the parentSegment to 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

addPrecursorId

public void addPrecursorId(String precursorId)

Specified by:

addPrecursorId in interface Subsegment

Parameters:

precursorId - the precursor ID to add to the set

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 enouogh 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 enouogh information for it to be streamed

getSubsegmentsLock

public ReentrantLock getSubsegmentsLock()

Specified by:

getSubsegmentsLock in interface Entity

Returns:

the subsegmentsLock

setSubsegmentsLock

public void setSubsegmentsLock(ReentrantLock subsegmentsLock)

Specified by:

setSubsegmentsLock in interface Entity

Parameters:

subsegmentsLock - the subsegmentsLock to set

getReferenceCount

public int getReferenceCount()

Description copied from interface: Entity

Returns the reference count of the segment. This number represents how many open subsegments are children of this segment. The segment is emitted when its reference count reaches 0.

Specified by:

getReferenceCount in interface Entity

Returns:

the reference count

getTotalSize

public LongAdder getTotalSize()

Specified by:

getTotalSize in interface Entity

Returns:

the totalSize

incrementReferenceCount

public void incrementReferenceCount()

Description copied from interface: Entity

Increments the subsegment-reference counter.

Specified by:

incrementReferenceCount in interface Entity

decrementReferenceCount

public boolean decrementReferenceCount()

Description copied from interface: Entity

Decrements the subsegment-reference counter.

Specified by:

decrementReferenceCount in interface Entity

Returns:

true if the segment is no longer in progress and the reference count is less than or equal to zero.

removeSubsegment

public void removeSubsegment(Subsegment subsegment)

Description copied from interface: Entity

Removes a subsegment from the subsegment list. Decrements the total size of the parentSegment. Marks the removed subsegment as emitted future modification on this subsegment may raise an AlreadyEmittedException.

Specified by:

removeSubsegment in interface Entity

Parameters:

subsegment - the subsegment to remove