You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by do...@apache.org on 2021/02/25 02:12:29 UTC
[spark] branch branch-3.1 updated: [SPARK-34531][CORE] Remove
Experimental API tag in PrometheusServlet
This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch branch-3.1
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.1 by this push:
new fd07b3b [SPARK-34531][CORE] Remove Experimental API tag in PrometheusServlet
fd07b3b is described below
commit fd07b3bc3a2b33bfa0ed0a0eda1eb4ddf36320a7
Author: HyukjinKwon <gu...@apache.org>
AuthorDate: Wed Feb 24 18:11:25 2021 -0800
[SPARK-34531][CORE] Remove Experimental API tag in PrometheusServlet
### What changes were proposed in this pull request?
The endpoints of Prometheus metrics are properly marked and documented as an experimental (SPARK-31674). The class `PrometheusServlet` itself is not the part of an API so this PR proposes to remove it.
### Why are the changes needed?
To avoid marking a non-API as an API.
### Does this PR introduce _any_ user-facing change?
No, the class is already `private[spark]`.
### How was this patch tested?
Existing tests should cover.
Closes #31640 from HyukjinKwon/SPARK-34531.
Lead-authored-by: HyukjinKwon <gu...@apache.org>
Co-authored-by: Dongjoon Hyun <do...@apache.org>
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
(cherry picked from commit 22383e312d00ec8888cdc2d12750b7d1e7e21d99)
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
.../main/scala/org/apache/spark/metrics/sink/PrometheusServlet.scala | 3 ---
docs/monitoring.md | 2 +-
2 files changed, 1 insertion(+), 4 deletions(-)
diff --git a/core/src/main/scala/org/apache/spark/metrics/sink/PrometheusServlet.scala b/core/src/main/scala/org/apache/spark/metrics/sink/PrometheusServlet.scala
index 0f8fbd3..7cc2665e 100644
--- a/core/src/main/scala/org/apache/spark/metrics/sink/PrometheusServlet.scala
+++ b/core/src/main/scala/org/apache/spark/metrics/sink/PrometheusServlet.scala
@@ -24,18 +24,15 @@ import com.codahale.metrics.MetricRegistry
import org.eclipse.jetty.servlet.ServletContextHandler
import org.apache.spark.{SecurityManager, SparkConf}
-import org.apache.spark.annotation.Experimental
import org.apache.spark.ui.JettyUtils._
/**
- * :: Experimental ::
* This exposes the metrics of the given registry with Prometheus format.
*
* The output is consistent with /metrics/json result in terms of item ordering
* and with the previous result of Spark JMX Sink + Prometheus JMX Converter combination
* in terms of key string format.
*/
-@Experimental
private[spark] class PrometheusServlet(
val property: Properties,
val registry: MetricRegistry,
diff --git a/docs/monitoring.md b/docs/monitoring.md
index 5b3278b..930f91f 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -755,7 +755,7 @@ 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 experimental and conditional to a configuration parameter: `spark.ui.prometheus.enabled=true` (the default is `false`).
+The Prometheus endpoint is conditional to a configuration parameter: `spark.ui.prometheus.enabled=true` (the default is `false`).
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](http://metrics.dropwizard.io/4.1.1).
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org