forked from apache/spark
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SPARK-46870][CORE] Support Spark Master Log UI
### What changes were proposed in this pull request? This PR aims to support `Spark Master` Log UI. ### Why are the changes needed? This is a new feature to allow the users to access the master log like the following. The value of `Status`, e.g., `ALIVE`, has a new link for log UI. **BEFORE** ![Screenshot 2024-01-25 at 7 30 07 PM](https://github.com/apache/spark/assets/9700541/2c263944-ebfa-49bb-955f-d9a022e23cba) **AFTER** ![Screenshot 2024-01-25 at 7 28 59 PM](https://github.com/apache/spark/assets/9700541/8d096261-3a31-4746-b52b-e01cfcdf3237) ![Screenshot 2024-01-25 at 7 29 21 PM](https://github.com/apache/spark/assets/9700541/fc4d3c10-8695-4529-a92b-6ab477c961da) ### Does this PR introduce _any_ user-facing change? No. This is a new link and UI. ### How was this patch tested? Manually. ``` $ sbin/start-master.sh ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes apache#44890 from dongjoon-hyun/SPARK-46870. Authored-by: Dongjoon Hyun <dhyun@apple.com> Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
- Loading branch information
1 parent
48c59e2
commit 71c90ee
Showing
3 changed files
with
129 additions
and
1 deletion.
There are no files selected for viewing
125 changes: 125 additions & 0 deletions
125
core/src/main/scala/org/apache/spark/deploy/master/ui/LogPage.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one or more | ||
* contributor license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright ownership. | ||
* The ASF licenses this file to You under the Apache License, Version 2.0 | ||
* (the "License"); you may not use this file except in compliance with | ||
* the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.spark.deploy.master.ui | ||
|
||
import java.io.File | ||
import javax.servlet.http.HttpServletRequest | ||
|
||
import scala.xml.{Node, Unparsed} | ||
|
||
import org.apache.spark.internal.Logging | ||
import org.apache.spark.ui.{UIUtils, WebUIPage} | ||
import org.apache.spark.util.Utils | ||
import org.apache.spark.util.logging.RollingFileAppender | ||
|
||
private[ui] class LogPage(parent: MasterWebUI) extends WebUIPage("logPage") with Logging { | ||
private val defaultBytes = 100 * 1024 | ||
|
||
def render(request: HttpServletRequest): Seq[Node] = { | ||
val logDir = sys.env.getOrElse("SPARK_LOG_DIR", "logs/") | ||
val logType = request.getParameter("logType") | ||
val offset = Option(request.getParameter("offset")).map(_.toLong) | ||
val byteLength = Option(request.getParameter("byteLength")).map(_.toInt) | ||
.getOrElse(defaultBytes) | ||
val (logText, startByte, endByte, logLength) = getLog(logDir, logType, offset, byteLength) | ||
val curLogLength = endByte - startByte | ||
val range = | ||
<span id="log-data"> | ||
Showing {curLogLength} Bytes: {startByte.toString} - {endByte.toString} of {logLength} | ||
</span> | ||
|
||
val moreButton = | ||
<button type="button" onclick={"loadMore()"} class="log-more-btn btn btn-secondary"> | ||
Load More | ||
</button> | ||
|
||
val newButton = | ||
<button type="button" onclick={"loadNew()"} class="log-new-btn btn btn-secondary"> | ||
Load New | ||
</button> | ||
|
||
val alert = | ||
<div class="no-new-alert alert alert-info" style="display: none;"> | ||
End of Log | ||
</div> | ||
|
||
val logParams = "?self&logType=%s".format(logType) | ||
val jsOnload = "window.onload = " + | ||
s"initLogPage('$logParams', $curLogLength, $startByte, $endByte, $logLength, $byteLength);" | ||
|
||
val content = | ||
<script type="module" src={UIUtils.prependBaseUri(request, "/static/utils.js")}></script> ++ | ||
<div> | ||
<p><a href="/">Back to Master</a></p> | ||
{range} | ||
<div class="log-content" style="height:80vh; overflow:auto; padding:5px;"> | ||
<div>{moreButton}</div> | ||
<pre>{logText}</pre> | ||
{alert} | ||
<div>{newButton}</div> | ||
</div> | ||
<script>{Unparsed(jsOnload)}</script> | ||
</div> | ||
|
||
UIUtils.basicSparkPage(request, content, logType + " log page for master") | ||
} | ||
|
||
/** Get the part of the log files given the offset and desired length of bytes */ | ||
private def getLog( | ||
logDirectory: String, | ||
logType: String, | ||
offsetOption: Option[Long], | ||
byteLength: Int | ||
): (String, Long, Long, Long) = { | ||
try { | ||
// Find a log file name | ||
val fileName = if (logType.equals("out")) { | ||
val normalizedUri = new File(logDirectory).toURI.normalize() | ||
val normalizedLogDir = new File(normalizedUri.getPath) | ||
normalizedLogDir.listFiles.map(_.getName).filter(_.endsWith(".out")) | ||
.headOption.getOrElse(logType) | ||
} else { | ||
logType | ||
} | ||
val files = RollingFileAppender.getSortedRolledOverFiles(logDirectory, fileName) | ||
logDebug(s"Sorted log files of type $logType in $logDirectory:\n${files.mkString("\n")}") | ||
|
||
val fileLengths: Seq[Long] = files.map(Utils.getFileLength(_, parent.master.conf)) | ||
val totalLength = fileLengths.sum | ||
val offset = offsetOption.getOrElse(totalLength - byteLength) | ||
val startIndex = { | ||
if (offset < 0) { | ||
0L | ||
} else if (offset > totalLength) { | ||
totalLength | ||
} else { | ||
offset | ||
} | ||
} | ||
val endIndex = math.min(startIndex + byteLength, totalLength) | ||
logDebug(s"Getting log from $startIndex to $endIndex") | ||
val logText = Utils.offsetBytes(files, fileLengths, startIndex, endIndex) | ||
logDebug(s"Got log of length ${logText.length} bytes") | ||
(logText, startIndex, endIndex, totalLength) | ||
} catch { | ||
case e: Exception => | ||
logError(s"Error getting $logType logs from directory $logDirectory", e) | ||
("Error getting logs due to exception: " + e.getMessage, 0, 0, 0) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters