alluxio.client.metrics

Class RetryHandlingMetricsMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.metrics.RetryHandlingMetricsMasterClient

All Implemented Interfaces:

Client, MetricsMasterClient, Closeable, AutoCloseable

@ThreadSafe
public class RetryHandlingMetricsMasterClient
extends AbstractMasterClient
implements MetricsMasterClient

A wrapper for the gRPC client to interact with the metrics master.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

mAlwaysEnableTLS, mChannel, mClosed, mConnected, mContext, mServerAddress, mServiceVersion, mVersionService

Constructor Summary

Constructors

Constructor and Description
RetryHandlingMetricsMasterClient(MasterClientContext conf) Creates a new metrics master client.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
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.
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
void	heartbeat(List<ClientMetrics> metrics) The method the worker should periodically execute to heartbeat back to the master.

Methods inherited from class alluxio.AbstractMasterClient

afterDisconnect, beforeConnect, getConfAddress, queryGrpcServerAddress

Methods inherited from class alluxio.AbstractClient

beforeDisconnect, checkVersion, close, connect, connectWithRuntimeException, createChannel, disconnect, getRemoteHostName, getRemoteServiceVersion, getRemoteSockAddress, isClosed, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RetryHandlingMetricsMasterClient

public RetryHandlingMetricsMasterClient(MasterClientContext conf)

Creates a new metrics master client.

Parameters:

conf - master client configuration

Method Detail

getRemoteServiceType

protected ServiceType getRemoteServiceType()

Specified by:

getRemoteServiceType in class AbstractClient

Returns:

the expected type of remote service

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

clearMetrics

public void clearMetrics()
                  throws IOException

Description copied from interface: MetricsMasterClient

Clear the master metrics.

Specified by:

clearMetrics in interface MetricsMasterClient

Throws:

IOException

heartbeat

public void heartbeat(List<ClientMetrics> metrics)
               throws IOException

Description copied from interface: MetricsMasterClient

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

Specified by:

heartbeat in interface MetricsMasterClient

Parameters:

metrics - a list of client metrics

Throws:

IOException

getMetrics

public Map<String,MetricValue> getMetrics()
                                   throws AlluxioStatusException

Description copied from interface: MetricsMasterClient

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

Specified by:

getMetrics in interface MetricsMasterClient

Returns:

a map of metrics information

Throws:

AlluxioStatusException