Package org.apache.hadoop.mapreduce.v2.util

Class MRApps

java.lang.Object

org.apache.hadoop.yarn.util.Apps

org.apache.hadoop.mapreduce.v2.util.MRApps

@Private
@Unstable
public class MRApps
extends org.apache.hadoop.yarn.util.Apps

Helper class for MR applications

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MRApps.TaskAttemptStateUI
static class	MRApps.TaskStateUI

Field Summary

Fields

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

Fields inherited from class org.apache.hadoop.yarn.util.Apps

APP, ID

Constructor Summary

Constructors

Constructor	Description
MRApps()

Method Summary

Modifier and Type	Method	Description
static void	addLog4jSystemProperties(org.apache.hadoop.mapred.Task task, java.util.List<java.lang.String> vargs, org.apache.hadoop.conf.Configuration conf)	Add the JVM system properties necessary to configure ContainerLogAppender or ContainerRollingLogAppender.
static void	addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment, java.lang.String variable, java.lang.String value, org.apache.hadoop.conf.Configuration conf)
static java.lang.ClassLoader	createJobClassLoader(org.apache.hadoop.conf.Configuration conf)	Creates a ApplicationClassLoader if MRJobConfig.MAPREDUCE_JOB_CLASSLOADER is set to true, and the APP_CLASSPATH environment variable is set.
static java.lang.String	crossPlatformifyMREnv(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.yarn.api.ApplicationConstants.Environment env)
static java.lang.String	getChildLogLevel(org.apache.hadoop.conf.Configuration conf, boolean isMap)
static org.apache.hadoop.fs.Path	getEndJobCommitFailureFile(org.apache.hadoop.conf.Configuration conf, java.lang.String user, JobId jobId)
static org.apache.hadoop.fs.Path	getEndJobCommitSuccessFile(org.apache.hadoop.conf.Configuration conf, java.lang.String user, JobId jobId)
static java.lang.String	getJobFile(org.apache.hadoop.conf.Configuration conf, java.lang.String user, org.apache.hadoop.mapreduce.JobID jobId)
static org.apache.hadoop.fs.Path	getStagingAreaDir(org.apache.hadoop.conf.Configuration conf, java.lang.String user)
static org.apache.hadoop.fs.Path	getStartJobCommitFile(org.apache.hadoop.conf.Configuration conf, java.lang.String user, JobId jobId)
static java.lang.String	getSystemPropertiesToLog(org.apache.hadoop.conf.Configuration conf)	Return lines for system property keys and values per configuration.
static void	setClassLoader(java.lang.ClassLoader classLoader, org.apache.hadoop.conf.Configuration conf)	Sets the provided classloader on the given configuration and as the thread context classloader if the classloader is not null.
static void	setClasspath(java.util.Map<java.lang.String,java.lang.String> environment, org.apache.hadoop.conf.Configuration conf)
static void	setEnvFromInputProperty(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String propName, java.lang.String defaultPropValue, org.apache.hadoop.conf.Configuration conf)
static void	setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env, java.lang.String envString, org.apache.hadoop.conf.Configuration conf)
static void	setJobClassLoader(org.apache.hadoop.conf.Configuration conf)	Creates and sets a ApplicationClassLoader on the given configuration and as the thread context classloader, if MRJobConfig.MAPREDUCE_JOB_CLASSLOADER is set to true, and the APP_CLASSPATH environment variable is set.
static void	setupDistributedCache(org.apache.hadoop.conf.Configuration conf, java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.LocalResource> localResources)
static void	setupDistributedCacheLocal(org.apache.hadoop.conf.Configuration conf)	Set up the DistributedCache related configs to make JobContextImpl.getLocalCacheFiles(Configuration) and JobContextImpl.getLocalCacheArchives(Configuration) working.
static MRApps.TaskAttemptStateUI	taskAttemptState(java.lang.String attemptStateStr)
static MRApps.TaskStateUI	taskState(java.lang.String taskStateStr)
static java.lang.String	taskSymbol(TaskType type)
static TaskType	taskType(java.lang.String symbol)
static JobId	toJobID(java.lang.String jid)
static java.lang.String	toString(JobId jid)
static java.lang.String	toString(TaskAttemptId taid)
static java.lang.String	toString(TaskId tid)
static TaskAttemptId	toTaskAttemptID(java.lang.String taid)
static TaskId	toTaskID(java.lang.String tid)

Methods inherited from class org.apache.hadoop.yarn.util.Apps

addToEnvironment, addToEnvironment, crossPlatformify, getEnvVarsFromInputProperty, isApplicationFinalState, setEnvFromInputProperty, setEnvFromInputString, setEnvFromInputString, shouldCountTowardsNodeBlacklisting, shouldHaveNext, throwParseException, toAppID, toAppID

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

MRApps

public MRApps()

Method Detail

toString

public static java.lang.String toString(JobId jid)

toJobID

public static JobId toJobID(java.lang.String jid)

toString

public static java.lang.String toString(TaskId tid)

toTaskID

public static TaskId toTaskID(java.lang.String tid)

toString

public static java.lang.String toString(TaskAttemptId taid)

toTaskAttemptID

public static TaskAttemptId toTaskAttemptID(java.lang.String taid)

