org.apache.hadoop.yarn.server.nodemanager.webapp

Class ContainerLogsUtils

java.lang.Object

org.apache.hadoop.yarn.server.nodemanager.webapp.ContainerLogsUtils

public class ContainerLogsUtils
extends Object

Contains utilities for fetching a user's log file in a secure fashion. It supports retrieving logs from both local file system and distributed file system depending on where the logs are stored.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
ContainerLogsUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static List<org.apache.hadoop.fs.Path>	getContainerLogDirs(org.apache.hadoop.yarn.api.records.ContainerId containerId, String remoteUser, Context context) Finds the directories that logs for the given container are stored on.
static org.apache.hadoop.fs.Path	getContainerLogFile(org.apache.hadoop.yarn.api.records.ContainerId containerId, String fileName, String remoteUser, Context context) Finds the log file with the given filename for the given container.
static long	getFileLength(org.apache.hadoop.fs.Path logFile, org.apache.hadoop.yarn.api.records.ContainerId containerId, Context context)
static org.apache.hadoop.fs.Path[]	getFilesInDir(org.apache.hadoop.fs.Path dir, org.apache.hadoop.yarn.api.records.ContainerId containerId, Context context)
static InputStream	openLogFileForRead(String containerIdStr, org.apache.hadoop.fs.Path logFile, String remoteUser, Context context)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

ContainerLogsUtils

public ContainerLogsUtils()

Method Detail

getContainerLogDirs

public static List<org.apache.hadoop.fs.Path> getContainerLogDirs(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                                  String remoteUser,
                                                  Context context)
                                                           throws org.apache.hadoop.yarn.exceptions.YarnException

Finds the directories that logs for the given container are stored on.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

getContainerLogFile

public static org.apache.hadoop.fs.Path getContainerLogFile(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                            String fileName,
                                            String remoteUser,
                                            Context context)
                                                     throws org.apache.hadoop.yarn.exceptions.YarnException

Finds the log file with the given filename for the given container.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

openLogFileForRead

public static InputStream openLogFileForRead(String containerIdStr,
                             org.apache.hadoop.fs.Path logFile,
                             String remoteUser,
                             Context context)
                                      throws IOException

Throws:

IOException

getFileLength

public static long getFileLength(org.apache.hadoop.fs.Path logFile,
                 org.apache.hadoop.yarn.api.records.ContainerId containerId,
                 Context context)
                          throws IOException

Throws:

IOException

getFilesInDir

public static org.apache.hadoop.fs.Path[] getFilesInDir(org.apache.hadoop.fs.Path dir,
                                        org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                        Context context)
                                                 throws IOException

Throws:

IOException