kezhenxu94 commented on code in PR #10326: URL: https://github.com/apache/dolphinscheduler/pull/10326#discussion_r889851456
########## docs/docs/en/guide/metrics/metrics.md: ########## @@ -0,0 +1,72 @@ +# Introduction + +Apache DolphinScheduler has export some metrics to monitor the system. We use micrometer for the exporter facade, and +the default exporter is prometheus, more exporter is coming soon. + +## Quick Start + +You can add the following config in master/worker's yaml file to open the metrics exporter. Review Comment: Alert/API also support metrics, although they have only some basic metrics like JVM/CPU, datasource, etc. ```suggestion You can add the following config in master/worker/alert/api's yaml file to open the metrics exporter. ``` ########## dolphinscheduler-meter/src/main/java/org/apache/dolphinscheduler/meter/MeterConfiguration.java: ########## @@ -30,6 +34,18 @@ import io.micrometer.core.aop.TimedAspect; import io.micrometer.core.instrument.MeterRegistry; +/** + * This configuration class is used to config the metrics. We use <a href="https://micrometer.io/docs/concepts";>micrometer</a> as the metrics fade. Review Comment: ```suggestion * This configuration class is used to config the metrics. We use <a href="https://micrometer.io/docs/concepts";>micrometer</a> as the metrics facade. ``` ########## docs/docs/en/guide/metrics/metrics.md: ########## @@ -0,0 +1,72 @@ +# Introduction + +Apache DolphinScheduler has export some metrics to monitor the system. We use micrometer for the exporter facade, and +the default exporter is prometheus, more exporter is coming soon. + +## Quick Start + +You can add the following config in master/worker's yaml file to open the metrics exporter. + +```yaml +metrics: + enabled: true +``` + +Once you open the metrics exporter, you can access the metrics by the url: `http://ip:port/actuator/prometheus` Review Comment: Can you please add some additional information about the ports of each service, 5679 for master instead of 5678, 1235 for worker instead of 1234? Users might think the port of metrics endpoint is the same as the service, which is wrong ########## docs/docs/en/guide/metrics/metrics.md: ########## @@ -0,0 +1,72 @@ +# Introduction + +Apache DolphinScheduler has export some metrics to monitor the system. We use micrometer for the exporter facade, and +the default exporter is prometheus, more exporter is coming soon. + +## Quick Start + +You can add the following config in master/worker's yaml file to open the metrics exporter. + +```yaml +metrics: + enabled: true +``` + +Once you open the metrics exporter, you can access the metrics by the url: `http://ip:port/actuator/prometheus` +For example, you can get the master metrics by `curl http://localhost:5679/actuator/prometheus` + +We have prepared the out-of-the-box grafana for you, you can find the grafana dashboard Review Comment: ```suggestion We have prepared the out-of-the-box Grafana configuration for you, you can find the Grafana dashboard ``` ########## docs/docs/en/guide/metrics/metrics.md: ########## @@ -0,0 +1,72 @@ +# Introduction + +Apache DolphinScheduler has export some metrics to monitor the system. We use micrometer for the exporter facade, and +the default exporter is prometheus, more exporter is coming soon. + +## Quick Start + +You can add the following config in master/worker's yaml file to open the metrics exporter. + +```yaml +metrics: + enabled: true +``` + +Once you open the metrics exporter, you can access the metrics by the url: `http://ip:port/actuator/prometheus` +For example, you can get the master metrics by `curl http://localhost:5679/actuator/prometheus` + +We have prepared the out-of-the-box grafana for you, you can find the grafana dashboard +at `dolphinscheduler-meter/resources/grafana`, you can directly import these dashboards to grafana. + +If you want to try at docker, you can use the following command to start the prometheus with grafana: + +```shell +cd dolphinscheduler-meter/src/main/resources/grafana-demo +docker compose up +``` + +Then you can access the grafana by the url: `http://localhost/3001` + +## Master Metrics Review Comment: Can we add a section to describe that we also have some default system metrics (non- business specific) such as JVM and datasource metrics? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
