org.apache.polygene.api.metrics

Interface MetricsProvider

All Known Subinterfaces:

CodahaleMetricsProvider

All Known Implementing Classes:

CodahaleMetricsMixin, MetricsProviderAdapter

public interface MetricsProvider

Metrics Provider SPI.

The Polygene Runtime will automatically look for a service that implements the MetricsProvider interface and use it for internal Runtime metrics, such as the UnitOfWork measuring the time from creation to close.

The Metrics Library is available to add metric functionality to applications in the same way, and will use the same MetricsProvider.

Note that the usual visibility rules applies, so you might have more than one MetricsProvider server, perhaps per layer.

Method Summary

Modifier and Type	Method and Description
<T extends MetricsFactory> T	createFactory(Class<T> factoryType) Creates a new factory instance.

Method Detail

createFactory

<T extends MetricsFactory> T createFactory(Class<T> factoryType)
                                    throws MetricsNotSupportedException

Creates a new factory instance. The instantiation is done by providing a Metric type, which is one of

• MetricsCounter
• MetricsGauge
• MetricsHealthCheck
• MetricsHistogram
• MetricsMeter
• MetricsTimer

Type Parameters:

T - The metric type requested.

Parameters:

factoryType - The class of the metric type needed.

Returns:

A factory instance

Throws:

MetricsNotSupportedException - when the MetricsProvider is not supporting the factory type requested.