You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by et...@apache.org on 2019/07/08 19:46:09 UTC
[storm] branch master updated: [STORM-3411] add
to file names when downloading log file
This is an automated email from the ASF dual-hosted git repository.
ethanli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git
The following commit(s) were added to refs/heads/master by this push:
new 4990c86 [STORM-3411] add <host><port><topology name> to file names when downloading log file
new 80b2384 Merge pull request #3030 from RuiLi8080/STORM-3411
4990c86 is described below
commit 4990c86285095f058a066b285ba74a4b2ffcc8cd
Author: ruili8080 <ru...@gmail.com>
AuthorDate: Thu Jun 20 10:24:55 2019 -0500
[STORM-3411] add <host><port><topology name> to file names when downloading log file
---
.../logviewer/handler/LogviewerLogDownloadHandler.java | 14 ++++++++------
.../daemon/logviewer/handler/LogviewerProfileHandler.java | 7 ++++---
.../storm/daemon/logviewer/utils/LogFileDownloader.java | 6 +++---
.../daemon/logviewer/utils/LogviewerResponseBuilder.java | 13 +++++++++++--
.../storm/daemon/logviewer/webapp/LogviewerResource.java | 13 ++++++++-----
.../logviewer/handler/LogviewerLogDownloadHandlerTest.java | 12 ++++++------
.../logviewer/handler/LogviewerProfileHandlerTest.java | 8 ++++----
7 files changed, 44 insertions(+), 29 deletions(-)
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
index bb5a3ae..f65b16c 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandler.java
@@ -49,26 +49,28 @@ public class LogviewerLogDownloadHandler {
/**
* Download an worker log.
*
+ * @param host host address
* @param fileName file to download
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link LogFileDownloader#downloadFile(String, String, boolean)}
+ * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)}
*/
- public Response downloadLogFile(String fileName, String user) throws IOException {
+ public Response downloadLogFile(String host, String fileName, String user) throws IOException {
workerLogs.setLogFilePermission(fileName);
- return logFileDownloadHelper.downloadFile(fileName, user, false);
+ return logFileDownloadHelper.downloadFile(host, fileName, user, false);
}
/**
* Download a daemon log.
*
+ * @param host host address
* @param fileName file to download
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link LogFileDownloader#downloadFile(String, String, boolean)}
+ * @see {@link LogFileDownloader#downloadFile(String, String, String, boolean)}
*/
- public Response downloadDaemonLogFile(String fileName, String user) throws IOException {
- return logFileDownloadHelper.downloadFile(fileName, user, true);
+ public Response downloadDaemonLogFile(String host, String fileName, String user) throws IOException {
+ return logFileDownloadHelper.downloadFile(host, fileName, user, true);
}
}
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
index 47c6ae3..58b883a 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandler.java
@@ -102,14 +102,15 @@ public class LogviewerProfileHandler {
/**
* Download a dump file.
*
+ * @param host host address
* @param topologyId topology ID
* @param hostPort host and port of worker
* @param fileName dump file name
* @param user username
* @return a Response which lets browsers download that file.
- * @see {@link org.apache.storm.daemon.logviewer.utils.LogFileDownloader#downloadFile(String, String, boolean)}
+ * @see {@link org.apache.storm.daemon.logviewer.utils.LogFileDownloader#downloadFile(String, String, String, boolean)}
*/
- public Response downloadDumpFile(String topologyId, String hostPort, String fileName, String user) throws IOException {
+ public Response downloadDumpFile(String host, String topologyId, String hostPort, String fileName, String user) throws IOException {
String portStr = hostPort.split(":")[1];
Path rawFile = logRoot.resolve(topologyId).resolve(portStr).resolve(fileName);
Path absFile = rawFile.toAbsolutePath().normalize();
@@ -121,7 +122,7 @@ public class LogviewerProfileHandler {
if (absFile.toFile().exists()) {
String workerFileRelativePath = String.join(File.separator, topologyId, portStr, WORKER_LOG_FILENAME);
if (resourceAuthorizer.isUserAllowedToAccessFile(user, workerFileRelativePath)) {
- return LogviewerResponseBuilder.buildDownloadFile(absFile.toFile(), numFileDownloadExceptions);
+ return LogviewerResponseBuilder.buildDownloadFile(host, absFile.toFile(), numFileDownloadExceptions);
} else {
return LogviewerResponseBuilder.buildResponseUnauthorizedUser(user);
}
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogFileDownloader.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogFileDownloader.java
index 5c3eea0..17eb10f 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogFileDownloader.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogFileDownloader.java
@@ -21,7 +21,6 @@ package org.apache.storm.daemon.logviewer.utils;
import com.codahale.metrics.Histogram;
import com.codahale.metrics.Meter;
-import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
@@ -59,12 +58,13 @@ public class LogFileDownloader {
/**
* Checks authorization for the log file and download.
*
+ * @param host host address
* @param fileName file to download
* @param user username
* @param isDaemon true if the file is a daemon log, false if the file is an worker log
* @return a Response which lets browsers download that file.
*/
- public Response downloadFile(String fileName, String user, boolean isDaemon) throws IOException {
+ public Response downloadFile(String host, String fileName, String user, boolean isDaemon) throws IOException {
Path rootDir = isDaemon ? daemonLogRoot : logRoot;
Path rawFile = rootDir.resolve(fileName);
Path file = rawFile.toAbsolutePath().normalize();
@@ -80,7 +80,7 @@ public class LogFileDownloader {
if (file.toFile().exists()) {
if (isDaemon || resourceAuthorizer.isUserAllowedToAccessFile(user, fileName)) {
fileDownloadSizeDistMb.update(Math.round((double) file.toFile().length() / FileUtils.ONE_MB));
- return LogviewerResponseBuilder.buildDownloadFile(file.toFile(), numFileDownloadExceptions);
+ return LogviewerResponseBuilder.buildDownloadFile(host, file.toFile(), numFileDownloadExceptions);
} else {
return LogviewerResponseBuilder.buildResponseUnauthorizedUser(user);
}
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
index 3a4b57a..a53be71 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/utils/LogviewerResponseBuilder.java
@@ -75,16 +75,25 @@ public class LogviewerResponseBuilder {
/**
* Build a Response object representing download a file.
*
+ * @param host host address
* @param file file to download
*/
- public static Response buildDownloadFile(File file, Meter numFileDownloadExceptions) throws IOException {
+ public static Response buildDownloadFile(String host, File file, Meter numFileDownloadExceptions) throws IOException {
+ String fname;
+ try {
+ String topoInfo = file.getParentFile().getParentFile().getName();
+ String port = file.getParentFile().getName();
+ fname = String.format("%s-%s-%s-%s", host, port, topoInfo, file.getName());
+ } catch (NullPointerException e) {
+ fname = file.getName();
+ }
try {
// do not close this InputStream in method: it will be used from jetty server
InputStream is = Files.newInputStream(file.toPath());
return Response.status(OK)
.entity(wrapWithStreamingOutput(is))
.type(MediaType.APPLICATION_OCTET_STREAM_TYPE)
- .header("Content-Disposition", "attachment; filename=\"" + file.getName() + "\"")
+ .header("Content-Disposition", "attachment; filename=\"" + fname + "\"")
.build();
} catch (IOException e) {
numFileDownloadExceptions.mark();
diff --git a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/webapp/LogviewerResource.java b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/webapp/LogviewerResource.java
index 1645e37..fb85911 100644
--- a/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/webapp/LogviewerResource.java
+++ b/storm-webapp/src/main/java/org/apache/storm/daemon/logviewer/webapp/LogviewerResource.java
@@ -22,6 +22,7 @@ import com.codahale.metrics.Meter;
import com.codahale.metrics.Timer;
import java.io.IOException;
+import java.net.InetAddress;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
@@ -229,9 +230,11 @@ public class LogviewerResource {
@Path("/dumps/{topo-id}/{host-port}/{filename}")
public Response downloadDumpFile(@PathParam("topo-id") String topologyId, @PathParam("host-port") String hostPort,
@PathParam("filename") String fileName, @Context HttpServletRequest request) throws IOException {
+
String user = httpCredsHandler.getUserName(request);
try {
- return profileHandler.downloadDumpFile(topologyId, hostPort, fileName, user);
+ String host = InetAddress.getLocalHost().getCanonicalHostName();
+ return profileHandler.downloadDumpFile(host, topologyId, hostPort, fileName, user);
} catch (IOException e) {
numDownloadDumpExceptions.mark();
throw e;
@@ -245,12 +248,12 @@ public class LogviewerResource {
@Path("/download")
public Response downloadLogFile(@Context HttpServletRequest request) throws IOException {
meterDownloadLogFileHttpRequests.mark();
-
String user = httpCredsHandler.getUserName(request);
String file = request.getParameter("file");
String decodedFileName = Utils.urlDecodeUtf8(file);
try {
- return logDownloadHandler.downloadLogFile(decodedFileName, user);
+ String host = InetAddress.getLocalHost().getCanonicalHostName();
+ return logDownloadHandler.downloadLogFile(host, decodedFileName, user);
} catch (IOException e) {
numDownloadLogExceptions.mark();
throw e;
@@ -264,12 +267,12 @@ public class LogviewerResource {
@Path("/daemondownload")
public Response downloadDaemonLogFile(@Context HttpServletRequest request) throws IOException {
meterDownloadLogDaemonFileHttpRequests.mark();
-
String user = httpCredsHandler.getUserName(request);
String file = request.getParameter("file");
String decodedFileName = Utils.urlDecodeUtf8(file);
try {
- return logDownloadHandler.downloadDaemonLogFile(decodedFileName, user);
+ String host = InetAddress.getLocalHost().getCanonicalHostName();
+ return logDownloadHandler.downloadDaemonLogFile(host, decodedFileName, user);
} catch (IOException e) {
numDownloadDaemonLogExceptions.mark();
throw e;
diff --git a/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandlerTest.java b/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandlerTest.java
index 478f788..a21ab5a 100644
--- a/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandlerTest.java
+++ b/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerLogDownloadHandlerTest.java
@@ -45,8 +45,8 @@ public class LogviewerLogDownloadHandlerTest {
LogviewerLogDownloadHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response topoAResponse = handler.downloadLogFile("topoA/1111/worker.log", "user");
- Response topoBResponse = handler.downloadLogFile("topoB/1111/worker.log", "user");
+ Response topoAResponse = handler.downloadLogFile("host", "topoA/1111/worker.log", "user");
+ Response topoBResponse = handler.downloadLogFile("host", "topoB/1111/worker.log", "user");
Utils.forceDelete(rootPath.toString());
@@ -63,7 +63,7 @@ public class LogviewerLogDownloadHandlerTest {
LogviewerLogDownloadHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response topoAResponse = handler.downloadLogFile("../nimbus.log", "user");
+ Response topoAResponse = handler.downloadLogFile("host","../nimbus.log", "user");
Utils.forceDelete(rootPath.toString());
@@ -77,7 +77,7 @@ public class LogviewerLogDownloadHandlerTest {
LogviewerLogDownloadHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response response = handler.downloadDaemonLogFile("nimbus.log", "user");
+ Response response = handler.downloadDaemonLogFile("host","nimbus.log", "user");
Utils.forceDelete(rootPath.toString());
@@ -92,7 +92,7 @@ public class LogviewerLogDownloadHandlerTest {
LogviewerLogDownloadHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response response = handler.downloadDaemonLogFile("workers-artifacts/topoA/1111/worker.log", "user");
+ Response response = handler.downloadDaemonLogFile("host","workers-artifacts/topoA/1111/worker.log", "user");
Utils.forceDelete(rootPath.toString());
@@ -106,7 +106,7 @@ public class LogviewerLogDownloadHandlerTest {
LogviewerLogDownloadHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response response = handler.downloadDaemonLogFile("../evil.sh", "user");
+ Response response = handler.downloadDaemonLogFile("host","../evil.sh", "user");
Utils.forceDelete(rootPath.toString());
diff --git a/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandlerTest.java b/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandlerTest.java
index 96a287d..02744ac 100644
--- a/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandlerTest.java
+++ b/storm-webapp/src/test/java/org/apache/storm/daemon/logviewer/handler/LogviewerProfileHandlerTest.java
@@ -98,8 +98,8 @@ public class LogviewerProfileHandlerTest {
LogviewerProfileHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response topoAResponse = handler.downloadDumpFile("topoA", "localhost:1111", "worker.jfr", "user");
- Response topoBResponse = handler.downloadDumpFile("topoB", "localhost:1111", "worker.txt", "user");
+ Response topoAResponse = handler.downloadDumpFile("host","topoA", "localhost:1111", "worker.jfr", "user");
+ Response topoBResponse = handler.downloadDumpFile("host","topoB", "localhost:1111", "worker.txt", "user");
Utils.forceDelete(rootPath.toString());
@@ -116,7 +116,7 @@ public class LogviewerProfileHandlerTest {
LogviewerProfileHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response topoAResponse = handler.downloadDumpFile("../../", "localhost:logs", "daemon-dump.bin", "user");
+ Response topoAResponse = handler.downloadDumpFile("host","../../", "localhost:logs", "daemon-dump.bin", "user");
Utils.forceDelete(rootPath.toString());
@@ -130,7 +130,7 @@ public class LogviewerProfileHandlerTest {
LogviewerProfileHandler handler = createHandlerTraversalTests(rootPath.getFile().toPath());
- Response topoAResponse = handler.downloadDumpFile("../", "localhost:../logs", "daemon-dump.bin", "user");
+ Response topoAResponse = handler.downloadDumpFile("host","../", "localhost:../logs", "daemon-dump.bin", "user");
Utils.forceDelete(rootPath.toString());