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 d9aba51 Add metrics docs
d9aba51 is described below
commit d9aba513bfdd7c69ab7ee1b5eedf273e25255b2d
Author: frankzfli <[email protected]>
AuthorDate: Tue Oct 25 20:55:25 2022 +0800
Add metrics docs
---
docs/05-metrics.md | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/docs/05-metrics.md b/docs/05-metrics.md
index aac7ffe..f152f76 100644
--- a/docs/05-metrics.md
+++ b/docs/05-metrics.md
@@ -1,3 +1,21 @@
-# Import Metrics
+# Metrics System
-for test
\ No newline at end of file
+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
