Package com.pushtechnology.diffusion.client.features.control

Interface Metrics.MetricCollector

All Known Subinterfaces:

Metrics.SessionMetricCollector, Metrics.TopicMetricCollector

Enclosing interface:

Metrics

public static interface Metrics.MetricCollector

The common base interface for metric collectors.

Method Summary

Modifier and Type	Method	Description
boolean	exportsToPrometheus()	Indicates whether the metric collector exports to Prometheus.
String	getName()	Returns the name of the metric collector.
int	maximumGroups()	Limit the number of groups maintained by this metric collector.

Method Details

getName

String getName()

Returns the name of the metric collector.

Returns:

the name of the metric collector

exportsToPrometheus

boolean exportsToPrometheus()

Indicates whether the metric collector exports to Prometheus.

Returns:

true if exporting to Prometheus

maximumGroups

int maximumGroups()

Limit the number of groups maintained by this metric collector.

Session metric collectors can group metrics by property. Topic metric collectors can group metrics by topic type. This property places an upper limit on the number of groups that will be maintained for the metric collector.

For example, if a session metric collector groups by $SessionId and maximumGroups is 10, then metrics will only be collected for the first 10 sessions.

Returns:

the maximum number of sub-groups maintained by this metric collector

Since:

6.8