FSNamesystemMBean (Apache Hadoop HDFS 3.4.1.0-eep-940 API)

All Known Implementing Classes:

FSNamesystem
```
@Private
public interface FSNamesystemMBean
```
This Interface defines the methods to get the status of a the FSNamesystem of a name node. It is also used for publishing via JMX (hence we follow the JMX naming convention.) Note we have not used the MetricsDynamicMBeanBase to implement this because the interface for the NameNodeStateMBean is stable and should be published as an interface.
Name Node runtime activity statistic info is reported in

See Also:

NameNodeMetrics

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`long`	`getBlockDeletionStartTime()`	Time when block deletions will begin
`long`	`getBlocksTotal()`	Number of allocated blocks in the system
`long`	`getCapacityRemaining()`	Free (unused) storage capacity
`long`	`getCapacityTotal()`	Total storage capacity
`long`	`getCapacityUsed()`	Used storage capacity
`long`	`getCurrentTokensCount()`	Get the current number of delegation tokens in memory.
`long`	`getEstimatedCapacityLostTotal()`	Returns an estimate of total capacity lost due to volume failures in bytes across all live data nodes.
`long`	`getFilesTotal()`	Total number of files and directories
`int`	`getFsLockQueueLength()`	Returns the length of the wait Queue for the FSNameSystemLock.
`java.lang.String`	`getFSState()`	The state of the file system: Safemode or Operational
`long`	`getLowRedundancyBlocks()`	Get aggregated count of all blocks with low redundancy.
`long`	`getMaxObjects()`	Return the maximum number of inodes in the file system
`int`	`getNumDeadDataNodes()`	Number of dead data nodes
`int`	`getNumDecomDeadDataNodes()`	Number of decommissioned dead data nodes
`int`	`getNumDecomLiveDataNodes()`	Number of decommissioned Live data nodes
`int`	`getNumDecommissioningDataNodes()`	Number of data nodes that are in the decommissioning state
`int`	`getNumEncryptionZones()`	Return the number of encryption zones in the system.
`int`	`getNumEnteringMaintenanceDataNodes()`
`int`	`getNumInMaintenanceDeadDataNodes()`
`int`	`getNumInMaintenanceLiveDataNodes()`
`int`	`getNumInServiceLiveDataNodes()`
`int`	`getNumLiveDataNodes()`	Number of Live data nodes
`int`	`getNumStaleDataNodes()`	Number of stale data nodes
`int`	`getNumStaleStorages()`	Number of content stale storages.
`long`	`getPendingDeletionBlocks()`	Number of blocks pending deletion
`long`	`getPendingReconstructionBlocks()`	Get aggregated count of all blocks pending to be reconstructed.
`long`	`getPendingReplicationBlocks()`	Deprecated. Use `getPendingReconstructionBlocks()` instead.
`int`	`getPendingSPSPaths()`	Returns the number of paths to be processed by storage policy satisfier.
`long`	`getProvidedCapacityTotal()`	Total PROVIDED storage capacity.
`float`	`getReconstructionQueuesInitProgress()`	Get the progress of the reconstruction queues initialisation.
`long`	`getScheduledReplicationBlocks()`	Blocks scheduled for replication
`java.lang.String`	`getSnapshotStats()`	The statistics of snapshots
`java.lang.String`	`getTopUserOpCounts()`	Returns a nested JSON object listing the top users for different RPC operations over tracked time windows.
`int`	`getTotalLoad()`	Total Load on the FSNamesystem
`long`	`getTotalSyncCount()`	Return total number of Sync Operations on FSEditLog.
`java.lang.String`	`getTotalSyncTimes()`	Return total time spent doing sync operations on FSEditLog.
`long`	`getUnderReplicatedBlocks()`	Deprecated. Use `getLowRedundancyBlocks()` instead.
`int`	`getVolumeFailuresTotal()`	Number of failed data volumes across all live data nodes.

- Method Detail
  - getFSState
