alluxio.metrics

Class MetricKey

java.lang.Object

alluxio.metrics.MetricKey

All Implemented Interfaces:

Comparable<MetricKey>

@ThreadSafe
public final class MetricKey
extends Object
implements Comparable<MetricKey>

Metric keys. This class provides a set of pre-defined Alluxio metric keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricKey.Builder Builder to create MetricKey instances.
static class	MetricKey.Name A nested class to hold named string constants for their corresponding metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static MetricKey	CLIENT_BYTES_READ_LOCAL
static MetricKey	CLIENT_BYTES_READ_LOCAL_THROUGHPUT
static MetricKey	CLIENT_BYTES_WRITTEN_LOCAL
static MetricKey	CLIENT_BYTES_WRITTEN_LOCAL_THROUGHPUT
static MetricKey	CLIENT_BYTES_WRITTEN_UFS
static MetricKey	CLIENT_CACHE_BYTES_EVICTED
static MetricKey	CLIENT_CACHE_BYTES_READ_CACHE
static MetricKey	CLIENT_CACHE_BYTES_READ_EXTERNAL
static MetricKey	CLIENT_CACHE_BYTES_REQUESTED_EXTERNAL
static MetricKey	CLIENT_CACHE_BYTES_WRITTEN_CACHE
static MetricKey	CLIENT_CACHE_CREATE_ERRORS
static MetricKey	CLIENT_CACHE_DELETE_ERRORS
static MetricKey	CLIENT_CACHE_GET_ERRORS
static MetricKey	CLIENT_CACHE_GET_FAILED_READ_ERRORS
static MetricKey	CLIENT_CACHE_HIT_RATE
static MetricKey	CLIENT_CACHE_PAGES_EVICTED
static MetricKey	CLIENT_CACHE_PUT_ERRORS
static MetricKey	CLIENT_CACHE_PUT_FAILED_WRITE_ERRORS
static MetricKey	CLIENT_CACHE_SPACE_AVAILABLE
static MetricKey	CLIENT_CACHE_SPACE_USED
static MetricKey	CLUSTER_BYTES_READ_ALLUXIO
static MetricKey	CLUSTER_BYTES_READ_ALLUXIO_THROUGHPUT
static MetricKey	CLUSTER_BYTES_READ_DOMAIN
static MetricKey	CLUSTER_BYTES_READ_DOMAIN_THROUGHPUT
static MetricKey	CLUSTER_BYTES_READ_LOCAL
static MetricKey	CLUSTER_BYTES_READ_LOCAL_THROUGHPUT
static MetricKey	CLUSTER_BYTES_READ_UFS
static MetricKey	CLUSTER_BYTES_READ_UFS_ALL
static MetricKey	CLUSTER_BYTES_READ_UFS_THROUGHPUT
static MetricKey	CLUSTER_BYTES_WRITTEN_ALLUXIO
static MetricKey	CLUSTER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT
static MetricKey	CLUSTER_BYTES_WRITTEN_DOMAIN
static MetricKey	CLUSTER_BYTES_WRITTEN_DOMAIN_THROUGHPUT
static MetricKey	CLUSTER_BYTES_WRITTEN_LOCAL
static MetricKey	CLUSTER_BYTES_WRITTEN_LOCAL_THROUGHPUT
static MetricKey	CLUSTER_BYTES_WRITTEN_UFS
static MetricKey	CLUSTER_BYTES_WRITTEN_UFS_ALL
static MetricKey	CLUSTER_BYTES_WRITTEN_UFS_THROUGHPUT
static MetricKey	CLUSTER_CAPACITY_FREE
static MetricKey	CLUSTER_CAPACITY_TOTAL
static MetricKey	CLUSTER_CAPACITY_USED
static MetricKey	CLUSTER_ROOT_UFS_CAPACITY_FREE
static MetricKey	CLUSTER_ROOT_UFS_CAPACITY_TOTAL
static MetricKey	CLUSTER_ROOT_UFS_CAPACITY_USED
static MetricKey	CLUSTER_WORKERS
static MetricKey	MASTER_COMPLETE_FILE_OPS
static MetricKey	MASTER_CREATE_DIRECTORIES_OPS
static MetricKey	MASTER_CREATE_FILES_OPS
static MetricKey	MASTER_DELETE_PATHS_OPS
static MetricKey	MASTER_DIRECTORIES_CREATED
static MetricKey	MASTER_EDGE_CACHE_SIZE
static MetricKey	MASTER_FILE_BLOCK_INFOS_GOT
static MetricKey	MASTER_FILE_INFOS_GOT
static MetricKey	MASTER_FILES_COMPLETED
static MetricKey	MASTER_FILES_CREATED
static MetricKey	MASTER_FILES_FREED
static MetricKey	MASTER_FILES_PERSISTED
static MetricKey	MASTER_FILES_PINNED
static MetricKey	MASTER_FREE_FILE_OPS
static MetricKey	MASTER_GET_FILE_BLOCK_INFO_OPS
static MetricKey	MASTER_GET_FILE_INFO_OPS
static MetricKey	MASTER_GET_NEW_BLOCK_OPS
static MetricKey	MASTER_INODE_CACHE_SIZE
static MetricKey	MASTER_JOURNAL_FLUSH_FAILURE
static MetricKey	MASTER_JOURNAL_FLUSH_TIMER
static MetricKey	MASTER_JOURNAL_GAIN_PRIMACY_TIMER
static MetricKey	MASTER_LAST_BACKUP_ENTRIES_COUNT
static MetricKey	MASTER_LAST_BACKUP_RESTORE_COUNT
static MetricKey	MASTER_LAST_BACKUP_RESTORE_TIME_MS
static MetricKey	MASTER_LAST_BACKUP_TIME_MS
static MetricKey	MASTER_LISTING_CACHE_SIZE
static MetricKey	MASTER_MOUNT_OPS
static MetricKey	MASTER_NEW_BLOCKS_GOT
static MetricKey	MASTER_PATHS_DELETED
static MetricKey	MASTER_PATHS_MOUNTED
static MetricKey	MASTER_PATHS_RENAMED
static MetricKey	MASTER_PATHS_UNMOUNTED
static MetricKey	MASTER_RENAME_PATH_OPS
static MetricKey	MASTER_SET_ACL_OPS
static MetricKey	MASTER_SET_ATTRIBUTE_OPS
static MetricKey	MASTER_TOTAL_PATHS
static MetricKey	MASTER_UFS_JOURNAL_FAILURE_RECOVER_TIMER
static MetricKey	MASTER_UNMOUNT_OPS
static MetricKey	WORKER_ASYNC_CACHE_DUPLICATE_REQUESTS
static MetricKey	WORKER_ASYNC_CACHE_FAILED_BLOCKS
static MetricKey	WORKER_ASYNC_CACHE_REMOTE_BLOCKS
static MetricKey	WORKER_ASYNC_CACHE_REQUESTS
static MetricKey	WORKER_ASYNC_CACHE_SUCCEEDED_BLOCKS
static MetricKey	WORKER_ASYNC_CACHE_UFS_BLOCKS
static MetricKey	WORKER_BLOCKS_ACCESSED
static MetricKey	WORKER_BLOCKS_CACHED
static MetricKey	WORKER_BLOCKS_CANCELLED
static MetricKey	WORKER_BLOCKS_DELETED
static MetricKey	WORKER_BLOCKS_EVICTED
static MetricKey	WORKER_BLOCKS_LOST
static MetricKey	WORKER_BLOCKS_PROMOTED
static MetricKey	WORKER_BYTES_READ_ALLUXIO
static MetricKey	WORKER_BYTES_READ_ALLUXIO_THROUGHPUT
static MetricKey	WORKER_BYTES_READ_DOMAIN
static MetricKey	WORKER_BYTES_READ_DOMAIN_THROUGHPUT
static MetricKey	WORKER_BYTES_READ_UFS
static MetricKey	WORKER_BYTES_READ_UFS_THROUGHPUT
static MetricKey	WORKER_BYTES_WRITTEN_ALLUXIO
static MetricKey	WORKER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT
static MetricKey	WORKER_BYTES_WRITTEN_DOMAIN
static MetricKey	WORKER_BYTES_WRITTEN_DOMAIN_THROUGHPUT
static MetricKey	WORKER_BYTES_WRITTEN_UFS
static MetricKey	WORKER_BYTES_WRITTEN_UFS_THROUGHPUT
static MetricKey	WORKER_CAPACITY_FREE
static MetricKey	WORKER_CAPACITY_TOTAL
static MetricKey	WORKER_CAPACITY_USED

