DefaultInstrumentRegistry (Atlassian Instrumentation Aggregation

java.lang.Object
- com.atlassian.instrumentation.DefaultInstrumentRegistry

All Implemented Interfaces:

InstrumentRegistry
```
public class DefaultInstrumentRegistry
extends Object
implements InstrumentRegistry
```
This is a glorified Map/Set of Instrument's.
It can create new Instrument objects directly via is pull() methods. This makes it easier to manage the creation of performance statistics.
Names of instruments MUST be unique. For example you cannot have a Counter and a Gauge with the same name. If an Instrument exists with the a specified name and its not of the requested type, then an IllegalStateException will be thrown.
THREAD SAFETY : ConcurrentHashMap is used under the covers to ensure that @{link Instrument}s are created once and only once.

Constructor Summary

Constructors
Constructor and Description
`DefaultInstrumentRegistry()` Creates a default implementation that uses a `SimpleOpTimerFactory`
`DefaultInstrumentRegistry(OpTimerFactory opTimerFactory, RegistryConfiguration registryConfiguration)` Creates an implementation that used the passed in OpTimerFactory

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instrument`	`getInstrument(String name)` Returns an `Instrument` from the registry with the specified name
`int`	`getNumberOfInstruments()` Returns the number of instruments that exist.
`RegistryConfiguration`	`getRegistryConfiguration()`
`AbsoluteCounter`	`pullAbsoluteCounter(String name)` This is a pull through operation that guarantees to ATOMICALLY create a AbsoluteCounter under the name if its not present OR return the previously created one if its there.
`CacheCollector`	`pullCacheCollector(String name)` This is a pull through operation that guarantees to ATOMICALLY create a `CacheCounter` under the name if its not present OR return the previously created one if its there.
`CacheCollector`	`pullCacheCollector(String name, CacheCollector.Sizer sizer)` This is a pull through operation that guarantees to ATOMICALLY create a `CacheCollector` under the name if its not present OR return the previously created one if its there.
`CacheCounter`	`pullCacheCounter(String name)` This is a pull through operation that guarantees to ATOMICALLY create a `CacheCounter` under the name if its not present OR return the previously created one if its there.
`CacheCounter`	`pullCacheCounter(String name, CacheCounter.Sizer sizer)` This is a pull through operation that guarantees to ATOMICALLY create a `CacheCounter` under the name if its not present OR return the previously created one if its there.
`Counter`	`pullCounter(String name)` This is a pull through operation that guarantees to ATOMICALLY create a Counter under the name if its not present OR return the previously created one if its there.
`DerivedCounter`	`pullDerivedCounter(String name)` This is a pull through operation that guarantees to ATOMICALLY create a DerivedCounter under the name if its not present OR return the previously created one if its there.
`Gauge`	`pullGauge(String name)` This is a pull through operation that guarantees to ATOMICALLY create a Gauge under the name if its not present OR return the previously created one if its there.
`OpCounter`	`pullOpCounter(String name)` This is a pull through operation that guarantees to ATOMICALLY create an `OpCounter` under the name if its not present OR return the previously created one if its there.
`OpTimer`	`pullTimer(String name)` This is a pull through operation that guarantees to ATOMICALLY create a OpCounter under the name if its not present OR use the previously created one if its there.
`protected Instrument`	`putIfAbsent(String name, Instrument possiblyNeeded)` This will be called if a `Instrument` may be put into the map of known instruments.
`Instrument`	`putInstrument(Instrument instrument)` This will put an `Instrument` into the registry, ATOMICALLY overwriting any previous `Instrument` value.
`List<Instrument>`	`snapshotInstruments()` This returns a snapshot list of `Instrument` objects in the InstrumentRegistry at the time the method was called.

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

- Constructor Detail
  - DefaultInstrumentRegistry
```
public DefaultInstrumentRegistry()
```
    Creates a default implementation that uses a SimpleOpTimerFactory
  - DefaultInstrumentRegistry
```
public DefaultInstrumentRegistry(OpTimerFactory opTimerFactory,
                                 RegistryConfiguration registryConfiguration)
```
    Creates an implementation that used the passed in OpTimerFactory
    
    Parameters:
    
    opTimerFactory - the factory to use
    
    registryConfiguration - the configuration for the registry
- Method Detail
  - getRegistryConfiguration
```
public RegistryConfiguration getRegistryConfiguration()
```
    Specified by:
    
    getRegistryConfiguration in interface InstrumentRegistry
    
    Returns:
    
    the underlying registry configuration
  - putInstrument
```
public Instrument putInstrument(Instrument instrument)
```
    This will put an Instrument into the registry, ATOMICALLY overwriting any previous Instrument value.
    
    Specified by:
    
    putInstrument in interface InstrumentRegistry
    
    Parameters:
    
    instrument - the NON NULL instrument to add
    
    Returns:
    
    the previous Instrument value
  - getInstrument
```
public Instrument getInstrument(String name)
```
    Returns an Instrument from the registry with the specified name
    
    Specified by:
    
    getInstrument in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the Instrument to return
    
    Returns:
    
    an Instrument or null if there isn't one with that name
  - putIfAbsent
```
protected Instrument putIfAbsent(String name,
                                 Instrument possiblyNeeded)
```
    This will be called if a Instrument may be put into the map of known instruments. This follows the ConcurrentMap.putIfAbsent(Object, Object) semantics
    
    Parameters:
    
    name - the name of the instrument
    
    possiblyNeeded - the possible needed Instrument
    
    Returns:
    
    the old value in the internal map
  - pullAbsoluteCounter
```
public AbsoluteCounter pullAbsoluteCounter(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create a AbsoluteCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullAbsoluteCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the DerivedCounter to pull
    
    Returns:
    
    a NON NULL DerivedCounter guaranteed
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a DerivedCounter
  - pullCounter
```
public Counter pullCounter(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create a Counter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the Counter to pull
    
    Returns:
    
    a NON NULL Counter guaranteed
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a Counter
  - pullDerivedCounter
```
public DerivedCounter pullDerivedCounter(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create a DerivedCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullDerivedCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the DerivedCounter to pull
    
    Returns:
    
    a NON NULL DerivedCounter guaranteed
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a DerivedCounter
  - pullGauge
```
public Gauge pullGauge(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create a Gauge under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullGauge in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the Gauge to pull
    
    Returns:
    
    a NON NULL Gauge guaranteed
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a Gauge
  - pullCacheCollector
```
public CacheCollector pullCacheCollector(String name,
                                         CacheCollector.Sizer sizer)
```
    Description copied from interface: InstrumentRegistry
    
    This is a pull through operation that guarantees to ATOMICALLY create a CacheCollector under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullCacheCollector in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the CacheCounter to pull
    
    sizer - the CacheCollector.Sizer to use that can work out the size of the cache
    
    Returns:
    
    a NON NULL CacheCounter guaranteed
  - pullCacheCollector
```
public CacheCollector pullCacheCollector(String name)
```
    Description copied from interface: InstrumentRegistry
    
    This is a pull through operation that guarantees to ATOMICALLY create a CacheCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullCacheCollector in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the CacheCounter to pull
    
    Returns:
    
    a NON NULL CacheCounter guaranteed
  - pullCacheCounter
```
public CacheCounter pullCacheCounter(String name,
                                     CacheCounter.Sizer sizer)
```
    Description copied from interface: InstrumentRegistry
    
    This is a pull through operation that guarantees to ATOMICALLY create a CacheCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullCacheCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the CacheCounter to pull
    
    sizer - the CacheCounter.Sizer to use that can work out the size of the cache
    
    Returns:
    
    a NON NULL CacheCounter guaranteed
  - pullCacheCounter
```
public CacheCounter pullCacheCounter(String name)
```
    Description copied from interface: InstrumentRegistry
    
    This is a pull through operation that guarantees to ATOMICALLY create a CacheCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullCacheCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the CacheCounter to pull
    
    Returns:
    
    a NON NULL CacheCounter guaranteed
  - pullOpCounter
```
public OpCounter pullOpCounter(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create an OpCounter under the name if its not present OR return the previously created one if its there.
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    
    Specified by:
    
    pullOpCounter in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the OpCounter to pull
    
    Returns:
    
    a NON NULL OpCounter guaranteed
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a OpCounter
  - pullTimer
```
public OpTimer pullTimer(String name)
```
    This is a pull through operation that guarantees to ATOMICALLY create a OpCounter under the name if its not present OR use the previously created one if its there. When OpTimer.end() is called, the value of the timer will be placed inside the named OpCounter.
    You code can use it something like this
```
  OpTimer timer = registry.pullOpTimer("some.operation");
  try {
      ..
      .. do some operation
      ..
  } finally {
    opTimer.end()
    // and OpCounter will now exist
    OpCounter opCounter = (OpCounter) registry.getInstrument("some.operation");
  }
 
```
    THREAD-SAFE - Uses ConcurrentHashMap under the covers
    Specified by:
    
    pullTimer in interface InstrumentRegistry
    
    Parameters:
    
    name - the name of the OpTimer to pull
    
    Returns:
    
    a NON NULL OpTimer guaranteed that is ready and RUNNING. Run Forrest Run!
    
    Throws:
    
    IllegalArgumentException - if there is already a named Instrument in the registry but is not a OpCounter
  - snapshotInstruments
```
public List<Instrument> snapshotInstruments()
```
    This returns a snapshot list of Instrument objects in the InstrumentRegistry at the time the method was called.
    The list is MUTABLE and a copy of the underlying values. So feel free to mutate it by sorting it and filtering it.
    
    Specified by:
    
    snapshotInstruments in interface InstrumentRegistry
    
    Returns:
    
    a mutable List of Instrument objects
  - getNumberOfInstruments
```
public int getNumberOfInstruments()
```
    Description copied from interface: InstrumentRegistry
    
    Returns the number of instruments that exist. Equivalent to calling InstrumentRegistry.snapshotInstruments().size() but more efficient.
    
    Specified by:
    
    getNumberOfInstruments in interface InstrumentRegistry
    
    Returns:
    
    the number of instruments that exist at the time of the call.

Class DefaultInstrumentRegistry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultInstrumentRegistry

DefaultInstrumentRegistry

Method Detail

getRegistryConfiguration

putInstrument

getInstrument

putIfAbsent

pullAbsoluteCounter

pullCounter

pullDerivedCounter

pullGauge

pullCacheCollector

pullCacheCollector

pullCacheCounter

pullCacheCounter

pullOpCounter

pullTimer

snapshotInstruments

getNumberOfInstruments