org.apache.hadoop.yarn.server.resourcemanager

Class RMAuditLogger

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.RMAuditLogger

public class RMAuditLogger
extends Object

Manages ResourceManager audit logs. Audit log format is written as key=value pairs. Tab separated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RMAuditLogger.ArgsBuilder Builder to create and pass a list of arbitrary key value pairs for logging.
static class	RMAuditLogger.AuditConstants

Constructor Summary

Constructors

Constructor and Description
RMAuditLogger()

Method Summary

Modifier and Type	Method and Description
static void	logFailure(String user, String operation, String perm, String target, String description) Create a readable and parseable audit log string for a failed event.
static void	logFailure(String user, String operation, String perm, String target, String description, org.apache.hadoop.yarn.api.records.ApplicationId appId) Create a readable and parseable audit log string for a failed event.
static void	logFailure(String user, String operation, String perm, String target, String description, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId) Create a readable and parseable audit log string for a failed event.
static void	logFailure(String user, String operation, String perm, String target, String description, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.ipc.CallerContext callerContext)
static void	logFailure(String user, String operation, String perm, String target, String description, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.Resource resource) Create a readable and parseable audit log string for a failed event.
static void	logFailure(String user, String operation, String perm, String target, String description, RMAuditLogger.ArgsBuilder args) Create a readable and parseable audit log string for a failed event.
static void	logSuccess(String user, String operation, String target) Create a readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, org.apache.hadoop.yarn.api.records.ApplicationId appId) Create a readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId) Create a readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.ipc.CallerContext callerContext)
static void	logSuccess(String user, String operation, String target, org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.Resource resource) Create a readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, org.apache.hadoop.yarn.api.records.ApplicationId appId, InetAddress ip) Create a readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, InetAddress ip, RMAuditLogger.ArgsBuilder args) Create a general readable and parseable audit log string for a successful event.
static void	logSuccess(String user, String operation, String target, RMAuditLogger.ArgsBuilder args) Create a general readable and parseable audit log string for a successful event.

Methods inherited from class java.lang.Object

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

Constructor Detail

RMAuditLogger

public RMAuditLogger()

Method Detail

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.yarn.api.records.ContainerId containerId,
                              org.apache.hadoop.yarn.api.records.Resource resource)

Create a readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager

operation - Operation requested by the user.

target - The target on which the operation is being performed.

appId - Application Id in which operation was performed.

containerId - Container Id in which operation was performed.

resource - Resource associated with container.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              RMAuditLogger.ArgsBuilder args)

Create a general readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

args - The ArgsBuilder arguments for the operation request.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').
This method will attempt to retrieve the remote IP

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              InetAddress ip,
                              RMAuditLogger.ArgsBuilder args)

Create a general readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

ip - The ip address of the caller.

args - The ArgsBuilder arguments for the operation request.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)

Create a readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

appId - Application Id in which operation was performed.

attemptId - Application Attempt Id in which operation was performed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.ipc.CallerContext callerContext)

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              InetAddress ip)

Create a readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

appId - Application Id in which operation was performed.

ip - The ip address of the caller.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId)

Create a readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request to the ResourceManager.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

appId - Application Id in which operation was performed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logSuccess

public static void logSuccess(String user,
                              String operation,
                              String target)

Create a readable and parseable audit log string for a successful event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

target - The target on which the operation is being performed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.yarn.api.records.ContainerId containerId,
                              org.apache.hadoop.yarn.api.records.Resource resource)

Create a readable and parseable audit log string for a failed event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

perm - Target permissions.

target - The target on which the operation is being performed.

description - Some additional information as to why the operation failed.

appId - Application Id in which operation was performed.

containerId - Container Id in which operation was performed.

resource - Resources associated with container.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)

Create a readable and parseable audit log string for a failed event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

perm - Target permissions.

target - The target on which the operation is being performed.

description - Some additional information as to why the operation failed.

appId - ApplicationId in which operation was performed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId,
                              org.apache.hadoop.ipc.CallerContext callerContext)

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description,
                              org.apache.hadoop.yarn.api.records.ApplicationId appId)

Create a readable and parseable audit log string for a failed event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

perm - Target permissions.

target - The target on which the operation is being performed.

description - Some additional information as to why the operation failed.

appId - ApplicationId in which operation was performed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description)

Create a readable and parseable audit log string for a failed event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

perm - Target permissions.

target - The target on which the operation is being performed.

description - Some additional information as to why the operation failed.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').

logFailure

public static void logFailure(String user,
                              String operation,
                              String perm,
                              String target,
                              String description,
                              RMAuditLogger.ArgsBuilder args)

Create a readable and parseable audit log string for a failed event.

Parameters:

user - User who made the service request.

operation - Operation requested by the user.

perm - Target permissions.

target - The target on which the operation is being performed.

description - The failure description

args - The arguments for the operation request.

Note that the RMAuditLogger uses tabs ('\t') as a key-val delimiter and hence the value fields should not contains tabs ('\t').