Method Summary

Modifier and Type	Method and Description
static Collection<? extends MetricKey>	allMetricKeys()
static Set<MetricKey>	allShouldReportMetricKeys(MetricsSystem.InstanceType instanceType) Gets all the metric keys that belong to the given instance type and should be reported.
int	compareTo(MetricKey o)
boolean	equals(Object o)
static MetricKey	fromString(String name) Parses a given name and return its corresponding MetricKey, throwing exception if no such a Metric can be found.
String	getDescription()
String	getMetricName()
MetricType	getMetricType()
String	getName()
int	hashCode()
boolean	isClusterAggregated()
static boolean	isValid(String name)
static boolean	register(MetricKey key) Registers the given key to the global key map.
String	toString()
static void	unregister(MetricKey key) Unregisters the given key from the global key map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MASTER_EDGE_CACHE_SIZE

public static final MetricKey MASTER_EDGE_CACHE_SIZE

MASTER_FILES_PINNED

public static final MetricKey MASTER_FILES_PINNED

MASTER_INODE_CACHE_SIZE

public static final MetricKey MASTER_INODE_CACHE_SIZE

MASTER_TOTAL_PATHS

public static final MetricKey MASTER_TOTAL_PATHS

MASTER_LAST_BACKUP_ENTRIES_COUNT

