com.atlassian.instrumentation.operations

Interface OpInstrument

All Superinterfaces:

Comparable<Instrument>, Instrument

All Known Implementing Classes:

ExternalOpInstrument, OpCounter, OpSnapshot

public interface OpInstrument
extends Instrument

An OpInstrument is a type of @{link Instrument} that exposes 8 values.

It is up to the implementation to decide what is exposed via Instrument.getValue() but it is expected to be a synonym of one of these methods

Since:

v4.0

Method Summary

Modifier and Type	Method and Description
long	getCpuMaxTime(TimeUnit unit)
long	getCpuMinTime(TimeUnit unit)
long	getCpuTime() Deprecated. since 1.9.0, use getCpuTotalTime(java.util.concurrent.TimeUnit) using nanoseconds
long	getCpuTotalTime(TimeUnit unit)
long	getElapsedMaxTime(TimeUnit unit)
long	getElapsedMinTime(TimeUnit unit)
long	getElapsedTotalTime(TimeUnit unit)
long	getInvocationCount()
long	getMillisecondsTaken() Deprecated. since 1.9.0, use getElapsedTotalTime(java.util.concurrent.TimeUnit) using milliseconds
long	getResultSetSize()

Methods inherited from interface com.atlassian.instrumentation.Instrument

getName, getValue

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getInvocationCount

long getInvocationCount()

Returns:

the number of times it was invoked

getMillisecondsTaken

@Deprecated
long getMillisecondsTaken()

Deprecated. since 1.9.0, use getElapsedTotalTime(java.util.concurrent.TimeUnit) using milliseconds

Returns:

the total elapsed time taken by all invocations

getElapsedTotalTime

long getElapsedTotalTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the total elapsed time taken by all invocations

getElapsedMinTime

long getElapsedMinTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the minimum elapsed time a single invocation took

getElapsedMaxTime

long getElapsedMaxTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the maximum elapsed time a single invocation took

getCpuTime

@Deprecated
long getCpuTime()

Deprecated. since 1.9.0, use getCpuTotalTime(java.util.concurrent.TimeUnit) using nanoseconds

Returns:

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

getCpuTotalTime

long getCpuTotalTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the total CPU time taken by all invocations

getCpuMinTime

long getCpuMinTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the minimum CPU time a single invocation took

getCpuMaxTime

long getCpuMaxTime(TimeUnit unit)

Parameters:

unit - the unit to express the time with

Returns:

the maximum CPU time a single invocation took

getResultSetSize

long getResultSetSize()

Returns:

the total result set sizes for all invocations