alluxio.cli.bundler.command

Class CollectLogCommand

java.lang.Object

alluxio.cli.bundler.command.AbstractCollectInfoCommand

alluxio.cli.bundler.command.CollectLogCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

public class CollectLogCommand
extends AbstractCollectInfoCommand

Command to collect Alluxio logs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDITIONAL_OPTION_NAME
static String	COMMAND_NAME
static String	EXCLUDE_OPTION_NAME
static Set<String>	FILE_NAMES_PREFIXES
static String	INCLUDE_OPTION_NAME
static org.apache.commons.cli.Options	OPTIONS

Fields inherited from class alluxio.cli.bundler.command.AbstractCollectInfoCommand

mFsContext, mWorkingDirPath

Constructor Summary

Constructors

Constructor and Description
CollectLogCommand(FileSystemContext fsContext) Creates a new instance of CollectLogCommand.

Method Summary

Modifier and Type	Method and Description
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
String	getUsage()
boolean	hasSubCommand() If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.
static java.time.LocalDateTime	inferFileStartTime(File f) Infer the starting time of a log file by parsing the log entries from the beginning.
static java.time.LocalDateTime	parseDateTime(String s) Identifies the datetime from a certain piece of log by trying various known patterns.
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.

Methods inherited from class alluxio.cli.bundler.command.AbstractCollectInfoCommand

generateOutputFile, getWorkingDirectory, validateArgs

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getOptions, getSubCommands, parseAndValidateArgs

Field Detail

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

Constant Field Values

FILE_NAMES_PREFIXES

public static final Set<String> FILE_NAMES_PREFIXES

INCLUDE_OPTION_NAME

public static final String INCLUDE_OPTION_NAME

See Also:

Constant Field Values

EXCLUDE_OPTION_NAME

public static final String EXCLUDE_OPTION_NAME

See Also:

Constant Field Values

ADDITIONAL_OPTION_NAME

public static final String ADDITIONAL_OPTION_NAME

See Also:

Constant Field Values

OPTIONS

public static final org.apache.commons.cli.Options OPTIONS

Constructor Detail

CollectLogCommand

public CollectLogCommand(FileSystemContext fsContext)

Creates a new instance of CollectLogCommand.

Parameters:

fsContext - the FileSystemContext to execute in

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

hasSubCommand

public boolean hasSubCommand()

Description copied from interface: Command

If a command has sub-commands, the first argument should be the sub-command's name, all arguments and options will be parsed for the sub-command.

Returns:

whether this command has sub-commands

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

inferFileStartTime

public static java.time.LocalDateTime inferFileStartTime(File f)
                                                  throws FileNotFoundException

Infer the starting time of a log file by parsing the log entries from the beginning. It will try the first certain lines with various known datetime patterns.

Parameters:

f - log file

Returns:

the parsed datetime

Throws:

FileNotFoundException

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command

parseDateTime

@Nullable
public static java.time.LocalDateTime parseDateTime(String s)

Identifies the datetime from a certain piece of log by trying various known patterns. Returns null if unable to identify a datetime.

Parameters:

s - a log entry

Returns:

identified datetime