```
java.lang.String getFSState()
```
    The state of the file system: Safemode or Operational
    
    Returns:
    
    the state
  - getBlocksTotal
```
long getBlocksTotal()
```
    Number of allocated blocks in the system
    
    Returns:
    
    - number of allocated blocks
  - getCapacityTotal
```
long getCapacityTotal()
```
    Total storage capacity
    
    Returns:
    
    - total capacity in bytes
  - getCapacityRemaining
```
long getCapacityRemaining()
```
    Free (unused) storage capacity
    
    Returns:
    
    - free capacity in bytes
  - getCapacityUsed
```
long getCapacityUsed()
```
    Used storage capacity
    
    Returns:
    
    - used capacity in bytes
  - getProvidedCapacityTotal
```
long getProvidedCapacityTotal()
```
    Total PROVIDED storage capacity.
    
    Returns:
    
    - total PROVIDED storage capacity in bytes
  - getFilesTotal
```
long getFilesTotal()
```
    Total number of files and directories
    
    Returns:
    
    - num of files and directories
  - getPendingReplicationBlocks
```
@Deprecated
long getPendingReplicationBlocks()
```
    Deprecated.
    Use getPendingReconstructionBlocks() instead.
    
    Get aggregated count of all blocks pending to be reconstructed.
  - getPendingReconstructionBlocks
```
long getPendingReconstructionBlocks()
```
    Get aggregated count of all blocks pending to be reconstructed.
    
    Returns:
    
    Number of blocks to be replicated.
  - getUnderReplicatedBlocks
```
@Deprecated
long getUnderReplicatedBlocks()
```
    Deprecated.
    Use getLowRedundancyBlocks() instead.
    
    Get aggregated count of all blocks with low redundancy.
  - getLowRedundancyBlocks
```
long getLowRedundancyBlocks()
```
    Get aggregated count of all blocks with low redundancy.
    
    Returns:
    
    Number of blocks with low redundancy.
  - getScheduledReplicationBlocks
```
long getScheduledReplicationBlocks()
```
    Blocks scheduled for replication
    
    Returns:
    
    - num of blocks scheduled for replication
  - getTotalLoad
```
int getTotalLoad()
```
    Total Load on the FSNamesystem
    
    Returns:
    
    - total load of FSNamesystem
  - getNumLiveDataNodes
```
int getNumLiveDataNodes()
```
    Number of Live data nodes
    
    Returns:
    
    number of live data nodes
  - getNumDeadDataNodes
```
int getNumDeadDataNodes()
```
    Number of dead data nodes
    
    Returns:
    
    number of dead data nodes
  - getNumStaleDataNodes
```
int getNumStaleDataNodes()
```
    Number of stale data nodes
    
    Returns:
    
    number of stale data nodes
  - getNumDecomLiveDataNodes
```
int getNumDecomLiveDataNodes()
```
    Number of decommissioned Live data nodes
    
    Returns:
    
    number of decommissioned live data nodes
  - getNumDecomDeadDataNodes
```
int getNumDecomDeadDataNodes()
```
    Number of decommissioned dead data nodes
    
    Returns:
    
    number of decommissioned dead data nodes
  - getNumInServiceLiveDataNodes
```
int getNumInServiceLiveDataNodes()
```
    Returns:
    
    Number of in-service data nodes, where NumInServiceDataNodes = NumLiveDataNodes - NumDecomLiveDataNodes - NumInMaintenanceLiveDataNodes
  - getVolumeFailuresTotal
```
int getVolumeFailuresTotal()
```
    Number of failed data volumes across all live data nodes.
    
    Returns:
    
    number of failed data volumes across all live data nodes
  - getEstimatedCapacityLostTotal
```
long getEstimatedCapacityLostTotal()
```
    Returns an estimate of total capacity lost due to volume failures in bytes across all live data nodes.
    
    Returns:
    
    estimate of total capacity lost in bytes
  - getNumDecommissioningDataNodes
```
int getNumDecommissioningDataNodes()
```
    Number of data nodes that are in the decommissioning state
  - getSnapshotStats
