org.apache.solr.store.blockcache

Class Metrics

java.lang.Object

org.apache.solr.search.SolrCacheBase

org.apache.solr.store.blockcache.Metrics

All Implemented Interfaces:

SolrInfoMBean, SolrMetricProducer

public class Metrics
extends SolrCacheBase
implements SolrInfoMBean, SolrMetricProducer

A SolrInfoMBean that provides metrics on block cache operations.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.search.SolrCacheBase

SolrCacheBase.AutoWarmCountRef

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category, SolrInfoMBean.Group

Field Summary

Fields

Modifier and Type	Field and Description
AtomicLong	blockCacheEviction
AtomicLong	blockCacheHit
AtomicLong	blockCacheMiss
AtomicLong	blockCacheSize
AtomicLong	blockCacheStoreFail
AtomicLong	blockCacheStoreFail_last
AtomicLong	shardBuffercacheAllocate
AtomicLong	shardBuffercacheLost

Fields inherited from class org.apache.solr.search.SolrCacheBase

autowarm, regenerator

Constructor Summary

Constructors

Constructor and Description
Metrics()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Simple one or two line description
URL[]	getDocs() Documentation URL list.
String	getName() Simple common usage name, e.g.
String	getSource() CVS Source, SVN Source, etc
NamedList<Number>	getStatistics() Any statistics this instance would like to be publicly available via the Solr Administration interface.
void	initializeMetrics(SolrMetricManager manager, String registry, String scope) Initializes metrics specific to this producer

Methods inherited from class org.apache.solr.search.SolrCacheBase

calcHitRatio, getAutowarmDescription, getCategory, getState, getVersion, init, isAutowarmingOn, name, setState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoMBean

getCategory, getVersion

Field Detail

blockCacheSize

public AtomicLong blockCacheSize

blockCacheHit

public AtomicLong blockCacheHit

blockCacheMiss

public AtomicLong blockCacheMiss

blockCacheEviction

public AtomicLong blockCacheEviction

blockCacheStoreFail

public AtomicLong blockCacheStoreFail

blockCacheStoreFail_last

public AtomicLong blockCacheStoreFail_last

shardBuffercacheAllocate

public AtomicLong shardBuffercacheAllocate

shardBuffercacheLost

public AtomicLong shardBuffercacheLost

Constructor Detail

Metrics

public Metrics()

Method Detail

getStatistics

public NamedList<Number> getStatistics()

Description copied from interface: SolrInfoMBean

Any statistics this instance would like to be publicly available via the Solr Administration interface.

Any Object type may be stored in the list, but only the toString() representation will be used.

Specified by:

getStatistics in interface SolrInfoMBean

initializeMetrics

public void initializeMetrics(SolrMetricManager manager,
                              String registry,
                              String scope)

Description copied from interface: SolrMetricProducer

Initializes metrics specific to this producer

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

manager - an instance of SolrMetricManager

registry - registry name where metrics are registered

scope - scope of the metrics (eg. handler name) to separate metrics of instances of the same component executing in different contexts

getName

public String getName()

Description copied from interface: SolrInfoMBean

Simple common usage name, e.g. BasicQueryHandler, or fully qualified clas name.

Specified by:

getName in interface SolrInfoMBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

getSource

public String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

getDocs

public URL[] getDocs()

Description copied from interface: SolrInfoMBean

Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:

getDocs in interface SolrInfoMBean

Overrides:

getDocs in class SolrCacheBase