org.apache.tephra.metrics

Class TxMetricsCollector

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.apache.tephra.metrics.TxMetricsCollector

All Implemented Interfaces:

com.google.common.util.concurrent.Service, MetricsCollector

Direct Known Subclasses:

DefaultMetricsCollector

public class TxMetricsCollector
extends com.google.common.util.concurrent.AbstractIdleService
implements MetricsCollector

Metrics Collector Class, to emit Transaction Related Metrics. Note: This default implementation is a no-op and doesn't emit any 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

Constructor Summary

Constructors

Constructor and Description
TxMetricsCollector()

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.
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

TxMetricsCollector

public TxMetricsCollector()

Method Detail

gauge

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

Description copied from interface: MetricsCollector

Report a metric as an absolute value.

Specified by:

gauge in interface MetricsCollector

rate

public void rate(String metricName)

Description copied from interface: MetricsCollector

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

Specified by:

rate in interface MetricsCollector

rate

public void rate(String metricName,
        int count)

Description copied from interface: MetricsCollector

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

Specified by:

rate in interface MetricsCollector

histogram

public void histogram(String metricName,
             int value)

Description copied from interface: MetricsCollector

Report a metric calculating the distribution of the value.

Specified by:

histogram in interface MetricsCollector

configure

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

Description copied from interface: MetricsCollector

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

Specified by:

configure in interface MetricsCollector

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception