AveragingMetricProvider (Solr 9.5.0 core API)

java.lang.Object
- org.apache.solr.util.circuitbreaker.AveragingMetricProvider

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class AveragingMetricProvider
extends Object
implements Closeable
```
Averages the metric value over a period of time

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AveragingMetricProvider.MetricProvider
Interface to provide the metric value.

Constructor Summary

Constructors
Constructor	Description
`AveragingMetricProvider(AveragingMetricProvider.MetricProvider metricProvider, int numSamples, long sampleInterval)`	Creates an instance with an executor that runs every sampleInterval seconds and averages over numSamples samples.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void close()

double getMetricValue()
Return current average.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AveragingMetricProvider
```
public AveragingMetricProvider(AveragingMetricProvider.MetricProvider metricProvider,
                               int numSamples,
                               long sampleInterval)
```
    Creates an instance with an executor that runs every sampleInterval seconds and averages over numSamples samples.
    
    Parameters:
    
    metricProvider - metric provider that will provide a value
    
    numSamples - number of samples to calculate average for
    
    sampleInterval - interval between each sample
- Method Detail
  - getMetricValue
```
public double getMetricValue()
```
    Return current average. This is a cached value, so calling this method will not incur any calculations
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable