com.atlassian.instrumentation.operations

Class ExternalOpInstrument

java.lang.Object

com.atlassian.instrumentation.operations.ExternalOpInstrument

All Implemented Interfaces:

Instrument, OpInstrument, Comparable<Instrument>

public class ExternalOpInstrument
extends Object
implements OpInstrument

This class represents an OpInstrument that is calculated externally on demand from values that are "external" to this class.

The passed in ExternalOpValue is used to calculate the external OpSnapshot value.

Constructor Summary

Constructors

Constructor and Description
ExternalOpInstrument(String name, ExternalOpValue externalOpValue)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Instrument that)
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()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalOpInstrument

public ExternalOpInstrument(String name,
                            ExternalOpValue externalOpValue)

Method Detail

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

getName

public String getName()

Specified by:

getName in interface Instrument

Returns:

the name of the Instrument.

getValue

public long getValue()

Specified by:

getValue in interface Instrument

Returns:

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

compareTo

public int compareTo(Instrument that)

Specified by:

compareTo in interface Comparable<Instrument>

toString

public String toString()

Overrides:

toString in class Object