@ThreadSafe public class

GoogleCacheInstruments

extends Object
java.lang.Object
   ↳ com.atlassian.jira.cache.GoogleCacheInstruments

Class Overview

Registers cache metrics in Instrumentation. This is usually called from within a component's "start" callback (e.g. JIRA's Startable.start() or Spring's InitializingBean.afterPropertiesSet()). Example: 

 new GoogleCacheInstruments("cacheName").addCache(this.cacheOfThings).install();
Remember to call GoogleCacheInstruments.uninstall() in the destruction callbacks, or you will cause a memory leak.

This class is thread-safe.

Summary

Public Constructors
GoogleCacheInstruments(String name)
Creates a new GoogleCacheInstruments with the given name.
Public Methods
GoogleCacheInstruments addCache(Cache cache)
Adds cache to the list of caches to expose in JIRA instrumentation.
String getName()
GoogleCacheInstruments install()
Installs one instrument for each of the following statistics for all caches that are monitored by this GoogleCacheInstruments instance:
  1. size
  2. hitCount
  3. missCount
  4. loadSuccessCount
  5. loadExceptionCount
  6. totalLoadTime
  7. evictionCount
GoogleCacheInstruments removeCache(Cache cache)
Removes cache from the list of caches to expose in JIRA instrumentation.
GoogleCacheInstruments uninstall()
Currently does nothing because JIRA does not support uninstalling instruments.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GoogleCacheInstruments (String name)

Creates a new GoogleCacheInstruments with the given name.

Parameters
name the name under which the counters will appear in JIRA instrumentation

Public Methods

public GoogleCacheInstruments addCache (Cache cache)

Adds cache to the list of caches to expose in JIRA instrumentation.

Parameters
cache a Cache
Returns
  • this

public String getName ()

Returns
  • this GoogleCacheInstruments's name

public GoogleCacheInstruments install ()

Installs one instrument for each of the following statistics for all caches that are monitored by this GoogleCacheInstruments instance:

  1. size
  2. hitCount
  3. missCount
  4. loadSuccessCount
  5. loadExceptionCount
  6. totalLoadTime
  7. evictionCount

Returns
  • this

public GoogleCacheInstruments removeCache (Cache cache)

Removes cache from the list of caches to expose in JIRA instrumentation.

Parameters
cache a Cache
Returns
  • this

public GoogleCacheInstruments uninstall ()

Currently does nothing because JIRA does not support uninstalling instruments.

Returns
  • this