Package org.apache.hadoop.yarn.server.nodemanager

Class LocalDirsHandlerService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.nodemanager.LocalDirsHandlerService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service, HealthReporter

public class LocalDirsHandlerService
extends org.apache.hadoop.service.AbstractService
implements HealthReporter

The class which provides functionality of checking the health of the local directories of a node. This specifically manages nodemanager-local-dirs and nodemanager-log-dirs by periodically checking their health.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor	Description
LocalDirsHandlerService()
LocalDirsHandlerService(NodeManagerMetrics nodeManagerMetrics)

Method Summary

Modifier and Type	Method	Description
boolean	areDisksHealthy()	The minimum fraction of number of disks needed to be healthy for a node to be considered healthy in terms of disks is configured using YarnConfiguration.NM_MIN_HEALTHY_DISKS_FRACTION, with a default value of YarnConfiguration.DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION.
void	checkDirs()
void	deregisterLocalDirsChangeListener(DirectoryCollection.DirsChangeListener listener)
void	deregisterLogDirsChangeListener(DirectoryCollection.DirsChangeListener listener)
java.lang.Iterable<org.apache.hadoop.fs.Path>	getAllLocalPathsForRead(java.lang.String pathStr)
java.util.List<java.lang.String>	getDiskFullLocalDirs()
java.util.List<java.lang.String>	getDiskFullLogDirs()
java.lang.String	getDisksHealthReport(boolean listGoodDirs)	Function to generate a report on the state of the disks.
java.lang.String	getHealthReport()	Returns output from health check.
long	getLastDisksCheckTime()
long	getLastHealthReportTime()	Returns time stamp when node health check was last run.
java.util.List<java.lang.String>	getLocalDirs()
java.util.List<java.lang.String>	getLocalDirsForCleanup()	Function to get the local dirs which should be considered when cleaning up resources.
java.util.List<java.lang.String>	getLocalDirsForRead()	Function to get the local dirs which should be considered for reading existing files on disk.
org.apache.hadoop.fs.Path	getLocalPathForRead(java.lang.String pathStr)
org.apache.hadoop.fs.Path	getLocalPathForWrite(java.lang.String pathStr)
org.apache.hadoop.fs.Path	getLocalPathForWrite(java.lang.String pathStr, long size, boolean checkWrite)
java.util.List<java.lang.String>	getLogDirs()
java.util.List<java.lang.String>	getLogDirsForCleanup()	Function to get the log dirs which should be considered when cleaning up resources.
java.util.List<java.lang.String>	getLogDirsForRead()	Function to get the log dirs which should be considered for reading existing files on disk.
org.apache.hadoop.fs.Path	getLogPathForWrite(java.lang.String pathStr, boolean checkWrite)
org.apache.hadoop.fs.Path	getLogPathToRead(java.lang.String pathStr)
boolean	isGoodLocalDir(java.lang.String path)
boolean	isGoodLogDir(java.lang.String path)
boolean	isHealthy()	Gets whether the node is healthy or not.
void	registerLocalDirsChangeListener(DirectoryCollection.DirsChangeListener listener)
void	registerLogDirsChangeListener(DirectoryCollection.DirsChangeListener listener)
protected void	serviceInit(org.apache.hadoop.conf.Configuration config)	Method which initializes the timertask and its interval time.
protected void	serviceStart()	Method used to start the disk health monitoring, if enabled.
protected void	serviceStop()	Method used to terminate the disk health monitoring service.
protected void	updateMetrics()
static java.lang.String[]	validatePaths(java.lang.String[] paths)

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDirsHandlerService

public LocalDirsHandlerService()

LocalDirsHandlerService

public LocalDirsHandlerService(NodeManagerMetrics nodeManagerMetrics)

Method Detail

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration config)
                    throws java.lang.Exception

Method which initializes the timertask and its interval time.

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Throws:

java.lang.Exception

serviceStart

protected void serviceStart()
                     throws java.lang.Exception

Method used to start the disk health monitoring, if enabled.

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

java.lang.Exception

serviceStop

protected void serviceStop()
                    throws java.lang.Exception

Method used to terminate the disk health monitoring service.

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

Throws:

java.lang.Exception

registerLocalDirsChangeListener

public void registerLocalDirsChangeListener(DirectoryCollection.DirsChangeListener listener)

registerLogDirsChangeListener

public void registerLogDirsChangeListener(DirectoryCollection.DirsChangeListener listener)

deregisterLocalDirsChangeListener

public void deregisterLocalDirsChangeListener(DirectoryCollection.DirsChangeListener listener)

deregisterLogDirsChangeListener

public void deregisterLogDirsChangeListener(DirectoryCollection.DirsChangeListener listener)

getLocalDirs