public static final MetricKey MASTER_LAST_BACKUP_ENTRIES_COUNT

MASTER_LAST_BACKUP_TIME_MS

public static final MetricKey MASTER_LAST_BACKUP_TIME_MS

MASTER_LAST_BACKUP_RESTORE_COUNT

public static final MetricKey MASTER_LAST_BACKUP_RESTORE_COUNT

MASTER_LAST_BACKUP_RESTORE_TIME_MS

public static final MetricKey MASTER_LAST_BACKUP_RESTORE_TIME_MS

MASTER_DIRECTORIES_CREATED

public static final MetricKey MASTER_DIRECTORIES_CREATED

MASTER_FILE_BLOCK_INFOS_GOT

public static final MetricKey MASTER_FILE_BLOCK_INFOS_GOT

MASTER_FILE_INFOS_GOT

public static final MetricKey MASTER_FILE_INFOS_GOT

MASTER_FILES_COMPLETED

public static final MetricKey MASTER_FILES_COMPLETED

MASTER_FILES_CREATED

public static final MetricKey MASTER_FILES_CREATED

MASTER_FILES_FREED

public static final MetricKey MASTER_FILES_FREED

MASTER_FILES_PERSISTED

public static final MetricKey MASTER_FILES_PERSISTED

MASTER_NEW_BLOCKS_GOT

public static final MetricKey MASTER_NEW_BLOCKS_GOT

MASTER_PATHS_DELETED

public static final MetricKey MASTER_PATHS_DELETED

MASTER_PATHS_MOUNTED

public static final MetricKey MASTER_PATHS_MOUNTED

MASTER_PATHS_RENAMED

public static final MetricKey MASTER_PATHS_RENAMED

MASTER_PATHS_UNMOUNTED

public static final MetricKey MASTER_PATHS_UNMOUNTED

MASTER_COMPLETE_FILE_OPS

public static final MetricKey MASTER_COMPLETE_FILE_OPS

MASTER_CREATE_DIRECTORIES_OPS

public static final MetricKey MASTER_CREATE_DIRECTORIES_OPS

MASTER_CREATE_FILES_OPS

public static final MetricKey MASTER_CREATE_FILES_OPS

MASTER_DELETE_PATHS_OPS

public static final MetricKey MASTER_DELETE_PATHS_OPS

MASTER_FREE_FILE_OPS

public static final MetricKey MASTER_FREE_FILE_OPS

MASTER_GET_FILE_BLOCK_INFO_OPS

