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 1c2304c40 [CELEBORN-1101] Update metrics doc to add necessary
configuration steps
1c2304c40 is described below
commit 1c2304c40651d7c954312c5f59e5c32251fb04c8
Author: jiaoqingbo <[email protected]>
AuthorDate: Tue Oct 31 21:16:08 2023 +0800
[CELEBORN-1101] Update metrics doc to add necessary configuration steps
### What changes were proposed in this pull request?
Update metrics doc to add necessary configuration steps
### Why are the changes needed?
The steps to configure metrics.properties are missing from the document.
This will cause failure to obtain metrics.
### Does this PR introduce _any_ user-facing change?
NO
### How was this patch tested?
PASS GA
Closes #2057 from jiaoqingbo/1101.
Authored-by: jiaoqingbo <[email protected]>
Signed-off-by: zky.zhoukeyong <[email protected]>
---
METRICS.md | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/METRICS.md b/METRICS.md
index 61d7313ae..e764371da 100644
--- a/METRICS.md
+++ b/METRICS.md
@@ -5,9 +5,19 @@ issue or monitor Celeborn cluster.
## Prerequisites
-1.Enable Celeborn metrics. Set configuration `celeborn.metrics.enabled` to
true (true by default).
+1. Enable Celeborn metrics. Set configuration `celeborn.metrics.enabled` to
true (true by default).
-2.Install Prometheus (https://prometheus.io/). We provide an example for
Prometheus config file:
+2. Configure Celeborn metrics properties.
+```shell
+cd $CELEBORN_HOME/conf
+cp metrics.properties.template metrics.properties
+```
+The default values of the Celeborn metrics configuration are as follows:
+```
+*.sink.prometheusServlet.class=org.apache.celeborn.common.metrics.sink.PrometheusServlet
+```
+
+3. Install Prometheus (https://prometheus.io/). We provide an example for
Prometheus config file:
```yaml
# Prometheus example config
@@ -23,9 +33,9 @@ scrape_configs:
- targets: [
"master-ip:9098","worker1-ip:9096","worker2-ip:9096","worker3-ip:9096","worker4-ip:9096"
]
```
-3.Install Grafana server (https://grafana.com/grafana/download).
+4. Install Grafana server (https://grafana.com/grafana/download).
-4.Import Celeborn dashboard into Grafana.
+5. Import Celeborn dashboard into Grafana.
You can find the Celeborn dashboard templates under the `assets/grafana`
directory.
`celeborn-dashboard.json` displays Celeborn internal metrics and
`celeborn-jvm-dashboard.json` displays Celeborn JVM related metrics.
