Package org.apache.hadoop.fs.azurebfs.enums

Enum Class AbfsReadResourceUtilizationMetricsEnum

java.lang.Object

java.lang.Enum<AbfsReadResourceUtilizationMetricsEnum>

org.apache.hadoop.fs.azurebfs.enums.AbfsReadResourceUtilizationMetricsEnum

All Implemented Interfaces:

Serializable, Comparable<AbfsReadResourceUtilizationMetricsEnum>, Constable, org.apache.hadoop.fs.azurebfs.enums.AbfsResourceUtilizationMetricsEnum

public enum AbfsReadResourceUtilizationMetricsEnum
extends Enum<AbfsReadResourceUtilizationMetricsEnum>
implements org.apache.hadoop.fs.azurebfs.enums.AbfsResourceUtilizationMetricsEnum

Enum representing the set of metrics tracked for the ABFS read thread pool. Each metric includes a short name used for reporting and its corresponding StatisticTypeEnum, which defines how the metric is measured (e.g., gauge).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE_THREADS	Number of threads currently executing read operations.
AVAILABLE_MEMORY	Available heap memory (in GB) measured during read operations.
COMMITTED_MEMORY	Committed heap memory (in GB) measured during read operations.
CURRENT_POOL_SIZE	Current number of threads in the read thread pool.
IDLE_THREADS	Number of threads currently idle.
JVM_CPU_UTILIZATION	Recent JVM CPU load value as reported by the JVM (0.0 to 1.0).
JVM_PROCESS_ID	The process ID (PID) of the running JVM, useful for correlating metrics with system-level process information.
LAST_SCALE_DIRECTION	Direction of the last scaling decision (e.g., scale-up or scale-down).
MAX_CPU_UTILIZATION	Maximum CPU utilization recorded during the monitoring interval.
MAX_HEAP_MEMORY	Maximum heap memory (in GB) measured during read operations.
MAX_POOL_SIZE	Maximum configured size of the read thread pool.
MEMORY_LOAD	Available heap memory (in GB) measured during read operations.
SYSTEM_CPU_UTILIZATION	Overall system-wide CPU utilization percentage during read operations.
USED_MEMORY	Used heap memory (in GB) measured during read operations.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the short name of the metric.
StatisticTypeEnum	getStatisticType()	Returns the StatisticTypeEnum associated with this metric.
static AbfsReadResourceUtilizationMetricsEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AbfsReadResourceUtilizationMetricsEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CURRENT_POOL_SIZE

public static final AbfsReadResourceUtilizationMetricsEnum CURRENT_POOL_SIZE

Current number of threads in the read thread pool.

MAX_POOL_SIZE

public static final AbfsReadResourceUtilizationMetricsEnum MAX_POOL_SIZE

Maximum configured size of the read thread pool.

ACTIVE_THREADS

public static final AbfsReadResourceUtilizationMetricsEnum ACTIVE_THREADS

Number of threads currently executing read operations.

IDLE_THREADS

public static final AbfsReadResourceUtilizationMetricsEnum IDLE_THREADS

Number of threads currently idle.

JVM_CPU_UTILIZATION

public static final AbfsReadResourceUtilizationMetricsEnum JVM_CPU_UTILIZATION

Recent JVM CPU load value as reported by the JVM (0.0 to 1.0).

SYSTEM_CPU_UTILIZATION

public static final AbfsReadResourceUtilizationMetricsEnum SYSTEM_CPU_UTILIZATION

Overall system-wide CPU utilization percentage during read operations.

AVAILABLE_MEMORY

public static final AbfsReadResourceUtilizationMetricsEnum AVAILABLE_MEMORY

Available heap memory (in GB) measured during read operations.

COMMITTED_MEMORY

public static final AbfsReadResourceUtilizationMetricsEnum COMMITTED_MEMORY

Committed heap memory (in GB) measured during read operations.

USED_MEMORY

public static final AbfsReadResourceUtilizationMetricsEnum USED_MEMORY

Used heap memory (in GB) measured during read operations.

MAX_HEAP_MEMORY

public static final AbfsReadResourceUtilizationMetricsEnum MAX_HEAP_MEMORY

Maximum heap memory (in GB) measured during read operations.

MEMORY_LOAD

public static final AbfsReadResourceUtilizationMetricsEnum MEMORY_LOAD

Available heap memory (in GB) measured during read operations.

LAST_SCALE_DIRECTION

public static final AbfsReadResourceUtilizationMetricsEnum LAST_SCALE_DIRECTION

Direction of the last scaling decision (e.g., scale-up or scale-down).

MAX_CPU_UTILIZATION

public static final AbfsReadResourceUtilizationMetricsEnum MAX_CPU_UTILIZATION

Maximum CPU utilization recorded during the monitoring interval.

JVM_PROCESS_ID

public static final AbfsReadResourceUtilizationMetricsEnum JVM_PROCESS_ID

The process ID (PID) of the running JVM, useful for correlating metrics with system-level process information.

Method Details

values

public static AbfsReadResourceUtilizationMetricsEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AbfsReadResourceUtilizationMetricsEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Returns the short name of the metric.

Specified by:

getName in interface org.apache.hadoop.fs.azurebfs.enums.AbfsResourceUtilizationMetricsEnum

Returns:

the metric name.

getStatisticType

public StatisticTypeEnum getStatisticType()

Returns the StatisticTypeEnum associated with this metric.

Specified by:

getStatisticType in interface org.apache.hadoop.fs.azurebfs.enums.AbfsResourceUtilizationMetricsEnum

Returns:

the metric's statistic type.