co.cask.tephra.metrics

Interface MetricsCollector

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

DefaultMetricsCollector, TxMetricsCollector

public interface MetricsCollector
extends com.google.common.util.concurrent.Service

Basic API for Tephra to support system metrics.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.hadoop.conf.Configuration conf) Called before the collector service is started, allowing the collector to setup any required configuration.
void	gauge(String metricName, int value, String... tags) Report a metric as an absolute value.
void	histogram(String metricName, int value) Report a metric calculating the distribution of the value.
void	rate(String metricName) Report a metric as a count over a given time duration.
void	rate(String metricName, int count) Report a metric as a count over a given time duration.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Method Detail

gauge

void gauge(String metricName,
         int value,
         String... tags)

Report a metric as an absolute value.

rate

void rate(String metricName)

Report a metric as a count over a given time duration. This method uses an implicit count of 1.

rate

void rate(String metricName,
        int count)

Report a metric as a count over a given time duration.

histogram

void histogram(String metricName,
             int value)

Report a metric calculating the distribution of the value.

configure

void configure(org.apache.hadoop.conf.Configuration conf)

Called before the collector service is started, allowing the collector to setup any required configuration.