Package org.apache.hadoop.yarn.server.router

Class RouterAuditLogger

java.lang.Object
org.apache.hadoop.yarn.server.router.RouterAuditLogger
public final class RouterAuditLogger extends Object
Manages Router audit logs. Audit log format is written as key=value pairs. Tab separated.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RouterAuditLogger.AuditConstants
     

  • Method Summary

    Modifier and Type
    Method
    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 descriptionFormat, Object... args)
    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.server.federation.store.records.SubClusterId subClusterId)
    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.server.federation.store.records.SubClusterId subClusterId)
    Create a readable and parsable audit log string for a failed event.
    static void
    logSuccess(String user, String operation, String target)
     
    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.server.federation.store.records.SubClusterId subClusterId)
    Create a 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

  • Method Details

    • logSuccess

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

    • 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 Router
      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 RouterAuditLogger 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.server.federation.store.records.SubClusterId subClusterId)
      Create a readable and parseable audit log string for a successful event.
      Parameters:
      user - User who made the service request to the Router
      operation - Operation requested by the user.
      target - The target on which the operation is being performed.
      appId - Application Id in which operation was performed.
      subClusterId - Subcluster Id in which operation is performed.

      Note that the RouterAuditLogger 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 RouterAuditLogger 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 descriptionFormat, Object... 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.
      descriptionFormat - the description message format string.
      args - format parameter.

      Note that the RouterAuditLogger 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)
      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.

      Note that the RouterAuditLogger 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.server.federation.store.records.SubClusterId subClusterId)
      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.
      subClusterId - SubCluster Id in which operation was performed.

      Note that the RouterAuditLogger 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.server.federation.store.records.SubClusterId subClusterId)
      Create a readable and parsable 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.
      subClusterId - SubCluster Id in which operation was performed.