Package com.persequor.extension.metrics

Interface IMetricProvider

All Known Subinterfaces:

ISagaAcquireMetricsProvider, ISagaControllersMetricsProvider, ISagaEventMetricsProvider, ISagaInfoMetricProvider, ISagaInstanceMetricsProvider, ISagaJobsMetricsProvider, ISagaMessageProcessingMetricsProvider, ISagaQueueMetricsProvider, ISagaSqlStatsMetricsProvider, ISagaSubscriptionsMetricsProvider, ISagaVocabularyMetricsProvider

public interface IMetricProvider

Method Summary

Modifier and Type	Method	Description
MetricScope	getScope()	Lets Saga decide whether to poll the metric provider in a job, or just query it upon request from the outside.
void	populateMetricFamilies(IMetricFamilyList families)	Populates the provided metric family in accordance to the implementation.

Method Details

getScope

MetricScope getScope()

Lets Saga decide whether to poll the metric provider in a job, or just query it upon request from the outside. Saga will poll metric providers of scope APPLICATION, and save the received metrics in the DB. Saga will query metric providers of scope INSTANCE upon request from the outside, and not save the provided metrics in the DB. See MetricScope for a more detailed description of each.

Returns:

the scope of provider (APPLICATION, INSTANCE)

populateMetricFamilies

void populateMetricFamilies(IMetricFamilyList families)

Populates the provided metric family in accordance to the implementation. Note that a "metric" is not meaningful without a metric family, thereby adding families rather than single metrics. All metric families populated by the implementations will in turn be accessible via Saga's metrics endpoint.

Parameters:

families - - The list to add families to.