public static final MetricKey MASTER_GET_FILE_BLOCK_INFO_OPS

MASTER_GET_FILE_INFO_OPS

public static final MetricKey MASTER_GET_FILE_INFO_OPS

MASTER_GET_NEW_BLOCK_OPS

public static final MetricKey MASTER_GET_NEW_BLOCK_OPS

MASTER_LISTING_CACHE_SIZE

public static final MetricKey MASTER_LISTING_CACHE_SIZE

MASTER_MOUNT_OPS

public static final MetricKey MASTER_MOUNT_OPS

MASTER_RENAME_PATH_OPS

public static final MetricKey MASTER_RENAME_PATH_OPS

MASTER_SET_ACL_OPS

public static final MetricKey MASTER_SET_ACL_OPS

MASTER_SET_ATTRIBUTE_OPS

public static final MetricKey MASTER_SET_ATTRIBUTE_OPS

MASTER_UNMOUNT_OPS

public static final MetricKey MASTER_UNMOUNT_OPS

MASTER_JOURNAL_FLUSH_FAILURE

public static final MetricKey MASTER_JOURNAL_FLUSH_FAILURE

MASTER_JOURNAL_FLUSH_TIMER

public static final MetricKey MASTER_JOURNAL_FLUSH_TIMER

MASTER_JOURNAL_GAIN_PRIMACY_TIMER

public static final MetricKey MASTER_JOURNAL_GAIN_PRIMACY_TIMER

MASTER_UFS_JOURNAL_FAILURE_RECOVER_TIMER

public static final MetricKey MASTER_UFS_JOURNAL_FAILURE_RECOVER_TIMER

CLUSTER_BYTES_READ_ALLUXIO

public static final MetricKey CLUSTER_BYTES_READ_ALLUXIO

CLUSTER_BYTES_READ_ALLUXIO_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_READ_ALLUXIO_THROUGHPUT

CLUSTER_BYTES_READ_DOMAIN

public static final MetricKey CLUSTER_BYTES_READ_DOMAIN

CLUSTER_BYTES_READ_DOMAIN_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_READ_DOMAIN_THROUGHPUT

CLUSTER_BYTES_READ_LOCAL

public static final MetricKey CLUSTER_BYTES_READ_LOCAL

CLUSTER_BYTES_READ_LOCAL_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_READ_LOCAL_THROUGHPUT

CLUSTER_BYTES_READ_UFS

public static final MetricKey CLUSTER_BYTES_READ_UFS

CLUSTER_BYTES_READ_UFS_ALL

public static final MetricKey CLUSTER_BYTES_READ_UFS_ALL

CLUSTER_BYTES_READ_UFS_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_READ_UFS_THROUGHPUT

CLUSTER_BYTES_WRITTEN_ALLUXIO

public static final MetricKey CLUSTER_BYTES_WRITTEN_ALLUXIO

CLUSTER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT

CLUSTER_BYTES_WRITTEN_DOMAIN

public static final MetricKey CLUSTER_BYTES_WRITTEN_DOMAIN

CLUSTER_BYTES_WRITTEN_DOMAIN_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_WRITTEN_DOMAIN_THROUGHPUT

CLUSTER_BYTES_WRITTEN_LOCAL

public static final MetricKey CLUSTER_BYTES_WRITTEN_LOCAL

CLUSTER_BYTES_WRITTEN_LOCAL_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_WRITTEN_LOCAL_THROUGHPUT

CLUSTER_BYTES_WRITTEN_UFS

public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS

CLUSTER_BYTES_WRITTEN_UFS_ALL

public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS_ALL

CLUSTER_BYTES_WRITTEN_UFS_THROUGHPUT

public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS_THROUGHPUT

CLUSTER_CAPACITY_TOTAL

public static final MetricKey CLUSTER_CAPACITY_TOTAL

CLUSTER_CAPACITY_USED

public static final MetricKey CLUSTER_CAPACITY_USED

CLUSTER_CAPACITY_FREE

public static final MetricKey CLUSTER_CAPACITY_FREE

CLUSTER_ROOT_UFS_CAPACITY_TOTAL

public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_TOTAL

CLUSTER_ROOT_UFS_CAPACITY_USED

public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_USED

