com.atlassian.instrumentation

Interface Counter

All Superinterfaces:

Comparable<Instrument>, Instrument

All Known Subinterfaces:

AbsoluteCounter

All Known Implementing Classes:

AbsoluteAtomicCounter, AtomicCounter, ExternalCounter, SimpleCounter

public interface Counter
extends Instrument

A Counter is a Instrument that can only increase in value. It can never return a result that is less than the last time it was called.

For example a Counter that represents the "number of connections made" will never decrease in value over time, it can only increase in value.

Counters are usually recorded in terms of rate of change over time, eg the rate of change in connections wihin a minute. The fact that a Counter can never go down in value, allows the recorder to better optimize how it stores is values.

Since:

v4.0

See Also:

Gauge

Method Summary

Modifier and Type	Method and Description
long	addAndGet(long delta) Adds the delta value to the current value and returns the new value.
long	incrementAndGet() Returns the new value after one has been added to the Counter.

Methods inherited from interface com.atlassian.instrumentation.Instrument

getName, getValue

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

incrementAndGet

long incrementAndGet()

Returns the new value after one has been added to the Counter.

Returns:

the new value after one has been added to the previous value

addAndGet

long addAndGet(long delta)

Adds the delta value to the current value and returns the new value. delta MUSt be >= 0. It can never be negative otherwise a IllegalArgumentException will be throw

Parameters:

delta - the value to add

Returns:

the new value after delta has been added to the current value

Throws:

IllegalArgumentException - if the delta value is < 0