```
java.lang.String getSnapshotStats()
```
    The statistics of snapshots
  - getMaxObjects
```
long getMaxObjects()
```
    Return the maximum number of inodes in the file system
  - getPendingDeletionBlocks
```
long getPendingDeletionBlocks()
```
    Number of blocks pending deletion
    
    Returns:
    
    number of blocks pending deletion
  - getBlockDeletionStartTime
```
long getBlockDeletionStartTime()
```
    Time when block deletions will begin
    
    Returns:
    
    time when block deletions will begin
  - getNumStaleStorages
```
int getNumStaleStorages()
```
    Number of content stale storages.
    
    Returns:
    
    number of content stale storages
  - getTopUserOpCounts
```
java.lang.String getTopUserOpCounts()
```
    Returns a nested JSON object listing the top users for different RPC operations over tracked time windows.
    
    Returns:
    
    JSON string
  - getNumEncryptionZones
```
int getNumEncryptionZones()
```
    Return the number of encryption zones in the system.
  - getFsLockQueueLength
```
int getFsLockQueueLength()
```
    Returns the length of the wait Queue for the FSNameSystemLock. A larger number here indicates lots of threads are waiting for FSNameSystemLock.
    
    Returns:
    
    int - Number of Threads waiting to acquire FSNameSystemLock
  - getTotalSyncCount
```
long getTotalSyncCount()
```
    Return total number of Sync Operations on FSEditLog.
  - getTotalSyncTimes
```
java.lang.String getTotalSyncTimes()
```
    Return total time spent doing sync operations on FSEditLog.
  - getNumInMaintenanceLiveDataNodes
```
int getNumInMaintenanceLiveDataNodes()
```
    Returns:
    
    Number of IN_MAINTENANCE live data nodes
  - getNumInMaintenanceDeadDataNodes
```
int getNumInMaintenanceDeadDataNodes()
```
    Returns:
    
    Number of IN_MAINTENANCE dead data nodes
  - getNumEnteringMaintenanceDataNodes
```
int getNumEnteringMaintenanceDataNodes()
```
    Returns:
    
    Number of ENTERING_MAINTENANCE data nodes
  - getCurrentTokensCount
```
long getCurrentTokensCount()
```
    Get the current number of delegation tokens in memory.
    
    Returns:
    
    number of DTs
  - getPendingSPSPaths
```
int getPendingSPSPaths()
```
    Returns the number of paths to be processed by storage policy satisfier.
    
    Returns:
    
    The number of paths to be processed by sps.
  - getReconstructionQueuesInitProgress
```
float getReconstructionQueuesInitProgress()
```
    Get the progress of the reconstruction queues initialisation.
    
    Returns:
    
    Returns values between 0 and 1 for the progress.

Interface FSNamesystemMBean

Method Summary

Method Detail

getFSState

getBlocksTotal

getCapacityTotal

getCapacityRemaining

getCapacityUsed

getProvidedCapacityTotal

getFilesTotal

getPendingReplicationBlocks

getPendingReconstructionBlocks

getUnderReplicatedBlocks

getLowRedundancyBlocks

getScheduledReplicationBlocks

getTotalLoad

getNumLiveDataNodes

getNumDeadDataNodes

getNumStaleDataNodes

getNumDecomLiveDataNodes

getNumDecomDeadDataNodes

getNumInServiceLiveDataNodes

getVolumeFailuresTotal

getEstimatedCapacityLostTotal

getNumDecommissioningDataNodes

getSnapshotStats

getMaxObjects

getPendingDeletionBlocks

getBlockDeletionStartTime

getNumStaleStorages

getTopUserOpCounts

getNumEncryptionZones

getFsLockQueueLength

getTotalSyncCount

getTotalSyncTimes

getNumInMaintenanceLiveDataNodes

getNumInMaintenanceDeadDataNodes

getNumEnteringMaintenanceDataNodes

getCurrentTokensCount

getPendingSPSPaths

getReconstructionQueuesInitProgress