Uses of Interface
com.atlassian.instrumentation.Instrument

Packages that use Instrument

Package	Description
com.atlassian.instrumentation
com.atlassian.instrumentation.caches
com.atlassian.instrumentation.compare
com.atlassian.instrumentation.export
com.atlassian.instrumentation.operations

Uses of Instrument in com.atlassian.instrumentation

Subinterfaces of Instrument in com.atlassian.instrumentation

Modifier and Type	Interface and Description
interface	AbsoluteCounter A AbsoluteCounter is a marker interface for a Counter that resets is value to 0 every time AbsoluteCounter.getValue() is called.
interface	Counter A Counter is a Instrument that can only increase in value.
interface	DerivedCounter A DerivedCounter is a marker interface for a Gauge that should be treated as a Counter in terms of rate of change recording but that allows is value to decrease.
interface	Gauge A Gauge is a Instrument that can oscillate its value over time.

Classes in com.atlassian.instrumentation that implement Instrument

Modifier and Type	Class and Description
class	AbsoluteAtomicCounter An AbsoluteCounter is a Counter that resets its value to zero every time AbsoluteAtomicCounter.getValue() is called.
class	AtomicCounter An implementation of Counter that uses an AtomicLong for its value.
class	AtomicGauge A simple implementation of Gauge
class	DerivedAtomicCounter An implementation of DerivedCounter
class	ExternalCounter An ExternalCounter is a Counter that bases its value of an ExternalValue value
class	ExternalGauge An ExternalGauge is a Gauge that bases its value of an ExternalValue value
class	SimpleCounter This instrument is a counter designed for situations where thread safety is not required and hence does not have the overhead of a synchronized counter.
class	SimpleTimer This instrument is a timer designed for situations where thread safety is not required and hence the overhead of a synchronized value is removed.

Methods in com.atlassian.instrumentation that return Instrument

Modifier and Type	Method and Description
Instrument	InstrumentRegistry.getInstrument(String name) Returns an Instrument from the registry with the specified name
Instrument	DefaultInstrumentRegistry.getInstrument(String name) Returns an Instrument from the registry with the specified name
protected Instrument	DefaultInstrumentRegistry.putIfAbsent(String name, Instrument possiblyNeeded) This will be called if a Instrument may be put into the map of known instruments.
Instrument	InstrumentRegistry.putInstrument(Instrument instrument) This will put an Instrument into the registry, atomically overwriting any previous Instrument value.
Instrument	DefaultInstrumentRegistry.putInstrument(Instrument instrument) This will put an Instrument into the registry, ATOMICALLY overwriting any previous Instrument value.

Methods in com.atlassian.instrumentation that return types with arguments of type Instrument

Modifier and Type	Method and Description
List<Instrument>	InstrumentRegistry.snapshotInstruments() This returns a snapshot list of Instrument objects in the InstrumentRegistry at the time the method was called.
List<Instrument>	DefaultInstrumentRegistry.snapshotInstruments() This returns a snapshot list of Instrument objects in the InstrumentRegistry at the time the method was called.

Methods in com.atlassian.instrumentation with parameters of type Instrument

Modifier and Type	Method and Description
int	SimpleTimer.compareTo(Instrument instrument)
int	SimpleCounter.compareTo(Instrument instrument)
int	ExternalGauge.compareTo(Instrument that)
int	ExternalCounter.compareTo(Instrument that)
int	AtomicGauge.compareTo(Instrument that)
int	AtomicCounter.compareTo(Instrument that)
protected Instrument	DefaultInstrumentRegistry.putIfAbsent(String name, Instrument possiblyNeeded) This will be called if a Instrument may be put into the map of known instruments.
Instrument	InstrumentRegistry.putInstrument(Instrument instrument) This will put an Instrument into the registry, atomically overwriting any previous Instrument value.
Instrument	DefaultInstrumentRegistry.putInstrument(Instrument instrument) This will put an Instrument into the registry, ATOMICALLY overwriting any previous Instrument value.
static String	InstrumentToStringBuilder.toString(Instrument instrument)

Uses of Instrument in com.atlassian.instrumentation.caches

Subinterfaces of Instrument in com.atlassian.instrumentation.caches

Modifier and Type	Interface and Description
interface	CacheInstrument An instrument that counts cache hits and misses

Classes in com.atlassian.instrumentation.caches that implement Instrument

Modifier and Type	Class and Description
class	CacheCollector CacheCollector can track cache hits and misses and give out statistics about how the cache is performing.
class	CacheCounter CacheCounter can track cache hits and misses and give out statistics about how the cache is performing

Methods in com.atlassian.instrumentation.caches with parameters of type Instrument

Modifier and Type	Method and Description
int	CacheCounter.compareTo(Instrument that)
int	CacheCollector.compareTo(Instrument that)

Uses of Instrument in com.atlassian.instrumentation.compare

Methods in com.atlassian.instrumentation.compare with parameters of type Instrument

Modifier and Type	Method and Description
int	InstrumentNameComparator.compare(Instrument o1, Instrument o2)
int	InstrumentComparator.compare(Instrument o1, Instrument o2)

Uses of Instrument in com.atlassian.instrumentation.export

Methods in com.atlassian.instrumentation.export with parameters of type Instrument

Modifier and Type	Method and Description
String	XmlInstrumentExporter.export(Instrument instrument)
String	JsonInstrumentExporter.export(Instrument instrument)
String	InstrumentExporter.export(Instrument instrument) Converts a single Instrument to a string representation
String	CsvInstrumentExporter.export(Instrument instrument)

Method parameters in com.atlassian.instrumentation.export with type arguments of type Instrument

Modifier and Type	Method and Description
void	XmlInstrumentExporter.export(List<Instrument> instruments, Writer writer)
void	JsonInstrumentExporter.export(List<Instrument> instruments, Writer writer)
void	InstrumentExporter.export(List<Instrument> instruments, Writer writer) Called to export the list of Instruments into a specific format
void	CsvInstrumentExporter.export(List<Instrument> instruments, Writer writer)

Uses of Instrument in com.atlassian.instrumentation.operations

Subinterfaces of Instrument in com.atlassian.instrumentation.operations

Modifier and Type	Interface and Description
interface	OpInstrument An OpInstrument is a type of @{link Instrument} that exposes 8 values.

Classes in com.atlassian.instrumentation.operations that implement Instrument

Modifier and Type	Class and Description
class	ExternalOpInstrument This class represents an OpInstrument that is calculated externally on demand from values that are "external" to this class.
class	OpCounter 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
class	OpSnapshot This is an snapshot instance of a named operation's timing, invocation count and its result set size.

Methods in com.atlassian.instrumentation.operations with parameters of type Instrument

Modifier and Type	Method and Description
int	OpSnapshot.compareTo(Instrument that) By default it sorts in name / highest time taken / highest invocation count / highest result set size order
int	OpCounter.compareTo(Instrument that) A compareTo method that uses underlying OpSnapshot compareTo
int	ExternalOpInstrument.compareTo(Instrument that)