Package org.apache.hadoop.yarn.server.webapp

Class LogWebService

java.lang.Object

org.apache.hadoop.yarn.server.webapp.LogWebService

All Implemented Interfaces:

AppInfoProvider

public class LogWebService
extends java.lang.Object
implements AppInfoProvider

Support only ATSv2 client only.

Constructor Summary

Constructors

Constructor	Description
LogWebService()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.server.webapp.BasicAppInfo	getApp(javax.servlet.http.HttpServletRequest req, java.lang.String appId, java.lang.String clusterId)	Returns BasicAppInfo object that wraps the collected information about the application.
javax.ws.rs.core.Response	getContainerLogFile(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size, java.lang.String nmId, boolean redirectedFromNode, java.lang.String clusterId, boolean manualRedirection)	Returns the contents of a container's log file in plain text.
javax.ws.rs.core.Response	getContainerLogsInfo(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String nmId, boolean redirectedFromNode, java.lang.String clusterId, boolean manualRedirection)	Returns log file's name as well as current file size for a container.
protected org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity	getEntity(java.lang.String path, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> params)
javax.ws.rs.core.Response	getLogs(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String containerIdStr, java.lang.String filename, java.lang.String format, java.lang.String size, java.lang.String nmId, boolean redirectedFromNode, java.lang.String clusterId, boolean manualRedirection)
java.lang.String	getNodeHttpAddress(javax.servlet.http.HttpServletRequest req, java.lang.String appId, java.lang.String appAttemptId, java.lang.String containerId, java.lang.String clusterId)	Returns the node HTTP address.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogWebService

public LogWebService()

Method Detail

getContainerLogsInfo

public javax.ws.rs.core.Response getContainerLogsInfo(@Context
                                                      javax.servlet.http.HttpServletRequest req,
                                                      @Context
                                                      javax.servlet.http.HttpServletResponse res,
                                                      java.lang.String containerIdStr,
                                                      java.lang.String nmId,
                                                      boolean redirectedFromNode,
                                                      java.lang.String clusterId,
                                                      boolean manualRedirection)

Returns log file's name as well as current file size for a container.

Parameters:

req - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

nmId - The Node Manager NodeId

redirectedFromNode - Whether this is a redirected request from NM

clusterId - clusterId the id of the cluster

manualRedirection - whether to return a response with a Location instead of an automatic redirection

Returns:

The log file's name and current file size

getNodeHttpAddress

public java.lang.String getNodeHttpAddress(javax.servlet.http.HttpServletRequest req,
                                           java.lang.String appId,
                                           java.lang.String appAttemptId,
                                           java.lang.String containerId,
                                           java.lang.String clusterId)

Description copied from interface: AppInfoProvider

Returns the node HTTP address.

Specified by:

getNodeHttpAddress in interface AppInfoProvider

Parameters:

req - HttpServletRequest associated with the request

appId - the id of the application

appAttemptId - the id of the application attempt

containerId - the container id

clusterId - the id of the cluster

Returns:

the node HTTP address

getApp

public org.apache.hadoop.yarn.server.webapp.BasicAppInfo getApp(javax.servlet.http.HttpServletRequest req,
                                                                java.lang.String appId,
                                                                java.lang.String clusterId)

Description copied from interface: AppInfoProvider

Returns BasicAppInfo object that wraps the collected information about the application.

Specified by:

getApp in interface AppInfoProvider

Parameters:

req - HttpServletRequest associated with the request

appId - the id of the application

clusterId - the id of the cluster

Returns:

BasicAppInfo object

getContainerLogFile

@Public
@Unstable
public javax.ws.rs.core.Response getContainerLogFile(@Context
                                                     javax.servlet.http.HttpServletRequest req,
                                                     @Context
                                                     javax.servlet.http.HttpServletResponse res,
                                                     java.lang.String containerIdStr,
                                                     java.lang.String filename,
                                                     java.lang.String format,
                                                     java.lang.String size,
                                                     java.lang.String nmId,
                                                     boolean redirectedFromNode,
                                                     java.lang.String clusterId,
                                                     boolean manualRedirection)

Returns the contents of a container's log file in plain text.

Parameters:

req - HttpServletRequest

res - HttpServletResponse

containerIdStr - The container ID

filename - The name of the log file

format - The content type

size - the size of the log file

nmId - The Node Manager NodeId

redirectedFromNode - Whether this is the redirect request from NM

clusterId - the id of the cluster

manualRedirection - whether to return a response with a Location instead of an automatic redirection

Returns:

The contents of the container's log file

getLogs

@Public
@Unstable
public javax.ws.rs.core.Response getLogs(@Context
                                         javax.servlet.http.HttpServletRequest req,
                                         @Context
                                         javax.servlet.http.HttpServletResponse res,
                                         java.lang.String containerIdStr,
                                         java.lang.String filename,
                                         java.lang.String format,
                                         java.lang.String size,
                                         java.lang.String nmId,
                                         boolean redirectedFromNode,
                                         java.lang.String clusterId,
                                         boolean manualRedirection)

getEntity

@VisibleForTesting
protected org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity getEntity(java.lang.String path,
                                                                                      javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> params)
                                                                               throws java.io.IOException

Throws:

java.io.IOException