com.atlassian.instrumentation

Interface Gauge

All Superinterfaces:

Comparable<Instrument>, Instrument

All Known Subinterfaces:

DerivedCounter

All Known Implementing Classes:

AtomicGauge, DerivedAtomicCounter, ExternalGauge

public interface Gauge
extends Instrument

A Gauge is a Instrument that can oscillate its value over time. It may be less than the last time you called , the same or more than the last time you called it.

A Gauge is used to represent a monitored value that can go up and down in value. For example the number of "simultaneous users" can go up and down over value.

Since:

v4.0

See Also:

Counter

Method Summary

Modifier and Type	Method and Description
long	addAndGet(long delta) Adds the delta value to the Gauge and returns the new value.
long	decrementAndGet() Decrements one from the Gauge and returns the new value
long	incrementAndGet() Adds one to the Gauge and returns the new value

Methods inherited from interface com.atlassian.instrumentation.Instrument

getName, getValue

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

incrementAndGet

long incrementAndGet()

Adds one to the Gauge and returns the new value

Returns:

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

decrementAndGet

long decrementAndGet()

Decrements one from the Gauge and returns the new value

Returns:

the new value after one has been decremented from the previous value

addAndGet

long addAndGet(long delta)

Adds the delta value to the Gauge and returns the new value.

Parameters:

delta - this can be positive or negative

Returns:

the new value after the delta has been added to the previous value.