Skip to content

[SPARK-46886][CORE] Enable spark.ui.prometheus.enabled by default #44912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dongjoon-hyun wants to merge 2 commits into from
Closed

[SPARK-46886][CORE] Enable spark.ui.prometheus.enabled by default #44912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3af34d
[SPARK-46886][CORE] Enable `spark.ui.prometheus.enabled` by default
dongjoon-hyun Jan 27, 2024
47693c0
Update docs
dongjoon-hyun Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/scala/org/apache/spark/internal/config/UI.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ private[spark] object UI {
"For master/worker/driver metrics, you need to configure `conf/metrics.properties`.")
.version("3.0.0")
.booleanConf
.createWithDefault(false)
.createWithDefault(true)

val UI_X_XSS_PROTECTION = ConfigBuilder("spark.ui.xXssProtection")
.doc("Value for HTTP X-XSS-Protection response header")
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/scala/org/apache/spark/status/api/v1/PrometheusResource.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import org.apache.spark.ui.SparkUI
* :: Experimental ::
* This aims to expose Executor metrics like REST API which is documented in
*
* https://spark.apache.org/docs/3.0.0/monitoring.html#executor-metrics
* https://spark.apache.org/docs/latest/monitoring.html#executor-metrics
*
* Note that this is based on ExecutorSummary which is different from ExecutorSource.
*/
Expand Down
1 change: 0 additions & 1 deletion docs/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,6 @@ A list of the available metrics, with a short description:
Executor-level metrics are sent from each executor to the driver as part of the Heartbeat to describe the performance metrics of Executor itself like JVM heap memory, GC information.
Executor metric values and their measured memory peak values per executor are exposed via the REST API in JSON format and in Prometheus format.
The JSON end point is exposed at: `/applications/[app-id]/executors`, and the Prometheus endpoint at: `/metrics/executors/prometheus`.
The Prometheus endpoint is conditional to a configuration parameter: `spark.ui.prometheus.enabled=true` (the default is `false`).
Copy link
Member

@viirya viirya Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, why we need to remove it from document?

Copy link
Member Author

@dongjoon-hyun dongjoon-hyun Jan 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous sentence already mentioned this endpoint. And, this sentence is invalid because we enabled it by default, @viirya .

Copy link
Member

@viirya viirya Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I means that the config now is not mentioned in this doc. Is any other place we have mentioned this config?

Copy link
Member Author

@dongjoon-hyun dongjoon-hyun Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, for that, I can add it to the config table officially.

Copy link
Member Author

@dongjoon-hyun dongjoon-hyun Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, a few other UI configs are missing too. I can handle them together.

Copy link
Member

@viirya viirya Jan 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks.

In addition, aggregated per-stage peak values of the executor memory metrics are written to the event log if
`spark.eventLog.logStageExecutorMetrics` is true.
Executor memory metrics are also exposed via the Spark metrics system based on the [Dropwizard metrics library](https://metrics.dropwizard.io/4.2.0).
Expand Down