public java.util.List<java.lang.String> getLocalDirs()

Returns:

the good/valid local directories based on disks' health

getLogDirs

public java.util.List<java.lang.String> getLogDirs()

Returns:

the good/valid log directories based on disks' health

getDiskFullLocalDirs

public java.util.List<java.lang.String> getDiskFullLocalDirs()

Returns:

the local directories which have no disk space

getDiskFullLogDirs

public java.util.List<java.lang.String> getDiskFullLogDirs()

Returns:

the log directories that have no disk space

getLocalDirsForRead

public java.util.List<java.lang.String> getLocalDirsForRead()

Function to get the local dirs which should be considered for reading existing files on disk. Contains the good local dirs and the local dirs that have reached the disk space limit

Returns:

the local dirs which should be considered for reading

getLocalDirsForCleanup

public java.util.List<java.lang.String> getLocalDirsForCleanup()

Function to get the local dirs which should be considered when cleaning up resources. Contains the good local dirs and the local dirs that have reached the disk space limit

Returns:

the local dirs which should be considered for cleaning up

getLogDirsForRead

public java.util.List<java.lang.String> getLogDirsForRead()

Function to get the log dirs which should be considered for reading existing files on disk. Contains the good log dirs and the log dirs that have reached the disk space limit

Returns:

the log dirs which should be considered for reading

getLogDirsForCleanup

public java.util.List<java.lang.String> getLogDirsForCleanup()

Function to get the log dirs which should be considered when cleaning up resources. Contains the good log dirs and the log dirs that have reached the disk space limit

Returns:

the log dirs which should be considered for cleaning up

getDisksHealthReport

public java.lang.String getDisksHealthReport(boolean listGoodDirs)

Function to generate a report on the state of the disks.

Parameters:

listGoodDirs - flag to determine whether the report should report the state of good dirs or failed dirs

Returns:

the health report of nm-local-dirs and nm-log-dirs

getHealthReport

public java.lang.String getHealthReport()

Description copied from interface: HealthReporter

Returns output from health check. If node is healthy then an empty string is returned.

Specified by:

getHealthReport in interface HealthReporter

Returns:

output from health check

areDisksHealthy

public boolean areDisksHealthy()

The minimum fraction of number of disks needed to be healthy for a node to be considered healthy in terms of disks is configured using YarnConfiguration.NM_MIN_HEALTHY_DISKS_FRACTION, with a default value of YarnConfiguration.DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION.

Returns:

false if either (a) more than the allowed percentage of nm-local-dirs failed or (b) more than the allowed percentage of nm-log-dirs failed.

isHealthy

public boolean isHealthy()

Description copied from interface: HealthReporter

Gets whether the node is healthy or not.

Specified by:

isHealthy in interface HealthReporter

Returns:

true if node is healthy

getLastDisksCheckTime

public long getLastDisksCheckTime()

getLastHealthReportTime

public long getLastHealthReportTime()

Description copied from interface: HealthReporter

Returns time stamp when node health check was last run.

Specified by:

getLastHealthReportTime in interface HealthReporter

Returns:

timestamp when node health script was last run

isGoodLocalDir

public boolean isGoodLocalDir(java.lang.String path)

isGoodLogDir

public boolean isGoodLogDir(java.lang.String path)

checkDirs

@VisibleForTesting
public void checkDirs()

getLocalPathForWrite

public org.apache.hadoop.fs.Path getLocalPathForWrite(java.lang.String pathStr)
                                               throws java.io.IOException

Throws:

java.io.IOException

getLocalPathForWrite

public org.apache.hadoop.fs.Path getLocalPathForWrite(java.lang.String pathStr,
                                                      long size,
                                                      boolean checkWrite)
                                               throws java.io.IOException

Throws:

java.io.IOException

getLocalPathForRead

public org.apache.hadoop.fs.Path getLocalPathForRead(java.lang.String pathStr)
                                              throws java.io.IOException

Throws:

java.io.IOException

getAllLocalPathsForRead

public java.lang.Iterable<org.apache.hadoop.fs.Path> getAllLocalPathsForRead(java.lang.String pathStr)
                                                                      throws java.io.IOException

Throws:

java.io.IOException

getLogPathForWrite

public org.apache.hadoop.fs.Path getLogPathForWrite(java.lang.String pathStr,
                                                    boolean checkWrite)
                                             throws java.io.IOException

Throws:

java.io.IOException

getLogPathToRead

public org.apache.hadoop.fs.Path getLogPathToRead(java.lang.String pathStr)
                                           throws java.io.IOException

Throws:

java.io.IOException

validatePaths

public static java.lang.String[] validatePaths(java.lang.String[] paths)

updateMetrics

protected void updateMetrics()