This is an automated email from the ASF dual-hosted git repository.
zhifgli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-uniffle-website.git
The following commit(s) were added to refs/heads/master by this push:
new 824b462 Update metrics docs
824b462 is described below
commit 824b46259e238d306d53c9252959616c382a7cb0
Author: frankzfli <[email protected]>
AuthorDate: Wed Oct 26 16:48:33 2022 +0800
Update metrics docs
---
docs/01-intro.md | 2 +-
docs/03-Deploy/02-hardware-provisioning.md | 2 +-
docs/03-Deploy/03-metrics.md | 30 ++++++++++++++++++++++
.../00-uniffle-operator-design.md | 0
docs/{04-k8s => 04-K8s-Operator}/01-install.md | 0
docs/{04-k8s => 04-K8s-Operator}/02-examples.md | 0
docs/{06-configuration.md => 05-configuration.md} | 0
docs/05-metrics.md | 21 ---------------
docs/{07-build.md => 06-build.md} | 0
docs/{08-tuning.md => 07-tuning.md} | 0
10 files changed, 32 insertions(+), 23 deletions(-)
diff --git a/docs/01-intro.md b/docs/01-intro.md
index 3f2b737..e93753e 100644
--- a/docs/01-intro.md
+++ b/docs/01-intro.md
@@ -1,5 +1,5 @@
---
-title: intro
+title: Intro
sidebar_position: 1
---
diff --git a/docs/03-Deploy/02-hardware-provisioning.md
b/docs/03-Deploy/02-hardware-provisioning.md
index d7182a2..fd728bb 100644
--- a/docs/03-Deploy/02-hardware-provisioning.md
+++ b/docs/03-Deploy/02-hardware-provisioning.md
@@ -1,4 +1,4 @@
-# HARDWARE PROVISIONING
+# Hardware Provision
A common question received by Uniffle users is how to configure hardware for
it. While the right hardware will depend on the situation, we make the
following recommendations.
## LOCAL DISKS
diff --git a/docs/03-Deploy/03-metrics.md b/docs/03-Deploy/03-metrics.md
new file mode 100644
index 0000000..c41bfcf
--- /dev/null
+++ b/docs/03-Deploy/03-metrics.md
@@ -0,0 +1,30 @@
+# Metrics
+
+Uniffle has provided many metrics information, which help to maintain the
Uniffle cluster in production.
+
+## Http Interface
+
+Each coordinator or shuffle server has a http interface to get its metrics.
+We divide all metrics into four categories.
+
+### coordinator-related metrics
+```
+curl http://[coordinatorIP]:[jettyPort]/metrics/server
+```
+
+
+### server-related metrics
+```
+curl http://[serverIp]:[jettyPort]/metrics/server
+```
+
+### grpc-related metrics
+```
+curl http://[coordinatorIP or serverIp]:[jettyPort]/metrics/grpc
+```
+
+
+### jvm-related metrics
+```
+curl http://[coordinatorIP or serverIp]:[jettyPort]/metrics/jvm
+```
\ No newline at end of file
diff --git a/docs/04-k8s/00-uniffle-operator-design.md
b/docs/04-K8s-Operator/00-uniffle-operator-design.md
similarity index 100%
rename from docs/04-k8s/00-uniffle-operator-design.md
rename to docs/04-K8s-Operator/00-uniffle-operator-design.md
diff --git a/docs/04-k8s/01-install.md b/docs/04-K8s-Operator/01-install.md
similarity index 100%
rename from docs/04-k8s/01-install.md
rename to docs/04-K8s-Operator/01-install.md
diff --git a/docs/04-k8s/02-examples.md b/docs/04-K8s-Operator/02-examples.md
similarity index 100%
rename from docs/04-k8s/02-examples.md
rename to docs/04-K8s-Operator/02-examples.md
diff --git a/docs/06-configuration.md b/docs/05-configuration.md
similarity index 100%
rename from docs/06-configuration.md
rename to docs/05-configuration.md
diff --git a/docs/05-metrics.md b/docs/05-metrics.md
deleted file mode 100644
index f152f76..0000000
--- a/docs/05-metrics.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Metrics System
-
-In Uniffle, both coordinator and shuffle server have provided many runtime
metrics, which help to maintain the Uniffle cluster in production.
-
-We list a
[script](https://github.com/apache/incubator-uniffle/blob/master/bin/get-metrics.py)
to get these metrics via http protocol.
-
-```
-python get-metrics.py [serverListFile] [jettyPort] [metricName]
-```
-
-Extract server ip from line in the serverListFile, which contains lines of
server node and the format is $IP-$PORT.
-The ip and port are server's rpc ip and port respectively, the port is useless
here so we only extract the
-ip and assemble the url with jetty http port to get metrics and extract the
value of the metric specified by metricName.
-
-See all available [server runtime
metrics](https://github.com/apache/incubator-uniffle/blob/master/server/src/main/java/org/apache/uniffle/server/ShuffleServerMetrics.java).
-
-See all available [server grpc
metrics](https://github.com/apache/incubator-uniffle/blob/master/server/src/main/java/org/apache/uniffle/server/ShuffleServerGrpcMetrics.java).
-
-See all available [coordinator runtime
metrics](https://github.com/apache/incubator-uniffle/blob/master/coordinator/src/main/java/org/apache/uniffle/coordinator/CoordinatorMetrics.java).
-
-See all available [coordinator grpc
metrics](https://github.com/apache/incubator-uniffle/blob/master/coordinator/src/main/java/org/apache/uniffle/coordinator/CoordinatorMetrics.java).
\ No newline at end of file
diff --git a/docs/07-build.md b/docs/06-build.md
similarity index 100%
rename from docs/07-build.md
rename to docs/06-build.md
diff --git a/docs/08-tuning.md b/docs/07-tuning.md
similarity index 100%
rename from docs/08-tuning.md
rename to docs/07-tuning.md
