Package org.apache.hadoop.tools.dynamometer.workloadgenerator.audit

Class AuditLogDirectParser

java.lang.Object

org.apache.hadoop.tools.dynamometer.workloadgenerator.audit.AuditLogDirectParser

All Implemented Interfaces:

AuditCommandParser

public class AuditLogDirectParser
extends java.lang.Object
implements AuditCommandParser

This AuditCommandParser is used to read commands from an audit log in the original format audit logs are produced in with a standard configuration. It requires setting the "auditreplay.log-start-time.ms" configuration to specify what the start time of the audit log was to determine when events occurred relative to this start time.

By default, this assumes that the audit log is in the default log format set up by Hadoop, like:

   1970-01-01 00:00:00,000 INFO FSNamesystem.audit: allowed=true ...
 

You can adjust this parsing behavior using the various configurations available.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AUDIT_LOG_DATE_FORMAT_DEFAULT
static java.lang.String	AUDIT_LOG_DATE_FORMAT_KEY	The format string used to parse the date which is present in the audit log.
static java.lang.String	AUDIT_LOG_DATE_TIME_ZONE_DEFAULT
static java.lang.String	AUDIT_LOG_DATE_TIME_ZONE_KEY	The time zone to use when parsing the audit log timestamp.
static java.lang.String	AUDIT_LOG_PARSE_REGEX_DEFAULT
static java.lang.String	AUDIT_LOG_PARSE_REGEX_KEY	The regex to use when parsing the audit log lines.
static java.lang.String	AUDIT_START_TIMESTAMP_KEY	See class Javadoc for more detail.

Constructor Summary

Constructors

Constructor	Description
AuditLogDirectParser()

Method Summary

Modifier and Type	Method	Description
void	initialize(org.apache.hadoop.conf.Configuration conf)	Initialize this parser with the given configuration.
org.apache.hadoop.tools.dynamometer.workloadgenerator.audit.AuditReplayCommand	parse(org.apache.hadoop.io.Text inputLine, java.util.function.Function<java.lang.Long,java.lang.Long> relativeToAbsolute)	Convert a line of input into an AuditReplayCommand.

Methods inherited from class java.lang.Object

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

Field Detail

AUDIT_START_TIMESTAMP_KEY

public static final java.lang.String AUDIT_START_TIMESTAMP_KEY

See class Javadoc for more detail.

See Also:

Constant Field Values

AUDIT_LOG_DATE_FORMAT_KEY

public static final java.lang.String AUDIT_LOG_DATE_FORMAT_KEY

The format string used to parse the date which is present in the audit log. This must be a format understood by SimpleDateFormat.

See Also:

Constant Field Values

AUDIT_LOG_DATE_FORMAT_DEFAULT

public static final java.lang.String AUDIT_LOG_DATE_FORMAT_DEFAULT

See Also:

Constant Field Values

AUDIT_LOG_DATE_TIME_ZONE_KEY

public static final java.lang.String AUDIT_LOG_DATE_TIME_ZONE_KEY

The time zone to use when parsing the audit log timestamp. This must be a format recognized by TimeZone.getTimeZone(String).

See Also:

Constant Field Values

AUDIT_LOG_DATE_TIME_ZONE_DEFAULT

public static final java.lang.String AUDIT_LOG_DATE_TIME_ZONE_DEFAULT

See Also:

Constant Field Values

AUDIT_LOG_PARSE_REGEX_KEY

public static final java.lang.String AUDIT_LOG_PARSE_REGEX_KEY

The regex to use when parsing the audit log lines. This should match against a single log line, and create two named capture groups. One must be titled "timestamp" and return a timestamp which can be parsed by a date formatter. The other must be titled "message" and return the audit content, such as "allowed=true ugi=user ...". See AUDIT_LOG_PARSE_REGEX_DEFAULT for an example.

See Also:

Constant Field Values

AUDIT_LOG_PARSE_REGEX_DEFAULT

public static final java.lang.String AUDIT_LOG_PARSE_REGEX_DEFAULT

See Also:

Constant Field Values

Constructor Detail

AuditLogDirectParser

public AuditLogDirectParser()

Method Detail

initialize

public void initialize(org.apache.hadoop.conf.Configuration conf)
                throws java.io.IOException

Description copied from interface: AuditCommandParser

Initialize this parser with the given configuration. Guaranteed to be called prior to any calls to AuditCommandParser.parse(Text, Function).

Specified by:

initialize in interface AuditCommandParser

Parameters:

conf - The Configuration to be used to set up this parser.

Throws:

java.io.IOException - if error on initializing a parser.

parse

public org.apache.hadoop.tools.dynamometer.workloadgenerator.audit.AuditReplayCommand parse(org.apache.hadoop.io.Text inputLine,
                                                                                            java.util.function.Function<java.lang.Long,java.lang.Long> relativeToAbsolute)
                                                                                     throws java.io.IOException

Description copied from interface: AuditCommandParser

Convert a line of input into an AuditReplayCommand. Since AuditReplayCommands store absolute timestamps, relativeToAbsolute can be used to convert relative timestamps (i.e., milliseconds elapsed between the start of the audit log and this command) into absolute timestamps.

Specified by:

parse in interface AuditCommandParser

Parameters:

inputLine - Single input line to convert.

relativeToAbsolute - Function converting relative timestamps (in milliseconds) to absolute timestamps (in milliseconds).

Returns:

A command representing the input line.

Throws:

java.io.IOException - if error on parsing.