com.amazonaws.util

Class TimingInfo

java.lang.Object

com.amazonaws.util.TimingInfo

public class TimingInfo
extends java.lang.Object

Used both as a base class and a minimal support of timing info.

In contrast to TimingInfoFullSupport, which is intended to be a full support of the timing info, this class only provides a minimal support of start and end time (ie with no-ops for sub-event measurements) for backward compatiblity reasons.

This class is instantiated instead of TimingInfoFullSupport when request metric collection is not required during a particular service request/response cycle.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimingInfo(java.lang.Long startEpochTimeMilli, long startTimeNano, java.lang.Long endTimeNano) A private ctor to facilitate the deprecation of using millisecond and migration to using nanosecond for timing measurement.

Method Summary

Modifier and Type	Method and Description
void	addSubMeasurement(java.lang.String subMeasurementName, TimingInfo timingInfo)
static double	durationMilliOf(long startTimeNano, long endTimeNano)
TimingInfo	endTiming()
java.util.Map<java.lang.String,java.lang.Number>	getAllCounters()
java.util.List<TimingInfo>	getAllSubMeasurements(java.lang.String subMeasurementName)
java.lang.Number	getCounter(java.lang.String key)
long	getElapsedTimeMillis() Deprecated.
long	getEndEpochTimeMilli() Deprecated.
java.lang.Long	getEndEpochTimeMilliIfKnown()
long	getEndTime() Deprecated.
long	getEndTimeNano()
java.lang.Long	getEndTimeNanoIfKnown()
TimingInfo	getLastSubMeasurement(java.lang.String subMeasurementName)
long	getStartEpochTimeMilli() Deprecated.
java.lang.Long	getStartEpochTimeMilliIfKnown() Retrieves the start epoch time in milliseconds if known.
long	getStartTime() Deprecated.
long	getStartTimeNano()
TimingInfo	getSubMeasurement(java.lang.String subMeasurementName)
TimingInfo	getSubMeasurement(java.lang.String subMesurementName, int index)
java.util.Map<java.lang.String,java.util.List<TimingInfo>>	getSubMeasurementsByName()
double	getTimeTakenMillis() Deprecated.
java.lang.Double	getTimeTakenMillisIfKnown()
void	incrementCounter(java.lang.String key) =
boolean	isEndTimeKnown()
boolean	isStartEpochTimeMilliKnown()
static TimingInfo	newTimingInfoFullSupport(long startTimeNano, long endTimeNano) Returns a TimingInfoFullSupport based on the given start and end time in nanosecond, ignoring the wall clock time.
static TimingInfo	newTimingInfoFullSupport(long startEpochTimeMilli, long startTimeNano, long endTimeNano) Returns a TimingInfoFullSupport based on the given start time since epoch in millisecond, and the given start and end time in nanosecond.
void	setCounter(java.lang.String key, long count)
void	setEndTime(long endTimeMilli) Deprecated.
void	setEndTimeNano(long endTimeNano)
static TimingInfo	startTiming() Captures the current wall clock time (since epoch in millisecond) and the current time (in nanosecond) used for timing measurement.
static TimingInfo	startTimingFullSupport() Captures the current wall clock time (since epoch in millisecond) and the current time (in nanosecond) used for timing measurement.
static TimingInfo	startTimingFullSupport(long startTimeNano) Captures the given start time in nanosecond, ignoring the wall clock time.
java.lang.String	toString()
static TimingInfo	unmodifiableTimingInfo(long startTimeNano, java.lang.Long endTimeNano)
static TimingInfo	unmodifiableTimingInfo(long startEpochTimeMilli, long startTimeNano, java.lang.Long endTimeNano)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimingInfo

protected TimingInfo(java.lang.Long startEpochTimeMilli,
                     long startTimeNano,
                     java.lang.Long endTimeNano)

A private ctor to facilitate the deprecation of using millisecond and migration to using nanosecond for timing measurement.

Parameters:

startEpochTimeMilli - start time since epoch in millisecond

startTimeNano - start time in nanosecond

endTimeNano - end time in nanosecond; or null if not known

Method Detail

startTiming

public static TimingInfo startTiming()

Captures the current wall clock time (since epoch in millisecond) and the current time (in nanosecond) used for timing measurement. For more info, see: https://blogs.oracle.com/dholmes/entry/inside_the_hotspot_vm_clocks

Returns:

the TimingInfo.

startTimingFullSupport

public static TimingInfo startTimingFullSupport()

Captures the current wall clock time (since epoch in millisecond) and the current time (in nanosecond) used for timing measurement. For more info, see: https://blogs.oracle.com/dholmes/entry/inside_the_hotspot_vm_clocks

Returns:

the TimingInfo.

startTimingFullSupport

public static TimingInfo startTimingFullSupport(long startTimeNano)

Captures the given start time in nanosecond, ignoring the wall clock time.

Parameters:

startTimeNano - start time in nanosecond

Returns:

the TimingInfo.

newTimingInfoFullSupport

public static TimingInfo newTimingInfoFullSupport(long startTimeNano,
                                                  long endTimeNano)

Returns a TimingInfoFullSupport based on the given start and end time in nanosecond, ignoring the wall clock time.

Parameters:

startTimeNano - start time in nanosecond

endTimeNano - end time in nanosecond

Returns:

the TimingInfo.

newTimingInfoFullSupport

