com.atlassian.instrumentation.operations

Class OpSnapshot

java.lang.Object

com.atlassian.instrumentation.operations.OpSnapshot

All Implemented Interfaces:

Instrument, OpInstrument, Comparable<Instrument>

public final class OpSnapshot
extends Object
implements OpInstrument

This is an snapshot instance of a named operation's timing, invocation count and its result set size.

Its IMMUTABLE and hence THREAD safe.

Since:

v4.0

Constructor Summary

Constructors

Constructor and Description
OpSnapshot(String name, long invocationCount, long elapsedTotal, long elapsedMin, long elapsedMax, long resultSetSize, long cpuTotal, long cpuMin, long cpuMax) Constructs a OpSnapshot with the specified values.

Method Summary

Modifier and Type	Method and Description
OpSnapshot	add(OpSnapshot otherOpSnapshot) Adds the values in the otherOpSnapshot to the current one and returns a new object repsentation of itself.
int	compareTo(Instrument that) By default it sorts in name / highest time taken / highest invocation count / highest result set size order
static OpSnapshot	createSingle(String name, long elapsedTime, long resultSetSize, long cpuTime)
boolean	equals(Object o)
long	getCpuMaxTime(TimeUnit unit)
long	getCpuMinTime(TimeUnit unit)
long	getCpuTime()
long	getCpuTotalTime(TimeUnit unit)
long	getElapsedMaxTime(TimeUnit unit)
long	getElapsedMinTime(TimeUnit unit)
long	getElapsedTotalTime(TimeUnit unit)
long	getInvocationCount()
long	getMillisecondsTaken()
String	getName()
long	getResultSetSize()
long	getValue() This is a synonym for getElapsedTotalTime(java.util.concurrent.TimeUnit) with milliseconds
int	hashCode()
OpSnapshot	substract(OpSnapshot previousSnapshot) This can be used to find out the difference between this snapshot and a previous one
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpSnapshot

public OpSnapshot(String name,
                  long invocationCount,
                  long elapsedTotal,
                  long elapsedMin,
                  long elapsedMax,
                  long resultSetSize,
                  long cpuTotal,
                  long cpuMin,
                  long cpuMax)

Constructs a OpSnapshot with the specified values. Times are expressed in nanoseconds. The name must not be null.

Method Detail

createSingle

public static OpSnapshot createSingle(String name,
                                      long elapsedTime,
                                      long resultSetSize,
                                      long cpuTime)

getName

public String getName()

Specified by:

getName in interface Instrument

Returns:

the name of the Instrument.

getInvocationCount

public long getInvocationCount()

Specified by:

getInvocationCount in interface OpInstrument

Returns:

the number of times it was invoked

getMillisecondsTaken

public long getMillisecondsTaken()

Specified by:

getMillisecondsTaken in interface OpInstrument

Returns:

the total elapsed time taken by all invocations

getElapsedTotalTime

public long getElapsedTotalTime(TimeUnit unit)

Specified by:

getElapsedTotalTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the total elapsed time taken by all invocations

getElapsedMinTime

public long getElapsedMinTime(TimeUnit unit)

Specified by:

getElapsedMinTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the minimum elapsed time a single invocation took

getElapsedMaxTime

public long getElapsedMaxTime(TimeUnit unit)

Specified by:

getElapsedMaxTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the maximum elapsed time a single invocation took

getResultSetSize

public long getResultSetSize()

Specified by:

getResultSetSize in interface OpInstrument

Returns:

the total result set sizes for all invocations

getCpuTime

public long getCpuTime()

Specified by:

getCpuTime in interface OpInstrument

Returns:

the total CPU time (in nanoseconds) taken by all invocations

getCpuTotalTime

public long getCpuTotalTime(TimeUnit unit)

Specified by:

getCpuTotalTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the total CPU time taken by all invocations

getCpuMinTime

public long getCpuMinTime(TimeUnit unit)

Specified by:

getCpuMinTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the minimum CPU time a single invocation took

getCpuMaxTime

public long getCpuMaxTime(TimeUnit unit)

Specified by:

getCpuMaxTime in interface OpInstrument

Parameters:

unit - the unit to express the time with

Returns:

the maximum CPU time a single invocation took

getValue

public long getValue()

This is a synonym for getElapsedTotalTime(java.util.concurrent.TimeUnit) with milliseconds

Specified by:

getValue in interface Instrument

Returns:

returns the value of the monitored reading at the time the call was made

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Instrument that)

By default it sorts in name / highest time taken / highest invocation count / highest result set size order

Specified by:

compareTo in interface Comparable<Instrument>

Parameters:

that - the object tom compare

Returns:

-1, 0 or 1 as per Comparable

substract

public OpSnapshot substract(OpSnapshot previousSnapshot)

This can be used to find out the difference between this snapshot and a previous one

Parameters:

previousSnapshot - a previous snapshot

Returns:

the difference expressed as a new OpSnapshot

add

public OpSnapshot add(OpSnapshot otherOpSnapshot)

Adds the values in the otherOpSnapshot to the current one and returns a new object repsentation of itself. The name of the returned object will be the name of this OpSnapshot.

Parameters:

otherOpSnapshot - the one to add to this snapshot

Returns:

a new OpSnapshot object with the added values