CLUSTER_ROOT_UFS_CAPACITY_FREE

public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_FREE

CLUSTER_WORKERS

public static final MetricKey CLUSTER_WORKERS

WORKER_ASYNC_CACHE_DUPLICATE_REQUESTS

public static final MetricKey WORKER_ASYNC_CACHE_DUPLICATE_REQUESTS

WORKER_ASYNC_CACHE_FAILED_BLOCKS

public static final MetricKey WORKER_ASYNC_CACHE_FAILED_BLOCKS

WORKER_ASYNC_CACHE_REMOTE_BLOCKS

public static final MetricKey WORKER_ASYNC_CACHE_REMOTE_BLOCKS

WORKER_ASYNC_CACHE_REQUESTS

public static final MetricKey WORKER_ASYNC_CACHE_REQUESTS

WORKER_ASYNC_CACHE_SUCCEEDED_BLOCKS

public static final MetricKey WORKER_ASYNC_CACHE_SUCCEEDED_BLOCKS

WORKER_ASYNC_CACHE_UFS_BLOCKS

public static final MetricKey WORKER_ASYNC_CACHE_UFS_BLOCKS

WORKER_BLOCKS_ACCESSED

public static final MetricKey WORKER_BLOCKS_ACCESSED

WORKER_BLOCKS_CACHED

public static final MetricKey WORKER_BLOCKS_CACHED

WORKER_BLOCKS_CANCELLED

public static final MetricKey WORKER_BLOCKS_CANCELLED

WORKER_BLOCKS_DELETED

public static final MetricKey WORKER_BLOCKS_DELETED

WORKER_BLOCKS_EVICTED

public static final MetricKey WORKER_BLOCKS_EVICTED

WORKER_BLOCKS_LOST

public static final MetricKey WORKER_BLOCKS_LOST

WORKER_BLOCKS_PROMOTED

public static final MetricKey WORKER_BLOCKS_PROMOTED

WORKER_BYTES_READ_ALLUXIO

public static final MetricKey WORKER_BYTES_READ_ALLUXIO

WORKER_BYTES_READ_ALLUXIO_THROUGHPUT

public static final MetricKey WORKER_BYTES_READ_ALLUXIO_THROUGHPUT

WORKER_BYTES_READ_DOMAIN

public static final MetricKey WORKER_BYTES_READ_DOMAIN

WORKER_BYTES_READ_DOMAIN_THROUGHPUT

public static final MetricKey WORKER_BYTES_READ_DOMAIN_THROUGHPUT

WORKER_BYTES_READ_UFS

public static final MetricKey WORKER_BYTES_READ_UFS

WORKER_BYTES_READ_UFS_THROUGHPUT

public static final MetricKey WORKER_BYTES_READ_UFS_THROUGHPUT

WORKER_BYTES_WRITTEN_ALLUXIO

public static final MetricKey WORKER_BYTES_WRITTEN_ALLUXIO

WORKER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT

public static final MetricKey WORKER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT

WORKER_BYTES_WRITTEN_DOMAIN

public static final MetricKey WORKER_BYTES_WRITTEN_DOMAIN

WORKER_BYTES_WRITTEN_DOMAIN_THROUGHPUT

public static final MetricKey WORKER_BYTES_WRITTEN_DOMAIN_THROUGHPUT

WORKER_BYTES_WRITTEN_UFS

public static final MetricKey WORKER_BYTES_WRITTEN_UFS

WORKER_BYTES_WRITTEN_UFS_THROUGHPUT

public static final MetricKey WORKER_BYTES_WRITTEN_UFS_THROUGHPUT

WORKER_CAPACITY_TOTAL

public static final MetricKey WORKER_CAPACITY_TOTAL

WORKER_CAPACITY_USED

public static final MetricKey WORKER_CAPACITY_USED

WORKER_CAPACITY_FREE

public static final MetricKey WORKER_CAPACITY_FREE

CLIENT_BYTES_READ_LOCAL

public static final MetricKey CLIENT_BYTES_READ_LOCAL

CLIENT_BYTES_READ_LOCAL_THROUGHPUT

public static final MetricKey CLIENT_BYTES_READ_LOCAL_THROUGHPUT

