Package org.apache.solr.store.blockcache

Class Metrics

java.lang.Object

org.apache.solr.search.SolrCacheBase

org.apache.solr.store.blockcache.Metrics

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer

public class Metrics
extends SolrCacheBase
implements SolrInfoBean, SolrMetricProducer

A SolrInfoBean 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.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	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	Description
Metrics()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Simple one or two line description
Set<String>	getMetricNames()	Modifiable set of metric names that this component reports (default is null, which means none).
String	getName()	Simple common usage name, e.g.
SolrMetricsContext	getSolrMetricsContext()	Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
void	initializeMetrics(SolrMetricsContext parentContext, String scope)	Initialize 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.SolrInfoBean

getCategory, getMetricRegistry, getMetricsSnapshot, registerMetricName

Methods inherited from interface org.apache.solr.metrics.SolrMetricProducer

close, initializeMetrics

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

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
                              String scope)

Description copied from interface: SolrMetricProducer

Initialize metrics specific to this producer.

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - parent metrics context. If this component has the same life-cycle as the parent it can simply use the parent context, otherwise it should obtain a child context using SolrMetricsContext.getChildContext(Object) passing this as the child.

scope - component scope

getName

public String getName()

Description copied from interface: SolrInfoBean

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

Specified by:

getName in interface SolrInfoBean

getDescription

public String getDescription()

Description copied from interface: SolrInfoBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoBean

getMetricNames

public Set<String> getMetricNames()

Description copied from interface: SolrInfoBean

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by SolrInfoBean.registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

Specified by:

getMetricNames in interface SolrInfoBean

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementing classes should override this method to provide the context obtained in SolrMetricProducer.initializeMetrics(SolrMetricsContext, String) to ensure proper cleanup of metrics at the end of the life-cycle of this component.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer