org.apache.samza.metrics

Interface MetricsRegistry

All Known Subinterfaces:

ReadableMetricsRegistry

All Known Implementing Classes:

NoOpMetricsRegistry

public interface MetricsRegistry

A MetricsRegistry allows its users to create new Metrics and have those metrics wired to specific metrics systems, such as JMX, provided by MetricsReporters. Those implementing Samza jobs use the MetricsRegistry to register metrics, which then handle the details of getting those metrics to each defined MetricsReporter. Users are free to define their metrics into groups as needed for their jobs. MetricsReporters will likely use the group field to group the user-defined metrics together.

Method Summary

Modifier and Type	Method and Description
Counter	newCounter(java.lang.String group, Counter counter) Register existing Counter with this registry
Counter	newCounter(java.lang.String group, java.lang.String name) Create and register a new Counter
<T> Gauge<T>	newGauge(java.lang.String group, Gauge<T> value) Register an existing Gauge
<T> Gauge<T>	newGauge(java.lang.String group, java.lang.String name, T value) Create and register a new Gauge
<T> ListGauge<T>	newListGauge(java.lang.String group, ListGauge<T> listGauge) Register a ListGauge
Timer	newTimer(java.lang.String group, java.lang.String name) Create and Register a new Timer
Timer	newTimer(java.lang.String group, Timer timer) Register existing Timer with this registry

Method Detail

newCounter

Counter newCounter(java.lang.String group,
                   java.lang.String name)

Create and register a new Counter

Parameters:

group - Group for this Counter

name - Name of to-be-created Counter

Returns:

New Counter instance

newCounter

Counter newCounter(java.lang.String group,
                   Counter counter)

Register existing Counter with this registry

Parameters:

group - Group for this Counter

counter - Existing Counter to register

Returns:

Counter that was registered

newGauge

<T> Gauge<T> newGauge(java.lang.String group,
                      java.lang.String name,
                      T value)

Create and register a new Gauge

Type Parameters:

T - Type the Gauge will be wrapping

Parameters:

group - Group for this Gauge

name - Name of to-be-created Gauge

value - Initial value for the Gauge

Returns:

Gauge was created and registered

newGauge

<T> Gauge<T> newGauge(java.lang.String group,
                      Gauge<T> value)

Register an existing Gauge

Type Parameters:

T - Type the Gauge will be wrapping

Parameters:

group - Group for this Gauge

value - Initial value for the Gauge

Returns:

Gauge was registered

newListGauge

<T> ListGauge<T> newListGauge(java.lang.String group,
                              ListGauge<T> listGauge)

Register a ListGauge

Type Parameters:

T - Type of the ListGauge

Parameters:

group - Group for this ListGauge

listGauge - the ListGauge to register

Returns:

ListGauge registered

newTimer

Timer newTimer(java.lang.String group,
               java.lang.String name)

Create and Register a new Timer

Parameters:

group - Group for this Timer

name - Name of to-be-created Timer

Returns:

New Timer instance

newTimer

Timer newTimer(java.lang.String group,
               Timer timer)

Register existing Timer with this registry

Parameters:

group - Group for this Timer

timer - Existing Timer to register

Returns:

Timer that was registered