CLIENT_BYTES_WRITTEN_LOCAL

public static final MetricKey CLIENT_BYTES_WRITTEN_LOCAL

CLIENT_BYTES_WRITTEN_LOCAL_THROUGHPUT

public static final MetricKey CLIENT_BYTES_WRITTEN_LOCAL_THROUGHPUT

CLIENT_BYTES_WRITTEN_UFS

public static final MetricKey CLIENT_BYTES_WRITTEN_UFS

CLIENT_CACHE_BYTES_READ_CACHE

public static final MetricKey CLIENT_CACHE_BYTES_READ_CACHE

CLIENT_CACHE_BYTES_READ_EXTERNAL

public static final MetricKey CLIENT_CACHE_BYTES_READ_EXTERNAL

CLIENT_CACHE_BYTES_REQUESTED_EXTERNAL

public static final MetricKey CLIENT_CACHE_BYTES_REQUESTED_EXTERNAL

CLIENT_CACHE_BYTES_EVICTED

public static final MetricKey CLIENT_CACHE_BYTES_EVICTED

CLIENT_CACHE_PAGES_EVICTED

public static final MetricKey CLIENT_CACHE_PAGES_EVICTED

CLIENT_CACHE_BYTES_WRITTEN_CACHE

public static final MetricKey CLIENT_CACHE_BYTES_WRITTEN_CACHE

CLIENT_CACHE_HIT_RATE

public static final MetricKey CLIENT_CACHE_HIT_RATE

CLIENT_CACHE_SPACE_AVAILABLE

public static final MetricKey CLIENT_CACHE_SPACE_AVAILABLE

CLIENT_CACHE_SPACE_USED

public static final MetricKey CLIENT_CACHE_SPACE_USED

CLIENT_CACHE_CREATE_ERRORS

public static final MetricKey CLIENT_CACHE_CREATE_ERRORS

CLIENT_CACHE_DELETE_ERRORS

public static final MetricKey CLIENT_CACHE_DELETE_ERRORS

CLIENT_CACHE_GET_ERRORS

public static final MetricKey CLIENT_CACHE_GET_ERRORS

CLIENT_CACHE_GET_FAILED_READ_ERRORS

public static final MetricKey CLIENT_CACHE_GET_FAILED_READ_ERRORS

CLIENT_CACHE_PUT_ERRORS

public static final MetricKey CLIENT_CACHE_PUT_ERRORS

CLIENT_CACHE_PUT_FAILED_WRITE_ERRORS

public static final MetricKey CLIENT_CACHE_PUT_FAILED_WRITE_ERRORS

Method Detail

isValid

public static boolean isValid(String name)

Parameters:

name - name of a metric

Returns:

whether the given name is a valid Metric name

fromString

public static MetricKey fromString(String name)

Parses a given name and return its corresponding MetricKey, throwing exception if no such a Metric can be found.

Parameters:

name - name of the Metric key

Returns:

corresponding Metric

allMetricKeys

public static Collection<? extends MetricKey> allMetricKeys()

Returns:

all pre-defined Alluxio metric keys

allShouldReportMetricKeys

public static Set<MetricKey> allShouldReportMetricKeys(MetricsSystem.InstanceType instanceType)

Gets all the metric keys that belong to the given instance type and should be reported.

Parameters:

instanceType - the instance type that should be reported

Returns:

all pre-defined Alluxio metric keys

getName

public String getName()

Returns:

the name of the Metric

getMetricName

public String getMetricName()

Returns:

the name of the Metric without instance prefix

getDescription

public String getDescription()

Returns:

the description of a Metric

getMetricType

public MetricType getMetricType()

Returns:

the metric type of a Metric

isClusterAggregated

public boolean isClusterAggregated()

Returns:

true if this metrics can be aggregated at cluster level

register

public static boolean register(MetricKey key)

Registers the given key to the global key map.

Parameters:

key - the Metric key

Returns:

whether the Metric key is successfully registered

unregister

public static void unregister(MetricKey key)

Unregisters the given key from the global key map.

Parameters:

key - the Metric to unregister

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(MetricKey o)

Specified by:

compareTo in interface Comparable<MetricKey>