taskSymbol

public static java.lang.String taskSymbol(TaskType type)

taskType

public static TaskType taskType(java.lang.String symbol)

taskAttemptState

public static MRApps.TaskAttemptStateUI taskAttemptState(java.lang.String attemptStateStr)

taskState

public static MRApps.TaskStateUI taskState(java.lang.String taskStateStr)

setClasspath

public static void setClasspath(java.util.Map<java.lang.String,java.lang.String> environment,
                                org.apache.hadoop.conf.Configuration conf)
                         throws java.io.IOException

Throws:

java.io.IOException

setJobClassLoader

public static void setJobClassLoader(org.apache.hadoop.conf.Configuration conf)
                              throws java.io.IOException

Creates and sets a ApplicationClassLoader on the given configuration and as the thread context classloader, if MRJobConfig.MAPREDUCE_JOB_CLASSLOADER is set to true, and the APP_CLASSPATH environment variable is set.

Parameters:

conf -

Throws:

java.io.IOException

createJobClassLoader

public static java.lang.ClassLoader createJobClassLoader(org.apache.hadoop.conf.Configuration conf)
                                                  throws java.io.IOException

Creates a ApplicationClassLoader if MRJobConfig.MAPREDUCE_JOB_CLASSLOADER is set to true, and the APP_CLASSPATH environment variable is set.

Parameters:

conf -

Returns:

the created job classloader, or null if the job classloader is not enabled or the APP_CLASSPATH environment variable is not set

Throws:

java.io.IOException

setClassLoader

public static void setClassLoader(java.lang.ClassLoader classLoader,
                                  org.apache.hadoop.conf.Configuration conf)

Sets the provided classloader on the given configuration and as the thread context classloader if the classloader is not null.

Parameters:

classLoader -

conf -

getStagingAreaDir

public static org.apache.hadoop.fs.Path getStagingAreaDir(org.apache.hadoop.conf.Configuration conf,
                                                          java.lang.String user)

getJobFile

public static java.lang.String getJobFile(org.apache.hadoop.conf.Configuration conf,
                                          java.lang.String user,
                                          org.apache.hadoop.mapreduce.JobID jobId)

getEndJobCommitSuccessFile

public static org.apache.hadoop.fs.Path getEndJobCommitSuccessFile(org.apache.hadoop.conf.Configuration conf,
                                                                   java.lang.String user,
                                                                   JobId jobId)

getEndJobCommitFailureFile

public static org.apache.hadoop.fs.Path getEndJobCommitFailureFile(org.apache.hadoop.conf.Configuration conf,
                                                                   java.lang.String user,
                                                                   JobId jobId)

getStartJobCommitFile

public static org.apache.hadoop.fs.Path getStartJobCommitFile(org.apache.hadoop.conf.Configuration conf,
                                                              java.lang.String user,
                                                              JobId jobId)

setupDistributedCache

public static void setupDistributedCache(org.apache.hadoop.conf.Configuration conf,
                                         java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.LocalResource> localResources)
                                  throws java.io.IOException

Throws:

java.io.IOException

setupDistributedCacheLocal

public static void setupDistributedCacheLocal(org.apache.hadoop.conf.Configuration conf)
                                       throws java.io.IOException

Set up the DistributedCache related configs to make JobContextImpl.getLocalCacheFiles(Configuration) and JobContextImpl.getLocalCacheArchives(Configuration) working.

Parameters:

conf -

Throws:

java.io.IOException

getChildLogLevel

public static java.lang.String getChildLogLevel(org.apache.hadoop.conf.Configuration conf,
                                                boolean isMap)

addLog4jSystemProperties

public static void addLog4jSystemProperties(org.apache.hadoop.mapred.Task task,
                                            java.util.List<java.lang.String> vargs,
                                            org.apache.hadoop.conf.Configuration conf)

Add the JVM system properties necessary to configure ContainerLogAppender or ContainerRollingLogAppender.

Parameters:

task - for map/reduce, or null for app master

vargs - the argument list to append to

conf - configuration of MR job

getSystemPropertiesToLog

public static java.lang.String getSystemPropertiesToLog(org.apache.hadoop.conf.Configuration conf)

Return lines for system property keys and values per configuration.

Returns:

the formatted string for the system property lines or null if no properties are specified.

setEnvFromInputString

public static void setEnvFromInputString(java.util.Map<java.lang.String,java.lang.String> env,
                                         java.lang.String envString,
                                         org.apache.hadoop.conf.Configuration conf)

setEnvFromInputProperty

public static void setEnvFromInputProperty(java.util.Map<java.lang.String,java.lang.String> env,
                                           java.lang.String propName,
                                           java.lang.String defaultPropValue,
                                           org.apache.hadoop.conf.Configuration conf)

addToEnvironment

@Public
@Unstable
public static void addToEnvironment(java.util.Map<java.lang.String,java.lang.String> environment,
                                    java.lang.String variable,
                                    java.lang.String value,
                                    org.apache.hadoop.conf.Configuration conf)

crossPlatformifyMREnv

public static java.lang.String crossPlatformifyMREnv(org.apache.hadoop.conf.Configuration conf,
                                                     org.apache.hadoop.yarn.api.ApplicationConstants.Environment env)