alluxio.client.metrics

Interface MetricsMasterClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

RetryHandlingMetricsMasterClient

public interface MetricsMasterClient
extends Closeable

Interface for a metrics master client.

Method Summary

Modifier and Type	Method and Description
void	clearMetrics() Clear the master metrics.
Map<String,MetricValue>	getMetrics() Gets all the metrics stored in the current master from metric name to metric value.
void	heartbeat(List<ClientMetrics> metrics) The method the worker should periodically execute to heartbeat back to the master.

Methods inherited from interface java.io.Closeable

close

Method Detail

clearMetrics

void clearMetrics()
           throws IOException

Clear the master metrics.

Throws:

IOException

heartbeat

void heartbeat(List<ClientMetrics> metrics)
        throws IOException

The method the worker should periodically execute to heartbeat back to the master.

Parameters:

metrics - a list of client metrics

Throws:

IOException

getMetrics

Map<String,MetricValue> getMetrics()
                            throws AlluxioStatusException

Gets all the metrics stored in the current master from metric name to metric value.

Returns:

a map of metrics information

Throws:

AlluxioStatusException