org.apache.samza.metrics

Interface MetricsAccessor

public interface MetricsAccessor

A MetricsAccessor allows users to retrieve metric values, based on group name and metric name, though specific metrics system, such as JMX.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Long>	getCounterValues(java.lang.String group, java.lang.String counter) Get the values of a counter
<T> java.util.Map<java.lang.String,T>	getGaugeValues(java.lang.String group, java.lang.String gauge) Get the values of a gauge
java.util.Map<java.lang.String,java.lang.Double>	getTimerValues(java.lang.String group, java.lang.String timer) Get the values of a timer

Method Detail

getCounterValues

java.util.Map<java.lang.String,java.lang.Long> getCounterValues(java.lang.String group,
                                                              java.lang.String counter)

Get the values of a counter

Parameters:

group - Group for the counter, e.g. org.apache.samza.container.SamzaContainerMetrics

counter - Name of the counter, e.g. commit-calls

Returns:

A map of counter values, keyed by type, e.g. {"samza-container-0": 100L}

getGaugeValues

<T> java.util.Map<java.lang.String,T> getGaugeValues(java.lang.String group,
                                                   java.lang.String gauge)

Get the values of a gauge

Type Parameters:

T - Type of the gauge value, e.g. Double

Parameters:

group - Group for the gauge, e.g. org.apache.samza.container.SamzaContainerMetrics

gauge - Name of the gauge, e.g. event-loop-utilization

Returns:

A map of gauge values, keyed by type, e.g. {"samza-container-0": 0.8}

getTimerValues

java.util.Map<java.lang.String,java.lang.Double> getTimerValues(java.lang.String group,
                                                              java.lang.String timer)

Get the values of a timer

Parameters:

group - Group for the timer, e.g. org.apache.samza.container.SamzaContainerMetrics

timer - Name of the timer, e.g. choose-ns

Returns:

A map of timer values, keyed by type, e.g. {"samza-container-0": 10.5}