Package org.apache.hadoop.yarn.logaggregation

Class AggregatedLogFormat.LogReader

java.lang.Object

org.apache.hadoop.yarn.logaggregation.AggregatedLogFormat.LogReader

All Implemented Interfaces:

java.lang.AutoCloseable

Enclosing class:

AggregatedLogFormat

@Public
@Evolving
public static class AggregatedLogFormat.LogReader
extends java.lang.Object
implements java.lang.AutoCloseable

Constructor Summary

Constructors

Constructor	Description
LogReader(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path remoteAppLogFile)

Method Summary

Modifier and Type	Method	Description
void	close()
java.util.Map<org.apache.hadoop.yarn.api.records.ApplicationAccessType,java.lang.String>	getApplicationAcls()	Returns ACLs for the application.
java.lang.String	getApplicationOwner()	Returns the owner of the application.
AggregatedLogFormat.ContainerLogsReader	getContainerLogsReader(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Get a ContainerLogsReader to read the logs for the specified container.
java.io.DataInputStream	next(AggregatedLogFormat.LogKey key)	Read the next key and return the value-stream.
static void	readAcontainerLogs(java.io.DataInputStream valueStream, java.io.Writer writer)	Writes all logs for a single container to the provided writer.
static void	readAcontainerLogs(java.io.DataInputStream valueStream, java.io.Writer writer, long logUploadedTime)	Writes all logs for a single container to the provided writer.
static void	readAContainerLogsForALogType(java.io.DataInputStream valueStream, java.io.PrintStream out)	Keep calling this till you get a EOFException for getting logs of all types for a single container.
static void	readAContainerLogsForALogType(java.io.DataInputStream valueStream, java.io.PrintStream out, long logUploadedTime)	Keep calling this till you get a EOFException for getting logs of all types for a single container.
static void	readAContainerLogsForALogType(java.io.DataInputStream valueStream, java.io.PrintStream out, long logUploadedTime, long bytes)	Keep calling this till you get a EOFException for getting logs of all types for a single container for the specific bytes.
static int	readContainerLogsForALogType(java.io.DataInputStream valueStream, java.io.PrintStream out, long logUploadedTime, java.util.List<java.lang.String> logType)	Keep calling this till you get a EOFException for getting logs of the specific types for a single container.
static int	readContainerLogsForALogType(java.io.DataInputStream valueStream, java.io.PrintStream out, long logUploadedTime, java.util.List<java.lang.String> logType, long bytes)	Keep calling this till you get a EOFException for getting logs of the specific types for a single container.
static org.apache.commons.math3.util.Pair<java.lang.String,java.lang.String>	readContainerMetaDataAndSkipData(java.io.DataInputStream valueStream)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogReader

public LogReader(org.apache.hadoop.conf.Configuration conf,
                 org.apache.hadoop.fs.Path remoteAppLogFile)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getApplicationOwner

public java.lang.String getApplicationOwner()
                                     throws java.io.IOException

Returns the owner of the application.

Returns:

the application owner.

Throws:

java.io.IOException - if we can not get the application owner.

getApplicationAcls

public java.util.Map<org.apache.hadoop.yarn.api.records.ApplicationAccessType,java.lang.String> getApplicationAcls()
                                                                                                                  throws java.io.IOException

Returns ACLs for the application. An empty map is returned if no ACLs are found.

Returns:

a map of the Application ACLs.

Throws:

java.io.IOException - if we can not get the application acls.

next

public java.io.DataInputStream next(AggregatedLogFormat.LogKey key)
                             throws java.io.IOException

Read the next key and return the value-stream.

Parameters:

key - the log key

Returns:

the valueStream if there are more keys or null otherwise

Throws:

java.io.IOException - if we can not get the dataInputStream for the next key

getContainerLogsReader

@Private
public AggregatedLogFormat.ContainerLogsReader getContainerLogsReader(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                                               throws java.io.IOException

Get a ContainerLogsReader to read the logs for the specified container.

Parameters:

containerId - the containerId

Returns:

object to read the container's logs or null if the logs could not be found

Throws:

java.io.IOException - if we can not get the container log reader.

readAcontainerLogs

public static void readAcontainerLogs(java.io.DataInputStream valueStream,
                                      java.io.Writer writer,
                                      long logUploadedTime)
                               throws java.io.IOException

Writes all logs for a single container to the provided writer.

Parameters:

valueStream - the valueStream

writer - the log writer

logUploadedTime - the time stamp

Throws:

java.io.IOException - if we can not read the container logs.

readAcontainerLogs

public static void readAcontainerLogs(java.io.DataInputStream valueStream,
                                      java.io.Writer writer)
                               throws java.io.IOException

Writes all logs for a single container to the provided writer.

Parameters:

valueStream - the value stream

writer - the log writer

Throws:

java.io.IOException - if we can not read the container logs.

readAContainerLogsForALogType

public static void readAContainerLogsForALogType(java.io.DataInputStream valueStream,
                                                 java.io.PrintStream out,
                                                 long logUploadedTime)
                                          throws java.io.IOException

Keep calling this till you get a EOFException for getting logs of all types for a single container.

Parameters:

valueStream - the value stream

out - the print stream

logUploadedTime - the time stamp

Throws:

java.io.IOException - if we can not read the container log by specifying the container log type.

readAContainerLogsForALogType

public static void readAContainerLogsForALogType(java.io.DataInputStream valueStream,
                                                 java.io.PrintStream out,
                                                 long logUploadedTime,
                                                 long bytes)
                                          throws java.io.IOException

Keep calling this till you get a EOFException for getting logs of all types for a single container for the specific bytes.

Parameters:

valueStream - the value stream

out - the output print stream

logUploadedTime - the log upload time stamp

bytes - the output size of the log

Throws:

java.io.IOException - if we can not read the container log

readAContainerLogsForALogType

public static void readAContainerLogsForALogType(java.io.DataInputStream valueStream,
                                                 java.io.PrintStream out)
                                          throws java.io.IOException

Keep calling this till you get a EOFException for getting logs of all types for a single container.

Parameters:

valueStream - the value stream

out - the output print stream

Throws:

java.io.IOException - if we can not read the container log

readContainerLogsForALogType

public static int readContainerLogsForALogType(java.io.DataInputStream valueStream,
                                               java.io.PrintStream out,
                                               long logUploadedTime,
                                               java.util.List<java.lang.String> logType)
                                        throws java.io.IOException

Keep calling this till you get a EOFException for getting logs of the specific types for a single container.

Parameters:

valueStream - the value stream

out - the output print stream

logUploadedTime - the log uploaded time stamp

logType - the given log type

Returns:

If logType contains fileType, return 1, otherwise return 0.

Throws:

java.io.IOException - if we can not read the container logs

readContainerLogsForALogType

public static int readContainerLogsForALogType(java.io.DataInputStream valueStream,
                                               java.io.PrintStream out,
                                               long logUploadedTime,
                                               java.util.List<java.lang.String> logType,
                                               long bytes)
                                        throws java.io.IOException

Keep calling this till you get a EOFException for getting logs of the specific types for a single container.

Parameters:

valueStream - the value stream

out - the output print stream

logUploadedTime - the log uploaded time stamp

logType - the given log type

bytes - log bytes.

Returns:

If logType contains fileType, return 1, otherwise return 0.

Throws:

java.io.IOException - if we can not read the container logs

readContainerMetaDataAndSkipData

@Private
public static org.apache.commons.math3.util.Pair<java.lang.String,java.lang.String> readContainerMetaDataAndSkipData(java.io.DataInputStream valueStream)
                                                                                                                    throws java.io.IOException

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable