Package org.apache.solr.blockcache

Class Metrics

java.lang.Object

org.apache.solr.search.SolrCacheBase

org.apache.solr.blockcache.Metrics

All Implemented Interfaces:

AutoCloseable, SolrInfoBean, SolrMetricProducer

public class Metrics
extends SolrCacheBase
implements SolrInfoBean

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

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

CATEGORY_ATTR, HANDLER_ATTR, NAME_ATTR, OPERATION_ATTR, PLUGIN_NAME_ATTR, RESULT_ATTR, STATE_KEY_ATTR, TYPE_ATTR

Constructor Summary

Constructors

Constructor	Description
Metrics()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Simple one or two line description
String	getName()	Simple common usage name, e.g.
SolrMetricsContext	getSolrMetricsContext()	Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component.
void	initializeMetrics(SolrMetricsContext parentContext, io.opentelemetry.api.common.Attributes attributes)	Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

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

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

close

Field Details

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 Details

Metrics

public Metrics()

Method Details

initializeMetrics

public void initializeMetrics(SolrMetricsContext parentContext,
 io.opentelemetry.api.common.Attributes attributes)

Description copied from interface: SolrMetricProducer

Implementation should initialize all metrics to a SolrMetricsContext Registry/MeterProvider with Attributes as the common set of attributes that will be attached to every metric that is initialized for that class/component

Specified by:

initializeMetrics in interface SolrMetricProducer

Parameters:

parentContext - The registry that the component will initialize metrics to

attributes - Base set of attributes that will be bound to all metrics for that component

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

getSolrMetricsContext

public SolrMetricsContext getSolrMetricsContext()

Description copied from interface: SolrMetricProducer

Implementations should return the context used in SolrMetricProducer.initializeMetrics(SolrMetricsContext, Attributes) to ensure proper cleanup of metrics at the end of the life-cycle of this component. This should be the child context if one was created, or null if the parent context was used.

Specified by:

getSolrMetricsContext in interface SolrMetricProducer