@ThreadSafe public final class MetricKey extends Object implements Comparable<MetricKey>
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.
|
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.
|
public static final MetricKey MASTER_EDGE_CACHE_SIZE
public static final MetricKey MASTER_FILES_PINNED
public static final MetricKey MASTER_INODE_CACHE_SIZE
public static final MetricKey MASTER_TOTAL_PATHS
public static final MetricKey MASTER_LAST_BACKUP_ENTRIES_COUNT
public static final MetricKey MASTER_LAST_BACKUP_TIME_MS
public static final MetricKey MASTER_LAST_BACKUP_RESTORE_COUNT
public static final MetricKey MASTER_LAST_BACKUP_RESTORE_TIME_MS
public static final MetricKey MASTER_DIRECTORIES_CREATED
public static final MetricKey MASTER_FILE_BLOCK_INFOS_GOT
public static final MetricKey MASTER_FILE_INFOS_GOT
public static final MetricKey MASTER_FILES_COMPLETED
public static final MetricKey MASTER_FILES_CREATED
public static final MetricKey MASTER_FILES_FREED
public static final MetricKey MASTER_FILES_PERSISTED
public static final MetricKey MASTER_NEW_BLOCKS_GOT
public static final MetricKey MASTER_PATHS_DELETED
public static final MetricKey MASTER_PATHS_MOUNTED
public static final MetricKey MASTER_PATHS_RENAMED
public static final MetricKey MASTER_PATHS_UNMOUNTED
public static final MetricKey MASTER_COMPLETE_FILE_OPS
public static final MetricKey MASTER_CREATE_DIRECTORIES_OPS
public static final MetricKey MASTER_CREATE_FILES_OPS
public static final MetricKey MASTER_DELETE_PATHS_OPS
public static final MetricKey MASTER_FREE_FILE_OPS
public static final MetricKey MASTER_GET_FILE_BLOCK_INFO_OPS
public static final MetricKey MASTER_GET_FILE_INFO_OPS
public static final MetricKey MASTER_GET_NEW_BLOCK_OPS
public static final MetricKey MASTER_LISTING_CACHE_SIZE
public static final MetricKey MASTER_MOUNT_OPS
public static final MetricKey MASTER_RENAME_PATH_OPS
public static final MetricKey MASTER_SET_ACL_OPS
public static final MetricKey MASTER_SET_ATTRIBUTE_OPS
public static final MetricKey MASTER_UNMOUNT_OPS
public static final MetricKey MASTER_JOURNAL_FLUSH_FAILURE
public static final MetricKey MASTER_JOURNAL_FLUSH_TIMER
public static final MetricKey MASTER_JOURNAL_GAIN_PRIMACY_TIMER
public static final MetricKey MASTER_UFS_JOURNAL_FAILURE_RECOVER_TIMER
public static final MetricKey CLUSTER_BYTES_READ_ALLUXIO
public static final MetricKey CLUSTER_BYTES_READ_ALLUXIO_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_READ_DOMAIN
public static final MetricKey CLUSTER_BYTES_READ_DOMAIN_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_READ_LOCAL
public static final MetricKey CLUSTER_BYTES_READ_LOCAL_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_READ_UFS
public static final MetricKey CLUSTER_BYTES_READ_UFS_ALL
public static final MetricKey CLUSTER_BYTES_READ_UFS_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_WRITTEN_ALLUXIO
public static final MetricKey CLUSTER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_WRITTEN_DOMAIN
public static final MetricKey CLUSTER_BYTES_WRITTEN_DOMAIN_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_WRITTEN_LOCAL
public static final MetricKey CLUSTER_BYTES_WRITTEN_LOCAL_THROUGHPUT
public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS
public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS_ALL
public static final MetricKey CLUSTER_BYTES_WRITTEN_UFS_THROUGHPUT
public static final MetricKey CLUSTER_CAPACITY_TOTAL
public static final MetricKey CLUSTER_CAPACITY_USED
public static final MetricKey CLUSTER_CAPACITY_FREE
public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_TOTAL
public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_USED
public static final MetricKey CLUSTER_ROOT_UFS_CAPACITY_FREE
public static final MetricKey CLUSTER_WORKERS
public static final MetricKey WORKER_ASYNC_CACHE_DUPLICATE_REQUESTS
public static final MetricKey WORKER_ASYNC_CACHE_FAILED_BLOCKS
public static final MetricKey WORKER_ASYNC_CACHE_REMOTE_BLOCKS
public static final MetricKey WORKER_ASYNC_CACHE_REQUESTS
public static final MetricKey WORKER_ASYNC_CACHE_SUCCEEDED_BLOCKS
public static final MetricKey WORKER_ASYNC_CACHE_UFS_BLOCKS
public static final MetricKey WORKER_BLOCKS_ACCESSED
public static final MetricKey WORKER_BLOCKS_CACHED
public static final MetricKey WORKER_BLOCKS_CANCELLED
public static final MetricKey WORKER_BLOCKS_DELETED
public static final MetricKey WORKER_BLOCKS_EVICTED
public static final MetricKey WORKER_BLOCKS_LOST
public static final MetricKey WORKER_BLOCKS_PROMOTED
public static final MetricKey WORKER_BYTES_READ_ALLUXIO
public static final MetricKey WORKER_BYTES_READ_ALLUXIO_THROUGHPUT
public static final MetricKey WORKER_BYTES_READ_DOMAIN
public static final MetricKey WORKER_BYTES_READ_DOMAIN_THROUGHPUT
public static final MetricKey WORKER_BYTES_READ_UFS
public static final MetricKey WORKER_BYTES_READ_UFS_THROUGHPUT
public static final MetricKey WORKER_BYTES_WRITTEN_ALLUXIO
public static final MetricKey WORKER_BYTES_WRITTEN_ALLUXIO_THROUGHPUT
public static final MetricKey WORKER_BYTES_WRITTEN_DOMAIN
public static final MetricKey WORKER_BYTES_WRITTEN_DOMAIN_THROUGHPUT
public static final MetricKey WORKER_BYTES_WRITTEN_UFS
public static final MetricKey WORKER_BYTES_WRITTEN_UFS_THROUGHPUT
public static final MetricKey WORKER_CAPACITY_TOTAL
public static final MetricKey WORKER_CAPACITY_USED
public static final MetricKey WORKER_CAPACITY_FREE
public static final MetricKey CLIENT_BYTES_READ_LOCAL
public static final MetricKey CLIENT_BYTES_READ_LOCAL_THROUGHPUT
public static final MetricKey CLIENT_BYTES_WRITTEN_LOCAL
public static final MetricKey CLIENT_BYTES_WRITTEN_LOCAL_THROUGHPUT
public static final MetricKey CLIENT_BYTES_WRITTEN_UFS
public static final MetricKey CLIENT_CACHE_BYTES_READ_CACHE
public static final MetricKey CLIENT_CACHE_BYTES_READ_EXTERNAL
public static final MetricKey CLIENT_CACHE_BYTES_REQUESTED_EXTERNAL
public static final MetricKey CLIENT_CACHE_BYTES_EVICTED
public static final MetricKey CLIENT_CACHE_PAGES_EVICTED
public static final MetricKey CLIENT_CACHE_BYTES_WRITTEN_CACHE
public static final MetricKey CLIENT_CACHE_HIT_RATE
public static final MetricKey CLIENT_CACHE_SPACE_AVAILABLE
public static final MetricKey CLIENT_CACHE_SPACE_USED
public static final MetricKey CLIENT_CACHE_CREATE_ERRORS
public static final MetricKey CLIENT_CACHE_DELETE_ERRORS
public static final MetricKey CLIENT_CACHE_GET_ERRORS
public static final MetricKey CLIENT_CACHE_GET_FAILED_READ_ERRORS
public static final MetricKey CLIENT_CACHE_PUT_ERRORS
public static final MetricKey CLIENT_CACHE_PUT_FAILED_WRITE_ERRORS
public static boolean isValid(String name)
name
- name of a metricpublic static MetricKey fromString(String name)
MetricKey
,
throwing exception if no such a Metric can be found.name
- name of the Metric keypublic static Collection<? extends MetricKey> allMetricKeys()
public static Set<MetricKey> allShouldReportMetricKeys(MetricsSystem.InstanceType instanceType)
instanceType
- the instance type that should be reportedpublic String getName()
public String getMetricName()
public String getDescription()
public MetricType getMetricType()
public boolean isClusterAggregated()
public static boolean register(MetricKey key)
key
- the Metric keypublic static void unregister(MetricKey key)
key
- the Metric to unregisterpublic int compareTo(MetricKey o)
compareTo
in interface Comparable<MetricKey>
Copyright © 2023. All Rights Reserved.