advancedxy commented on code in PR #684: URL: https://github.com/apache/incubator-uniffle/pull/684#discussion_r1129470057
########## docs/coordinator_guide.md: ########## @@ -130,3 +130,61 @@ PrometheusPushGatewayMetricReporter is one of the built-in metrics reporter, whi |rss.metrics.prometheus.pushgateway.groupingkey|-| Specifies the grouping key which is the group and global labels of all metrics. The label name and value are separated by '=', and labels are separated by ';', e.g., k1=v1;k2=v2. Please ensure that your grouping key meets the [Prometheus requirements](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). | |rss.metrics.prometheus.pushgateway.jobname|-| The job name under which metrics will be pushed. | |rss.metrics.prometheus.pushgateway.report.interval.seconds|10| The interval in seconds for the reporter to report metrics. | + +## RESTful API + +### Fetch Shuffle servers Review Comment: 👍 I like the style here, The RESTful API section looks pretty on the Github page. ########## docs/coordinator_guide.md: ########## @@ -130,3 +130,61 @@ PrometheusPushGatewayMetricReporter is one of the built-in metrics reporter, whi |rss.metrics.prometheus.pushgateway.groupingkey|-| Specifies the grouping key which is the group and global labels of all metrics. The label name and value are separated by '=', and labels are separated by ';', e.g., k1=v1;k2=v2. Please ensure that your grouping key meets the [Prometheus requirements](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). | |rss.metrics.prometheus.pushgateway.jobname|-| The job name under which metrics will be pushed. | |rss.metrics.prometheus.pushgateway.report.interval.seconds|10| The interval in seconds for the reporter to report metrics. | + +## RESTful API + +### Fetch Shuffle servers + +<details> + <summary><code>GET</code> <code><b>/api/server/nodes</b></code> </summary> + +##### Parameters + +> |name|type|data type|description| +> |----|----|---------|-----------| +> |id|required|string|shuffle server id, eg:127.0.0.1:19999| +> |status|optional|string|Shuffle server status, eg:ACTIVE, DECOMMISSIONING, DECOMMISSIONED| + +##### Example cURL + +> ```javascript Review Comment: why use javascript here? Bash may be more appropriate? -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
