Package org.apache.solr.metrics

Class MetricSuppliers

java.lang.Object

org.apache.solr.metrics.MetricSuppliers

public class MetricSuppliers
extends Object

Helper class for constructing instances of MetricRegistry.MetricSupplier based on plugin configuration. This allows us to customize eg. Reservoir implementations and parameters for timers and histograms.

Custom supplier implementations must provide a zero-args constructor, and may optionally implement PluginInfoInitialized interface for configuration - if they don't then SolrPluginUtils.invokeSetters(Object, Iterable, boolean) will be used for initialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricSuppliers.DefaultCounterSupplier	Default Counter supplier.
static class	MetricSuppliers.DefaultHistogramSupplier	Default supplier of Histogram instances, with configurable reservoir.
static class	MetricSuppliers.DefaultMeterSupplier	Default Meter supplier.
static class	MetricSuppliers.DefaultTimerSupplier	Default supplier of Timer instances, with configurable clock and reservoir.
static class	MetricSuppliers.NoOpCounterSupplier	No-op implementation of Counter supplier.
static class	MetricSuppliers.NoOpGauge	No-op implementation of Gauge.
static class	MetricSuppliers.NoOpHistogramSupplier	No-op implementation of Histogram supplier.
static class	MetricSuppliers.NoOpMeterSupplier	No-op implementation of Meter supplier.
static interface	MetricSuppliers.NoOpMetric	Marker interface for all no-op metrics.
static class	MetricSuppliers.NoOpTimerSupplier	No-op implementation of Timer supplier.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CLOCK	Clock type parameter.
static String	CLOCK_CPU	CPU-time clock.
static String	CLOCK_USER	User-time clock.
static String	RESERVOIR	Implementation class, must implement Reservoir.
static String	RESERVOIR_EDR_ALPHA	Alpha parameter of ExponentiallyDecayingReservoir.
static String	RESERVOIR_SIZE	Size of reservoir.
static String	RESERVOIR_WINDOW	Time window in seconds of SlidingTimeWindowReservoir.

Constructor Summary

Constructors

Constructor	Description
MetricSuppliers()

Method Summary

Modifier and Type	Method	Description
static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Counter>	counterSupplier(SolrResourceLoader loader, PluginInfo info)	Create a Counter supplier.
static <T> com.codahale.metrics.Gauge<T>	getNoOpGauge(com.codahale.metrics.Gauge<T> actual)
static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Histogram>	histogramSupplier(SolrResourceLoader loader, PluginInfo info)	Create a Histogram supplier.
static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Meter>	meterSupplier(SolrResourceLoader loader, PluginInfo info)	Create a Meter supplier.
static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Timer>	timerSupplier(SolrResourceLoader loader, PluginInfo info)	Create a Timer supplier.

Methods inherited from class java.lang.Object

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

Field Detail

CLOCK

public static final String CLOCK

Clock type parameter.

See Also:

Constant Field Values

CLOCK_USER

public static final String CLOCK_USER

User-time clock.

See Also:

Constant Field Values

CLOCK_CPU

public static final String CLOCK_CPU

CPU-time clock.

See Also:

Constant Field Values

RESERVOIR

public static final String RESERVOIR

Implementation class, must implement Reservoir. Supports non-standard configuration of the implementations available in metrics-core.

See Also:

Constant Field Values

RESERVOIR_SIZE

public static final String RESERVOIR_SIZE

Size of reservoir.

See Also:

Constant Field Values

RESERVOIR_EDR_ALPHA

public static final String RESERVOIR_EDR_ALPHA

Alpha parameter of ExponentiallyDecayingReservoir.

See Also:

Constant Field Values

RESERVOIR_WINDOW

public static final String RESERVOIR_WINDOW

Time window in seconds of SlidingTimeWindowReservoir.

See Also:

Constant Field Values

Constructor Detail

MetricSuppliers

public MetricSuppliers()

Method Detail

counterSupplier

public static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Counter> counterSupplier(SolrResourceLoader loader,
                                                                                                               PluginInfo info)

Create a Counter supplier.

Parameters:

loader - resource loader

info - plugin configuration, or null for default

Returns:

configured supplier instance, or default instance if configuration was invalid

meterSupplier

public static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Meter> meterSupplier(SolrResourceLoader loader,
                                                                                                           PluginInfo info)

Create a Meter supplier.

Parameters:

loader - resource loader

info - plugin configuration, or null for default

Returns:

configured supplier instance, or default instance if configuration was invalid

timerSupplier

public static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Timer> timerSupplier(SolrResourceLoader loader,
                                                                                                           PluginInfo info)

Create a Timer supplier.

Parameters:

loader - resource loader

info - plugin configuration, or null for default

Returns:

configured supplier instance, or default instance if configuration was invalid

histogramSupplier

public static com.codahale.metrics.MetricRegistry.MetricSupplier<com.codahale.metrics.Histogram> histogramSupplier(SolrResourceLoader loader,
                                                                                                                   PluginInfo info)

Create a Histogram supplier.

Parameters:

info - plugin configuration, or null for default

Returns:

configured supplier instance, or default instance if configuration was invalid

getNoOpGauge

public static <T> com.codahale.metrics.Gauge<T> getNoOpGauge(com.codahale.metrics.Gauge<T> actual)