[GitHub] [incubator-yunikorn-site] yangwwei commented on a change in pull request #66: [YUNIKORN-745] Add doc for healthcheck endpoint

[GitBox <gi...@apache.org>]

yangwwei commented on a change in pull request #66:
URL: https://github.com/apache/incubator-yunikorn-site/pull/66#discussion_r671779796



##########
File path: docs/api/scheduler.md
##########
@@ -1151,3 +1151,81 @@ Endpoint to retrieve historical data about the number of total containers by tim
 }
 ```
 
+
+## Endpoint healthcheck

Review comment:
       Changer to "Scheduler healthcheck"

##########
File path: docs/api/scheduler.md
##########
@@ -1151,3 +1151,81 @@ Endpoint to retrieve historical data about the number of total containers by tim
 }
 ```
 
+
+## Endpoint healthcheck
+
+Endpoint to retrieve historical data about critical logs, negative resource on node/cluster/app, ...

Review comment:
       Endpoint to trigger a lightweight internal health check. The health check runs a few validations to verify if the scheduler state is healthy. Such as scanning scheduling errors, detect failed nodes, detect inconsistent resources, etc. The response contains a list of results for each of the checked items.




-- 
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: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org