OpCounter (Atlassian Instrumentation Aggregation

java.lang.Object
- com.atlassian.instrumentation.operations.OpCounter

All Implemented Interfaces:

Instrument, OpInstrument, Comparable<Instrument>
```
public final class OpCounter
extends Object
implements OpInstrument
```
A OpCounter can keep track of how long a computing operation takes and how many times it has been invoked, as well as optionally how bug the result set size was
This is a MUTABLE form of OpSnapshot since it can increase in value. However it is THREAD SAFE in the sense that the values it exposes are IMMUTABLE snapshots in time. You CANNOT get access to the underlying counter values directly.
A OpCounter can be thought of as 3 Counter's rolled into one object.
- The snapshot().getInvocationCount() is like a Counter that shows how many times the operation has been invoked.
- The snapshot().getMillisecondsTaken() is like a Counter that shows how long the operation has taken in total.
- The snapshot().getResultSetSize() is like a Counter that shows how big the results have been.
In fact OpCounter and OpSnapshot is an OpInstrument/Instrument and hence can be recorded as one discrete object
Since:

v4.0

Constructor Summary

Constructors
Constructor and Description
`OpCounter(OpSnapshot opSnapshot)`
`OpCounter(String name)`
`OpCounter(String name, long invocationCount, long elapsedTotal, long elapsedMin, long elapsedMax, long resultSetSize, long cpuTotal, long cpuMin, long cpuMax)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpCounter`	`add(OpCounter opCounter)` Called to increment the values of the OpCounter by the values in another `OpCounter`.
`OpCounter`	`add(OpSnapshot opSnapshot)` Called to increment the values of the OpCounter by the values in the `OpSnapshot`.
`int`	`compareTo(Instrument that)` A compareTo method that uses underlying OpSnapshot compareTo
`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()`
`int`	`hashCode()`
`OpSnapshot`	`snapshot()` This returns the current snapshot value of the counter.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OpCounter
```
public OpCounter(String name)
```
  - OpCounter
```
public OpCounter(OpSnapshot opSnapshot)
```
  - OpCounter
```
public OpCounter(String name,
                 long invocationCount,
                 long elapsedTotal,
                 long elapsedMin,
                 long elapsedMax,
                 long resultSetSize,
                 long cpuTotal,
                 long cpuMin,
                 long cpuMax)
```
- Method Detail
  - add
```
public OpCounter add(OpCounter opCounter)
```
    Called to increment the values of the OpCounter by the values in another OpCounter.
    
    Parameters:
    
    opCounter - a counter of an operation
    
    Returns:
    
    this for a fluent style
  - add
```
public OpCounter add(OpSnapshot opSnapshot)
```
    Called to increment the values of the OpCounter by the values in the OpSnapshot.
    
    Parameters:
    
    opSnapshot - a snapshot of an operation
    
    Returns:
    
    this for a fluent style
  - snapshot
```
public OpSnapshot snapshot()
```
    This returns the current snapshot value of the counter.
    
    Returns:
    
    the current value as a snapshot
  - 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()
```
    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)
```
    A compareTo method that uses underlying OpSnapshot compareTo
    
    Specified by:
    
    compareTo in interface Comparable<Instrument>
    
    Parameters:
    
    that - the object to compare
    
    Returns:
    
    -1, 0 or 1
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Instrument
    
    Returns:
    
    the name of the Instrument.
  - 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

Class OpCounter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpCounter

OpCounter

OpCounter

Method Detail

add

add

snapshot

getInvocationCount

getMillisecondsTaken

getElapsedTotalTime

getElapsedMinTime

getElapsedMaxTime

getResultSetSize

getCpuTime

getCpuTotalTime

getCpuMinTime

getCpuMaxTime

getValue

compareTo

getName

equals

hashCode

toString