Apache
/
hadoop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

YARN-5470. Addedum to differentiate exactly matching of log-files with regex in yarn log CLI. Contributed by Xuan Gong. 

(cherry picked from commit 83a2ffec40)
This commit is contained in:
Vinod Kumar Vavilapalli (I am also known as @tshooter.) 2016-08-08 14:28:07 -07:00
parent 2dbe16c024
commit 31bb302c91
2 changed files with 122 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/main/java/org/apache/hadoop/yarn/client/cli/LogsCLI.java
View File

@ -84,6 +84,8 @@ public class LogsCLI extends Configured implements Tool {
private static final String APP_OWNER_OPTION = "appOwner"; private static final String APP_OWNER_OPTION = "appOwner";
private static final String AM_CONTAINER_OPTION = "am"; private static final String AM_CONTAINER_OPTION = "am";
private static final String PER_CONTAINER_LOG_FILES_OPTION = "log_files"; private static final String PER_CONTAINER_LOG_FILES_OPTION = "log_files";
private static final String PER_CONTAINER_LOG_FILES_REGEX_OPTION
= "log_files_pattern";
private static final String LIST_NODES_OPTION = "list_nodes"; private static final String LIST_NODES_OPTION = "list_nodes";
private static final String SHOW_APPLICATION_LOG_INFO private static final String SHOW_APPLICATION_LOG_INFO
= "show_application_log_info"; = "show_application_log_info";
@ -91,7 +93,6 @@ public class LogsCLI extends Configured implements Tool {
= "show_container_log_info"; = "show_container_log_info";
private static final String OUT_OPTION = "out"; private static final String OUT_OPTION = "out";
private static final String SIZE_OPTION = "size"; private static final String SIZE_OPTION = "size";
private static final String REGEX_OPTION = "regex";
public static final String HELP_CMD = "help"; public static final String HELP_CMD = "help";
private PrintStream outStream = System.out; private PrintStream outStream = System.out;
private YarnClient yarnClient = null; private YarnClient yarnClient = null;
@ -130,6 +131,7 @@ public class LogsCLI extends Configured implements Tool {
boolean showContainerLogInfo = false; boolean showContainerLogInfo = false;
boolean useRegex = false; boolean useRegex = false;
String[] logFiles = null; String[] logFiles = null;
String[] logFilesRegex = null;
List<String> amContainersList = new ArrayList<String>(); List<String> amContainersList = new ArrayList<String>();
String localDir = null; String localDir = null;
long bytes = Long.MAX_VALUE; long bytes = Long.MAX_VALUE;
@ -145,7 +147,6 @@ public class LogsCLI extends Configured implements Tool {
showApplicationLogInfo = commandLine.hasOption( showApplicationLogInfo = commandLine.hasOption(
SHOW_APPLICATION_LOG_INFO); SHOW_APPLICATION_LOG_INFO);
showContainerLogInfo = commandLine.hasOption(SHOW_CONTAINER_LOG_INFO); showContainerLogInfo = commandLine.hasOption(SHOW_CONTAINER_LOG_INFO);
useRegex = commandLine.hasOption(REGEX_OPTION);
if (getAMContainerLogs) { if (getAMContainerLogs) {
try { try {
amContainersList = parseAMContainer(commandLine, printOpts); amContainersList = parseAMContainer(commandLine, printOpts);
@ -157,6 +158,11 @@ public class LogsCLI extends Configured implements Tool {
if (commandLine.hasOption(PER_CONTAINER_LOG_FILES_OPTION)) { if (commandLine.hasOption(PER_CONTAINER_LOG_FILES_OPTION)) {
logFiles = commandLine.getOptionValues(PER_CONTAINER_LOG_FILES_OPTION); logFiles = commandLine.getOptionValues(PER_CONTAINER_LOG_FILES_OPTION);
} }
if (commandLine.hasOption(PER_CONTAINER_LOG_FILES_REGEX_OPTION)) {
logFilesRegex = commandLine.getOptionValues(
PER_CONTAINER_LOG_FILES_REGEX_OPTION);
useRegex = true;
}
if (commandLine.hasOption(SIZE_OPTION)) { if (commandLine.hasOption(SIZE_OPTION)) {
bytes = Long.parseLong(commandLine.getOptionValue(SIZE_OPTION)); bytes = Long.parseLong(commandLine.getOptionValue(SIZE_OPTION));
} }
@ -206,6 +212,12 @@ public class LogsCLI extends Configured implements Tool {
return -1; return -1;
} }
if (logFiles != null && logFiles.length > 0 && logFilesRegex != null
&& logFilesRegex.length > 0) {
System.err.println("Invalid options. Can only accept one of "
+ "log_files/log_files_pattern.");
return -1;
}
if (localDir != null) { if (localDir != null) {
File file = new File(localDir); File file = new File(localDir);
if (file.exists() && file.isFile()) { if (file.exists() && file.isFile()) {
@ -248,10 +260,12 @@ public class LogsCLI extends Configured implements Tool {
} }
Set<String> logs = new HashSet<String>(); Set<String> logs = new HashSet<String>();
if (fetchAllLogFiles(logFiles, useRegex)) { if (fetchAllLogFiles(logFiles, logFilesRegex)) {
logs.add("ALL"); logs.add("ALL");
} else if (logFiles != null && logFiles.length > 0) { } else if (logFiles != null && logFiles.length > 0) {
logs.addAll(Arrays.asList(logFiles)); logs.addAll(Arrays.asList(logFiles));
} else if (logFilesRegex != null && logFilesRegex.length > 0) {
logs.addAll(Arrays.asList(logFilesRegex));
} }
ContainerLogsRequest request = new ContainerLogsRequest(appId, ContainerLogsRequest request = new ContainerLogsRequest(appId,
@ -366,18 +380,28 @@ public class LogsCLI extends Configured implements Tool {
return amContainersList; return amContainersList;
} }
private boolean fetchAllLogFiles(String[] logFiles, boolean useRegex) { private boolean fetchAllLogFiles(String[] logFiles, String[] logFilesRegex) {
// If no value is specified for the PER_CONTAINER_LOG_FILES_OPTION option, // If no value is specified for the PER_CONTAINER_LOG_FILES_OPTION option
// and PER_CONTAINER_LOG_FILES_REGEX_OPTION
// we will assume all logs. // we will assume all logs.
if (logFiles == null || logFiles.length == 0) { if ((logFiles == null || logFiles.length == 0) && (
logFilesRegex == null || logFilesRegex.length == 0)) {
return true; return true;
} }
List<String> logs = Arrays.asList(logFiles); if (logFiles != null && logFiles.length > 0) {
if (logs.contains("ALL") || logs.contains("*")|| List<String> logs = Arrays.asList(logFiles);
(logs.contains(".*") && useRegex)) { if (logs.contains("ALL") || logs.contains("*")) {
return true; return true;
}
}
if (logFilesRegex != null && logFilesRegex.length > 0) {
List<String> logsRegex = Arrays.asList(logFilesRegex);
if (logsRegex.contains(".*")) {
return true;
}
} }
return false; return false;
@ -754,15 +778,20 @@ public class LogsCLI extends Configured implements Tool {
opts.addOption(amOption); opts.addOption(amOption);
Option logFileOpt = new Option(PER_CONTAINER_LOG_FILES_OPTION, true, Option logFileOpt = new Option(PER_CONTAINER_LOG_FILES_OPTION, true,
"Specify comma-separated value " "Specify comma-separated value "
+ "to get exact matched log files. Use \"ALL\" or \"*\"to " + "to get exact matched log files. Use \"ALL\" or \"*\" to "
+ "fetch all the log files for the container. Specific -regex " + "fetch all the log files for the container.");
+ "for using java regex to find matched log files.");
logFileOpt.setValueSeparator(','); logFileOpt.setValueSeparator(',');
logFileOpt.setArgs(Option.UNLIMITED_VALUES); logFileOpt.setArgs(Option.UNLIMITED_VALUES);
logFileOpt.setArgName("Log File Name"); logFileOpt.setArgName("Log File Name");
opts.addOption(logFileOpt); opts.addOption(logFileOpt);
opts.addOption(REGEX_OPTION, false, "Work with -log_files to find " Option logFileRegexOpt = new Option(PER_CONTAINER_LOG_FILES_REGEX_OPTION,
+ "matched files by using java regex."); true, "Specify comma-separated value "
+ "to get matched log files by using java regex. Use \".*\" to "
+ "fetch all the log files for the container.");
logFileRegexOpt.setValueSeparator(',');
logFileRegexOpt.setArgs(Option.UNLIMITED_VALUES);
logFileRegexOpt.setArgName("Log File Pattern");
opts.addOption(logFileRegexOpt);
opts.addOption(SHOW_CONTAINER_LOG_INFO, false, opts.addOption(SHOW_CONTAINER_LOG_INFO, false,
"Show the container log metadata, " "Show the container log metadata, "
+ "including log-file names, the size of the log files. " + "including log-file names, the size of the log files. "
@ -805,7 +834,8 @@ public class LogsCLI extends Configured implements Tool {
printOpts.addOption(commandOpts.getOption(SHOW_CONTAINER_LOG_INFO)); printOpts.addOption(commandOpts.getOption(SHOW_CONTAINER_LOG_INFO));
printOpts.addOption(commandOpts.getOption(OUT_OPTION)); printOpts.addOption(commandOpts.getOption(OUT_OPTION));
printOpts.addOption(commandOpts.getOption(SIZE_OPTION)); printOpts.addOption(commandOpts.getOption(SIZE_OPTION));
printOpts.addOption(commandOpts.getOption(REGEX_OPTION)); printOpts.addOption(commandOpts.getOption(
PER_CONTAINER_LOG_FILES_REGEX_OPTION));
return printOpts; return printOpts;
} }

129
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-client/src/test/java/org/apache/hadoop/yarn/client/cli/TestLogsCLI.java
View File

@ -189,57 +189,70 @@ public class TestLogsCLI {
pw.println("usage: yarn logs -applicationId <application ID> [OPTIONS]"); pw.println("usage: yarn logs -applicationId <application ID> [OPTIONS]");
pw.println(); pw.println();
pw.println("general options are:"); pw.println("general options are:");
pw.println(" -am <AM Containers> Prints the AM Container logs for this"); pw.println(" -am <AM Containers> Prints the AM Container logs for");
pw.println(" application. Specify comma-separated"); pw.println(" this application. Specify");
pw.println(" value to get logs for related AM"); pw.println(" comma-separated value to get logs");
pw.println(" Container. For example, If we specify -am"); pw.println(" for related AM Container. For");
pw.println(" 1,2, we will get the logs for the first"); pw.println(" example, If we specify -am 1,2,");
pw.println(" AM Container as well as the second AM"); pw.println(" we will get the logs for the");
pw.println(" Container. To get logs for all AM"); pw.println(" first AM Container as well as the");
pw.println(" Containers, use -am ALL. To get logs for"); pw.println(" second AM Container. To get logs");
pw.println(" the latest AM Container, use -am -1. By"); pw.println(" for all AM Containers, use -am");
pw.println(" default, it will print all available"); pw.println(" ALL. To get logs for the latest");
pw.println(" logs. Work with -log_files to get only"); pw.println(" AM Container, use -am -1. By");
pw.println(" specific logs."); pw.println(" default, it will print all");
pw.println(" -appOwner <Application Owner> AppOwner (assumed to be current user if"); pw.println(" available logs. Work with");
pw.println(" not specified)"); pw.println(" -log_files to get only specific");
pw.println(" -containerId <Container ID> ContainerId. By default, it will print"); pw.println(" logs.");
pw.println(" all available logs. Work with -log_files"); pw.println(" -appOwner <Application Owner> AppOwner (assumed to be current");
pw.println(" to get only specific logs. If specified,"); pw.println(" user if not specified)");
pw.println(" the applicationId can be omitted"); pw.println(" -containerId <Container ID> ContainerId. By default, it will");
pw.println(" -help Displays help for all commands."); pw.println(" print all available logs. Work");
pw.println(" -list_nodes Show the list of nodes that successfully"); pw.println(" with -log_files to get only");
pw.println(" aggregated logs. This option can only be"); pw.println(" specific logs. If specified, the");
pw.println(" used with finished applications."); pw.println(" applicationId can be omitted");
pw.println(" -log_files <Log File Name> Specify comma-separated value to get"); pw.println(" -help Displays help for all commands.");
pw.println(" exact matched log files. Use \"ALL\" or"); pw.println(" -list_nodes Show the list of nodes that");
pw.println(" \"*\"to fetch all the log files for the"); pw.println(" successfully aggregated logs.");
pw.println(" container. Specific -regex for using java"); pw.println(" This option can only be used with");
pw.println(" regex to find matched log files."); pw.println(" finished applications.");
pw.println(" -nodeAddress <Node Address> NodeAddress in the format nodename:port"); pw.println(" -log_files <Log File Name> Specify comma-separated value to");
pw.println(" -out <Local Directory> Local directory for storing individual"); pw.println(" get exact matched log files. Use");
pw.println(" container logs. The container logs will"); pw.println(" \"ALL\" or \"*\" to fetch all the log");
pw.println(" be stored based on the node the container"); pw.println(" files for the container.");
pw.println(" ran on."); pw.println(" -log_files_pattern <Log File Pattern> Specify comma-separated value to");
pw.println(" -regex Work with -log_files to find matched"); pw.println(" get matched log files by using");
pw.println(" files by using java regex."); pw.println(" java regex. Use \".*\" to fetch all");
pw.println(" -show_application_log_info Show the containerIds which belong to the"); pw.println(" the log files for the container.");
pw.println(" specific Application. You can combine"); pw.println(" -nodeAddress <Node Address> NodeAddress in the format");
pw.println(" this with --nodeAddress to get"); pw.println(" nodename:port");
pw.println(" containerIds for all the containers on"); pw.println(" -out <Local Directory> Local directory for storing");
pw.println(" the specific NodeManager."); pw.println(" individual container logs. The");
pw.println(" -show_container_log_info Show the container log metadata,"); pw.println(" container logs will be stored");
pw.println(" including log-file names, the size of the"); pw.println(" based on the node the container");
pw.println(" log files. You can combine this with"); pw.println(" ran on.");
pw.println(" --containerId to get log metadata for the"); pw.println(" -show_application_log_info Show the containerIds which");
pw.println(" specific container, or with --nodeAddress"); pw.println(" belong to the specific");
pw.println(" to get log metadata for all the"); pw.println(" Application. You can combine this");
pw.println(" containers on the specific NodeManager."); pw.println(" with --nodeAddress to get");
pw.println(" -size <size> Prints the log file's first 'n' bytes or"); pw.println(" containerIds for all the");
pw.println(" the last 'n' bytes. Use negative values"); pw.println(" containers on the specific");
pw.println(" as bytes to read from the end and"); pw.println(" NodeManager.");
pw.println(" positive values as bytes to read from the"); pw.println(" -show_container_log_info Show the container log metadata,");
pw.println(" beginning."); pw.println(" including log-file names, the");
pw.println(" size of the log files. You can");
pw.println(" combine this with --containerId");
pw.println(" to get log metadata for the");
pw.println(" specific container, or with");
pw.println(" --nodeAddress to get log metadata");
pw.println(" for all the containers on the");
pw.println(" specific NodeManager.");
pw.println(" -size <size> Prints the log file's first 'n'");
pw.println(" bytes or the last 'n' bytes. Use");
pw.println(" negative values as bytes to read");
pw.println(" from the end and positive values");
pw.println(" as bytes to read from the");
pw.println(" beginning.");
pw.close(); pw.close();
String appReportStr = baos.toString("UTF-8"); String appReportStr = baos.toString("UTF-8");
Assert.assertEquals(appReportStr, sysOutStream.toString()); Assert.assertEquals(appReportStr, sysOutStream.toString());
@ -346,7 +359,7 @@ public class TestLogsCLI {
sysOutStream.reset(); sysOutStream.reset();
exitCode = cli.run(new String[] {"-applicationId", appId.toString(), exitCode = cli.run(new String[] {"-applicationId", appId.toString(),
"-log_files", ".*", "-regex"}); "-log_files_pattern", ".*"});
assertTrue(exitCode == 0); assertTrue(exitCode == 0);
assertTrue(sysOutStream.toString().contains( assertTrue(sysOutStream.toString().contains(
logMessage(containerId1, "syslog"))); logMessage(containerId1, "syslog")));
@ -392,7 +405,7 @@ public class TestLogsCLI {
sysOutStream.reset(); sysOutStream.reset();
exitCode = cli.run(new String[] {"-applicationId", appId.toString(), exitCode = cli.run(new String[] {"-applicationId", appId.toString(),
"-log_files", "std*", "-regex"}); "-log_files_pattern", "std*"});
assertTrue(exitCode == 0); assertTrue(exitCode == 0);
assertFalse(sysOutStream.toString().contains( assertFalse(sysOutStream.toString().contains(
logMessage(containerId1, "syslog"))); logMessage(containerId1, "syslog")));
@ -809,6 +822,16 @@ public class TestLogsCLI {
+ "show_container_log_info.")); + "show_container_log_info."));
sysErrStream.reset(); sysErrStream.reset();
// Specify log_files and log_files_pattern
// at the same time
exitCode = cli.run(new String[] {"-applicationId", appId.toString(),
"-log_files", "*", "-log_files_pattern", ".*"});
assertTrue(exitCode == -1);
assertTrue(sysErrStream.toString().contains("Invalid options. "
+ "Can only accept one of log_files/"
+ "log_files_pattern."));
sysErrStream.reset();
// Specify a file name to the option -out // Specify a file name to the option -out
try { try {
fs.mkdirs(localPath); fs.mkdirs(localPath);