AngersZhuuuu commented on code in PR #7: URL: https://github.com/apache/incubator-celeborn-website/pull/7#discussion_r1139830075
########## docs/user_guide/monitoring.md: ########## @@ -0,0 +1,60 @@ +--- +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- + + +Monitoring +=== + +There are two ways to monitor Celeborn cluster: prometheus metrics and REST API. + +# Metrics + +# REST API + +In addition to viewing the metrics, Celeborn also support REST API. This gives developers +an easy way to create new visualizations and monitoring tools for Celeborn and +also easy for users to get the running status of the service. The REST API is available for +both master and worker. The endpoints are mounted at `host:port`. For example, +for the master, they would typically be accessible +at `http://<master-prometheus-host>:<master-prometheus-port><endpoint>`, and Review Comment: Done ########## docs/user_guide/monitoring.md: ########## @@ -0,0 +1,60 @@ +--- +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- + + +Monitoring +=== + +There are two ways to monitor Celeborn cluster: prometheus metrics and REST API. + +# Metrics + +# REST API + +In addition to viewing the metrics, Celeborn also support REST API. This gives developers +an easy way to create new visualizations and monitoring tools for Celeborn and +also easy for users to get the running status of the service. The REST API is available for +both master and worker. The endpoints are mounted at `host:port`. For example, +for the master, they would typically be accessible +at `http://<master-prometheus-host>:<master-prometheus-port><endpoint>`, and +for the worker, at `http://<worker-prometheus-host>:<worker-prometheus-port><endpoint>`. Review Comment: Done -- 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: dev-unsubscr...@celeborn.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
