You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celeborn.apache.org by zh...@apache.org on 2023/10/10 10:37:58 UTC
[incubator-celeborn] branch main updated: [CELEBORN-1028] Make prometheus path configurable
This is an automated email from the ASF dual-hosted git repository.
zhouky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new f6d27609b [CELEBORN-1028] Make prometheus path configurable
f6d27609b is described below
commit f6d27609b8c66d778b064aa433b1e1dd7bf74367
Author: sychen <sy...@ctrip.com>
AuthorDate: Tue Oct 10 18:37:44 2023 +0800
[CELEBORN-1028] Make prometheus path configurable
### What changes were proposed in this pull request?
`celeborn.metrics.prometheus.path`
### Why are the changes needed?
### Does this PR introduce _any_ user-facing change?
### How was this patch tested?
Closes #1965 from cxzl25/CELEBORN-1028.
Authored-by: sychen <sy...@ctrip.com>
Signed-off-by: zky.zhoukeyong <zk...@alibaba-inc.com>
---
.../src/main/scala/org/apache/celeborn/common/CelebornConf.scala | 9 +++++++++
.../scala/org/apache/celeborn/common/metrics/MetricsSystem.scala | 2 --
docs/configuration/metrics.md | 1 +
.../scala/org/apache/celeborn/service/deploy/master/Master.scala | 3 ++-
.../scala/org/apache/celeborn/service/deploy/worker/Worker.scala | 2 +-
5 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala b/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
index 7fe09e8c1..8056eeb53 100644
--- a/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
+++ b/common/src/main/scala/org/apache/celeborn/common/CelebornConf.scala
@@ -3661,6 +3661,15 @@ object CelebornConf extends Logging {
.intConf
.createWithDefault(10)
+ val METRICS_PROMETHEUS_PATH: ConfigEntry[String] =
+ buildConf("celeborn.metrics.prometheus.path")
+ .categories("metrics")
+ .doc("URI context path of prometheus metrics HTTP server")
+ .version("0.4.0")
+ .stringConf
+ .checkValue(path => path.startsWith("/"), "Context path must start with '/'")
+ .createWithDefault("/metrics/prometheus")
+
val QUOTA_ENABLED: ConfigEntry[Boolean] =
buildConf("celeborn.quota.enabled")
.categories("quota")
diff --git a/common/src/main/scala/org/apache/celeborn/common/metrics/MetricsSystem.scala b/common/src/main/scala/org/apache/celeborn/common/metrics/MetricsSystem.scala
index fdc1fef0b..93ce33282 100644
--- a/common/src/main/scala/org/apache/celeborn/common/metrics/MetricsSystem.scala
+++ b/common/src/main/scala/org/apache/celeborn/common/metrics/MetricsSystem.scala
@@ -158,8 +158,6 @@ object MetricsSystem {
val ROLE_WORKER = "Worker"
val ROLE_MASTER = "Master"
- val SERVLET_PATH = "/metrics/prometheus"
-
private[this] val MINIMAL_POLL_UNIT = TimeUnit.SECONDS
private[this] val MINIMAL_POLL_PERIOD = 1
diff --git a/docs/configuration/metrics.md b/docs/configuration/metrics.md
index 1c4d35246..8015795ed 100644
--- a/docs/configuration/metrics.md
+++ b/docs/configuration/metrics.md
@@ -29,6 +29,7 @@ license: |
| celeborn.metrics.extraLabels | | If default metric labels are not enough, extra metric labels can be customized. Labels' pattern is: `<label1_key>=<label1_value>[,<label2_key>=<label2_value>]*`; e.g. `env=prod,version=1` | 0.3.0 |
| celeborn.metrics.master.prometheus.host | <localhost> | Master's Prometheus host. | 0.3.0 |
| celeborn.metrics.master.prometheus.port | 9098 | Master's Prometheus port. | 0.3.0 |
+| celeborn.metrics.prometheus.path | /metrics/prometheus | URI context path of prometheus metrics HTTP server | 0.4.0 |
| celeborn.metrics.sample.rate | 1.0 | It controls if Celeborn collect timer metrics for some operations. Its value should be in [0.0, 1.0]. | 0.2.0 |
| celeborn.metrics.timer.slidingWindow.size | 4096 | The sliding window size of timer metric. | 0.2.0 |
| celeborn.metrics.worker.pauseSpentTime.forceAppend.threshold | 10 | Force append worker pause spent time even if worker still in pause serving state.Help user can find worker pause spent time increase, when worker always been pause state. | |
diff --git a/master/src/main/scala/org/apache/celeborn/service/deploy/master/Master.scala b/master/src/main/scala/org/apache/celeborn/service/deploy/master/Master.scala
index 32bb22781..1dcf71324 100644
--- a/master/src/main/scala/org/apache/celeborn/service/deploy/master/Master.scala
+++ b/master/src/main/scala/org/apache/celeborn/service/deploy/master/Master.scala
@@ -32,6 +32,7 @@ import org.apache.ratis.proto.RaftProtos
import org.apache.ratis.proto.RaftProtos.RaftPeerRole
import org.apache.celeborn.common.CelebornConf
+import org.apache.celeborn.common.CelebornConf.METRICS_PROMETHEUS_PATH
import org.apache.celeborn.common.client.MasterClient
import org.apache.celeborn.common.identity.UserIdentifier
import org.apache.celeborn.common.internal.Logging
@@ -58,7 +59,7 @@ private[celeborn] class Master(
override def serviceName: String = Service.MASTER
override val metricsSystem: MetricsSystem =
- MetricsSystem.createMetricsSystem(serviceName, conf, MetricsSystem.SERVLET_PATH)
+ MetricsSystem.createMetricsSystem(serviceName, conf, conf.get(METRICS_PROMETHEUS_PATH))
override val rpcEnv: RpcEnv = RpcEnv.create(
RpcNameConstants.MASTER_SYS,
diff --git a/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/Worker.scala b/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/Worker.scala
index c791d1d06..90e5e58ff 100644
--- a/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/Worker.scala
+++ b/worker/src/main/scala/org/apache/celeborn/service/deploy/worker/Worker.scala
@@ -62,7 +62,7 @@ private[celeborn] class Worker(
override def serviceName: String = Service.WORKER
override val metricsSystem: MetricsSystem =
- MetricsSystem.createMetricsSystem(serviceName, conf, MetricsSystem.SERVLET_PATH)
+ MetricsSystem.createMetricsSystem(serviceName, conf, conf.get(METRICS_PROMETHEUS_PATH))
val rpcEnv: RpcEnv = RpcEnv.create(
RpcNameConstants.WORKER_SYS,