CacheCollector (Atlassian Instrumentation Aggregation

java.lang.Object
- com.atlassian.instrumentation.caches.CacheCollector

All Implemented Interfaces:

CacheInstrument, RequestListener, Instrument, Comparable<Instrument>
```
public class CacheCollector
extends Object
implements CacheInstrument, RequestListener
```
CacheCollector can track cache hits and misses and give out statistics about how the cache is performing.

Since:

1.10.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CacheCollector.Sizer` In order to find out how large a cache is, this callback interface is invoked to give a "guesstimate" about how large the cache is at present.

Field Summary

Fields
Modifier and Type Field and Description

protected String name

static CacheCollector.Sizer NOOP_SIZER
A sizer that always returns -1

protected CacheCollector.Sizer sizer

Fields
Modifier and Type	Field and Description
`protected String`	`name`
`static CacheCollector.Sizer`	`NOOP_SIZER` A sizer that always returns -1
`protected CacheCollector.Sizer`	`sizer`

Constructor Summary

Constructors
Constructor and Description

CacheCollector(String name)

CacheCollector(String name, CacheCollector.Sizer sizer)

Constructors
Constructor and Description
`CacheCollector(String name)`
`CacheCollector(String name, CacheCollector.Sizer sizer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Instrument that)`
`long`	`getCacheSize()`
`com.atlassian.instrumentation.caches.CacheCollector.Counters`	`getCounter()` Returns the counter that is on the ThreadLocal.
`double`	`getHitMissRatio()`
`long`	`getHits()`
`String`	`getLoggingKey()` This value will be used in the JSON object when logged to identify this collection of statistics.
`long`	`getMisses()`
`long`	`getMissTime()`
`String`	`getName()` Get the name of the instrument that we are collecting
`long`	`getPuts()`
`long`	`getRemoves()`
`List<SimpleTimer>`	`getSplits()`
`List<String>`	`getTags()` Get the tags that are associated with this instrument.
`long`	`getValue()`
`long`	`hit()` Call this to record a hits on the instrumented cache
`boolean`	`isEnabled()` Returns true if the instrument is enabled.
`long`	`miss()` Call this to record a misses on the instrumented cache
`long`	`miss(long nanosecondsTaken)` Record a misses on the instrumented cache and how long it took to create the object that was missed.
`Map<String,Object>`	`onRequestEnd()` Process data collected at the end of the request.
`void`	`onRequestStart()` Request preamble - run before the application's request processing starts.
`long`	`put()` Call this to record a new put into the cache.
`long`	`remove()` Count removes from the cache.
`void`	`setEnabled(boolean enabled)` Set the instrument to have collection enabled if passed true.

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

- Field Detail
  - NOOP_SIZER
```
public static final CacheCollector.Sizer NOOP_SIZER
```
    A sizer that always returns -1
  - name
```
protected final String name
```
  - sizer
```
protected final CacheCollector.Sizer sizer
```
- Constructor Detail
  - CacheCollector
```
public CacheCollector(String name)
```
  - CacheCollector
```
public CacheCollector(String name,
                      CacheCollector.Sizer sizer)
```
- Method Detail
  - getCounter
```
public com.atlassian.instrumentation.caches.CacheCollector.Counters getCounter()
```
    Returns the counter that is on the ThreadLocal.
    
    Returns:
    
    The counter for this thread.
  - getLoggingKey
```
public String getLoggingKey()
```
    Description copied from interface: RequestListener
    
    This value will be used in the JSON object when logged to identify this collection of statistics.
    
    Specified by:
    
    getLoggingKey in interface RequestListener
    
    Returns:
    
    The key value.
  - hit
```
public long hit()
```
    Call this to record a hits on the instrumented cache
    
    Returns:
    
    the number of hits for this instrumented cache
  - miss
```
public long miss()
```
    Call this to record a misses on the instrumented cache
    
    Returns:
    
    the number of misses for this instrumented cache
  - miss
```
public long miss(long nanosecondsTaken)
```
    Record a misses on the instrumented cache and how long it took to create the object that was missed. This allows you to know the true cost in time for cache misses.
    
    Parameters:
    
    nanosecondsTaken - the time in nanoseconds it took to create the missed cache object
    
    Returns:
    
    the number of misses for this instrumented cache
  - put
```
public long put()
```
    Call this to record a new put into the cache.
    
    Returns:
    
    The number of put for the instrumented cache.
  - remove
```
public long remove()
```
    Count removes from the cache.
    
    Returns:
    
    The new value of the counter.
  - getSplits
```
public List<SimpleTimer> getSplits()
```
  - getName
```
public String getName()
```
    Description copied from interface: RequestListener
    
    Get the name of the instrument that we are collecting
    
    Specified by:
    
    getName in interface RequestListener
    
    Specified by:
    
    getName in interface Instrument
    
    Returns:
    
    the name of the Instrument.
  - onRequestStart
```
public void onRequestStart()
```
    Description copied from interface: RequestListener
    
    Request preamble - run before the application's request processing starts.
    
    Specified by:
    
    onRequestStart in interface RequestListener
  - onRequestEnd
```
public Map<String,Object> onRequestEnd()
```
    Process data collected at the end of the request.
    
    Specified by:
    
    onRequestEnd in interface RequestListener
    
    Returns:
    
    A Map containing name -> String converted statistic.
  - getTags
```
public List<String> getTags()
```
    Description copied from interface: RequestListener
    
    Get the tags that are associated with this instrument. Tags can be used to aggregate the statistics in different ways.. By default there are no tags.
    
    Specified by:
    
    getTags in interface RequestListener
    
    Returns:
    
    A list containing the tags associated with this instrument.
  - 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)
```
    Specified by:
    
    compareTo in interface Comparable<Instrument>
  - getHits
```
public long getHits()
```
    Specified by:
    
    getHits in interface CacheInstrument
    
    Returns:
    
    the total number of hits that have been made on the underlying instrumented cache
  - getMisses
```
public long getMisses()
```
    Specified by:
    
    getMisses in interface CacheInstrument
    
    Returns:
    
    the total number of misses that have been made on the underlying instrumented cache
  - getPuts
```
public long getPuts()
```
  - getRemoves
```
public long getRemoves()
```
  - getMissTime
```
public long getMissTime()
```
    Specified by:
    
    getMissTime in interface CacheInstrument
    
    Returns:
    
    the total time it has take to create objects because of cache misses on the underlying instrumented cache
  - getHitMissRatio
```
public double getHitMissRatio()
```
    Specified by:
    
    getHitMissRatio in interface CacheInstrument
    
    Returns:
    
    the ration of hits divided by the misses on the underlying instrumented cache
  - getCacheSize
```
public long getCacheSize()
```
    Specified by:
    
    getCacheSize in interface CacheInstrument
    
    Returns:
    
    the size of the underlying instrumented cache
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: RequestListener
    
    Returns true if the instrument is enabled. False otherwise.
    
    Specified by:
    
    isEnabled in interface RequestListener
    
    Returns:
    
    true if enabled, false otherwise.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: RequestListener
    
    Set the instrument to have collection enabled if passed true. False will disable collection.
    
    Specified by:
    
    setEnabled in interface RequestListener
    
    Parameters:
    
    enabled - True to enable collection. False otherwise.

Class CacheCollector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOOP_SIZER

name

sizer

Constructor Detail

CacheCollector

CacheCollector

Method Detail

getCounter

getLoggingKey

hit

miss

miss

put

remove

getSplits

getName

onRequestStart

onRequestEnd

getTags

getValue

compareTo

getHits

getMisses

getPuts

getRemoves

getMissTime

getHitMissRatio

getCacheSize

isEnabled

setEnabled