org.apache.samza.autoscaling.utils

Class YarnUtil

java.lang.Object

org.apache.samza.autoscaling.utils.YarnUtil

public class YarnUtil
extends java.lang.Object

This is a helper class to interact with yarn. Some of the functionalities it provides are killing an application, getting the state of an application, getting an application id given the job name and job id.

Constructor Summary

Constructors

Constructor and Description
YarnUtil(java.lang.String rmAddress, int rmPort)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApplicationState(java.lang.String applicationId) This function returns the state of a given application.
java.lang.String	getRunningAppId(java.lang.String jobName, int jobID) Queries rm for all the applications currently running and finds the application with the matching job name and id
void	killApplication(java.lang.String applicationId) This function kills an application given the applicationId
void	stop() This function stops the YarnUtil by stopping the yarn client and http client.

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnUtil

public YarnUtil(java.lang.String rmAddress,
        int rmPort)

Method Detail

getRunningAppId

public java.lang.String getRunningAppId(java.lang.String jobName,
                               int jobID)

Queries rm for all the applications currently running and finds the application with the matching job name and id

Parameters:

jobName - the name of the job

jobID - the job id

Returns:

the application id of the job running in yarn. If application id is not found, it will return null.

getApplicationState

public java.lang.String getApplicationState(java.lang.String applicationId)
                                     throws java.io.IOException,
                                            org.apache.hadoop.yarn.exceptions.YarnException

This function returns the state of a given application. This state can be on of the {"NEW", "NEW_SAVING", "SUBMITTED", "ACCEPTED", "RUNNING", "FINISHED", "FAILED", "KILLED"}

Parameters:

applicationId - the application id of the application the state is being queried

Returns:

the state of the application which is one of the following values: {"NEW", "NEW_SAVING", "SUBMITTED", "ACCEPTED", "RUNNING", "FINISHED", "FAILED", "KILLED"}

Throws:

java.io.IOException - Throws IO exception

org.apache.hadoop.yarn.exceptions.YarnException - in case of errors or if YARN rejects the request due to access-control restrictions.

killApplication

public void killApplication(java.lang.String applicationId)
                     throws java.io.IOException,
                            org.apache.hadoop.yarn.exceptions.YarnException

This function kills an application given the applicationId

Parameters:

applicationId - the application Id of the job to be killed

Throws:

java.io.IOException - Throws IO exception

org.apache.hadoop.yarn.exceptions.YarnException - in case of errors or if YARN rejects the request due to access-control restrictions.

stop

public void stop()

This function stops the YarnUtil by stopping the yarn client and http client.