public static TimingInfo newTimingInfoFullSupport(long startEpochTimeMilli,
                                                  long startTimeNano,
                                                  long endTimeNano)

Returns a TimingInfoFullSupport based on the given start time since epoch in millisecond, and the given start and end time in nanosecond.

Parameters:

startEpochTimeMilli - start time since epoch in millisecond

startTimeNano - start time in nanosecond

endTimeNano - end time in nanosecond

Returns:

the TimingInfo.

unmodifiableTimingInfo

public static TimingInfo unmodifiableTimingInfo(long startTimeNano,
                                                java.lang.Long endTimeNano)

Parameters:

startTimeNano - start time nano.

endTimeNano - end time nano.

Returns:

an instance of TimingInfo that is not modifiable, given the start and end nano times.

unmodifiableTimingInfo

public static TimingInfo unmodifiableTimingInfo(long startEpochTimeMilli,
                                                long startTimeNano,
                                                java.lang.Long endTimeNano)

Parameters:

startEpochTimeMilli - start time since epoch in millisecond

startTimeNano - start time in nanosecond

endTimeNano - end time in nanosecond; or null if not known

Returns:

an instance of TimingInfo that is not modifiable.

getStartTime

@Deprecated
public final long getStartTime()

Deprecated.

getStartEpochTimeMilli

@Deprecated
public final long getStartEpochTimeMilli()

Deprecated.

=

Returns:

the star epoch time in milliseconds.

getStartEpochTimeMilliIfKnown

public final java.lang.Long getStartEpochTimeMilliIfKnown()

Retrieves the start epoch time in milliseconds if known.

Returns:

start epch time in milliseconds.

getStartTimeNano

public final long getStartTimeNano()

Returns:

the start time nano.

getEndTime

@Deprecated
public final long getEndTime()

Deprecated.

Returns:

the end time.

getEndEpochTimeMilli

@Deprecated
public final long getEndEpochTimeMilli()

Deprecated.

Returns:

the end epoch time in milliseconds.

getEndEpochTimeMilliIfKnown

public final java.lang.Long getEndEpochTimeMilliIfKnown()

Returns:

the end epoch time in milliseconds.

getEndTimeNano

public final long getEndTimeNano()

Returns:

the end time nano.

getEndTimeNanoIfKnown

public final java.lang.Long getEndTimeNanoIfKnown()

Returns:

the end time nano if known.

getTimeTakenMillis

@Deprecated
public final double getTimeTakenMillis()

Deprecated.

Returns:

time duration in milliseconds.

getTimeTakenMillisIfKnown

public final java.lang.Double getTimeTakenMillisIfKnown()

Returns:

the time duration in nano if known.

durationMilliOf

public static double durationMilliOf(long startTimeNano,
                                     long endTimeNano)

Parameters:

startTimeNano - start time nano.

endTimeNano - end time nano.

Returns:

the duration in milliseconds as double, preserving the decimal precision as necessary, for the given start and end time in nanoseconds.

getElapsedTimeMillis

@Deprecated
public final long getElapsedTimeMillis()

Deprecated.

Returns:

the elapsed time in milliseconds.

isEndTimeKnown

public final boolean isEndTimeKnown()

Returns:

true if end time nano is known.

isStartEpochTimeMilliKnown

public final boolean isStartEpochTimeMilliKnown()

Returns:

if start epoch time in milliseconds is known.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEndTime

@Deprecated
public void setEndTime(long endTimeMilli)

Deprecated.

setEndTimeNano

public void setEndTimeNano(long endTimeNano)

Parameters:

endTimeNano - the end time nano.

endTiming

public TimingInfo endTiming()

Returns:

the TimingInfo.

addSubMeasurement

public void addSubMeasurement(java.lang.String subMeasurementName,
                              TimingInfo timingInfo)

Parameters:

subMeasurementName - the sub measurement name.

timingInfo - the timing info.

getSubMeasurement

public TimingInfo getSubMeasurement(java.lang.String subMeasurementName)

Parameters:

subMeasurementName - the sub measurement name.

Returns:

the TimingInfo.

getSubMeasurement

public TimingInfo getSubMeasurement(java.lang.String subMesurementName,
                                    int index)

Parameters:

subMesurementName - the sub measurement name.

index - the index.

Returns:

the TimingInfo.

getLastSubMeasurement

public TimingInfo getLastSubMeasurement(java.lang.String subMeasurementName)

Parameters:

subMeasurementName - the sub measurement name.

Returns:

the TimingInfo.

getAllSubMeasurements

public java.util.List<TimingInfo> getAllSubMeasurements(java.lang.String subMeasurementName)

Parameters:

subMeasurementName - the sub measurement name.

Returns:

the TimingInfo list.

getSubMeasurementsByName

public java.util.Map<java.lang.String,java.util.List<TimingInfo>> getSubMeasurementsByName()

Returns:

map of string to list of the TimingInfo.

getCounter

public java.lang.Number getCounter(java.lang.String key)

Parameters:

key - the key.

Returns:

the counter.

getAllCounters

public java.util.Map<java.lang.String,java.lang.Number> getAllCounters()

Returns:

Map of all of the counters.

setCounter

public void setCounter(java.lang.String key,
                       long count)

Parameters:

key - the key.

count - the count.

incrementCounter

public void incrementCounter(java.lang.String key)

=

Parameters:

key - the key.