SamWheating commented on code in PR #23905: URL: https://github.com/apache/airflow/pull/23905#discussion_r888435540
########## docs/apache-airflow/logging-monitoring/check-health.rst: ########## @@ -72,6 +72,19 @@ status of the application. The return code is only indicative of the state of th monitoring, then in case of failure of the web server, you will lose the ability to monitor scheduler, which means that it can be restarted even if it is in good condition. For greater confidence, consider using :ref:`CLI Check for Scheduler <check-health/cli-checks-for-scheduler>`. +.. _check-health/scheduler-health-check-server: + +Scheduler Health Check Server +------------------------- + +In order to check scheduler health independent of the webserver, Airflow optionally starts an small HTTP server +in each scheduler to serve a scheduler ``\health`` endpoint. It returns status code ``200`` when the scheduler +is healthy and status code ``503`` when the scheduler is unheatlhy. To run this server in each scheduler, set +``enable_health_check`` to ``True``. By default, it is ``false``. The server is running on the port specified by Review Comment: ```suggestion ``scheduler.enable_health_check`` to ``True``. By default, it is ``false``. The server is running on the port specified by ``` Might need to include the subsection here for clarity, especially if other components are gonna have their own healthcheck APIs in the future. -- 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]
