qijiale76 opened a new pull request, #56893:
URL: https://github.com/apache/spark/pull/56893
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR:
https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g.,
'[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a
faster review.
7. If you want to add a new configuration, please read the guideline first
for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the
guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section
is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other
DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
This PR adds optional HTTP access logging for Spark History Server.
It adds two History Server configurations:
- `spark.history.ui.accessLog.enabled`, default `false`
- `spark.history.ui.accessLog.excludePaths`, default `/static,/favicon.ico`
When enabled, Spark logs one access record for each non-excluded History
Server UI or REST API request after the request completes. The access log is
emitted by the `org.apache.spark.deploy.history.HistoryServerAccessLogFilter`
logger at `INFO` level.
Each access record includes the request method, URI, redacted query string,
status code, duration, remote address, remote user when available, user agent,
referer, and exception class if the request chain throws.
Query string values are redacted using Spark's existing
`spark.redaction.regex` setting. Static resources and favicon requests are
excluded by default to avoid low-value log volume.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
Spark History Server exposes application metadata through both web UI pages
and REST APIs. Operators may need access records to troubleshoot unexpected
clients, detect API polling, investigate failed requests, or satisfy
operational audit requirements.
Today this generally requires deploying a reverse proxy or writing a custom
`spark.ui.filters` servlet filter. This PR provides a built-in History Server
access log while keeping the default behavior unchanged.
The feature is disabled by default, does not log request or response bodies,
redacts query strings, and avoids logging static-resource noise by default.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
new features, bug fixes, or other behavior changes. Documentation-only updates
are not considered user-facing changes.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes. This PR adds an optional History Server access log.
The default behavior is unchanged because
`spark.history.ui.accessLog.enabled` defaults to `false`.
Users can enable it with:
```properties
spark.history.ui.accessLog.enabled=true
```
They can customize excluded path prefixes with:
```properties
spark.history.ui.accessLog.excludePaths=/static,/favicon.ico
```
Requests rejected by user-installed UI filters before Spark's internal
access log filter may not be recorded.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions
for the consistent environment, and the instructions could accord to:
https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
Tested locally with JDK 17.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
Generated-by: OpenAI Codex (GPT-5.5)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
