Package org.apache.hadoop.yarn.util

Class DFSLoggingHandler

java.lang.Object

org.apache.hadoop.yarn.util.DFSLoggingHandler

Direct Known Subclasses:

MapRFSLoggingHandler

public abstract class DFSLoggingHandler
extends java.lang.Object

Base class to handle DFS logging related operations. Sub-classes should provide DFS specific behavior.

Constructor Summary

Constructors

Constructor	Description
DFSLoggingHandler()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.fs.Path[]	getLogDir(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)	Returns the absolute log directories that contains logs for the given application.
org.apache.hadoop.fs.Path	getLogDir(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Returns the absolute log directory that contains logs for the given container.
org.apache.hadoop.fs.Path	getLogDirForWrite(java.lang.String relativeContainerLogDir)	Returns the absolute log directory to write to.
org.apache.hadoop.fs.Path	getLogFileForWrite(org.apache.hadoop.fs.Path stdOutDir, java.lang.String stdOutFile)
abstract java.lang.String	getStdErrCommand(java.lang.String stderrFile)	Returns the stderr redirection command to be used.
abstract java.lang.String	getStdOutCommand(java.lang.String stdoutFile)	Returns the stdout redirection command to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

DFSLoggingHandler

public DFSLoggingHandler()

Method Detail

getStdOutCommand

public abstract java.lang.String getStdOutCommand(java.lang.String stdoutFile)

Returns the stdout redirection command to be used. This input to this command is the stdout generated by the task.

Parameters:

stdoutFile - name of the file to which stdout will be redirected

Returns:

stdout redirection command

getStdErrCommand

public abstract java.lang.String getStdErrCommand(java.lang.String stderrFile)

Returns the stderr redirection command to be used. This input to this command is the stderr generated by the task.

Parameters:

stderrFile - name of the file to which stdout will be redirected

Returns:

stderr redirection command

getLogDirForWrite

public org.apache.hadoop.fs.Path getLogDirForWrite(java.lang.String relativeContainerLogDir)
                                            throws java.io.IOException

Returns the absolute log directory to write to.

Parameters:

relativeContainerLogDir - path of the specific container directory to write to

Returns:

absolute log directory

Throws:

java.io.IOException

getLogDir

public org.apache.hadoop.fs.Path[] getLogDir(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)
                                      throws java.io.IOException

Returns the absolute log directories that contains logs for the given application. An application can contain one or more containers and each container logs can potentially be stored in different directories. Hence an array of paths is returned.

Parameters:

applicationId - application ID

Returns:

absolute log directories that contain the given application logs

Throws:

java.io.IOException

getLogDir

public org.apache.hadoop.fs.Path getLogDir(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                    throws java.io.IOException

Returns the absolute log directory that contains logs for the given container.

Parameters:

containerId - container ID

Returns:

absolute log directory that contain then given container logs

Throws:

java.io.IOException

getLogFileForWrite

public org.apache.hadoop.fs.Path getLogFileForWrite(org.apache.hadoop.fs.Path stdOutDir,
                                                    java.lang.String stdOutFile)