You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: airflow-core/docs/administration-and-deployment/logging-monitoring/check-health.rst
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ Webserver Health Check Endpoint
36
36
-------------------------------
37
37
38
38
To check the health status of your Airflow instance, you can simply access the endpoint
39
-
``/api/v2/monitor/health``. It will return a JSON object in which a high-level glance is provided.
39
+
``/api/v2/monitor/health``. It will return a JSON object that provides a high-level glance at the health status across multiple Airflow components.
40
40
41
41
.. code-block:: JSON
42
42
@@ -86,9 +86,12 @@ Served by the web server, this health check endpoint is independent of the newer
86
86
87
87
.. note::
88
88
89
-
For this check to work, at least one working web server is required. Suppose you use this check for scheduler
90
-
monitoring, then in case of failure of the web server, you will lose the ability to monitor scheduler, which means
91
-
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>` or :ref:`Scheduler Health Check Server <check-health/scheduler-health-check-server>`.
89
+
* For this check to work, at least one working web server is required. Suppose you use this check for scheduler
90
+
monitoring, then in case of failure of the web server, you will lose the ability to monitor scheduler, which means
91
+
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>` or :ref:`Scheduler Health Check Server <check-health/scheduler-health-check-server>`.
92
+
93
+
* Using this endpoint as webserver probes (liveness/readiness) makes it contingent on Airflow core components' availability (database, scheduler, etc).
94
+
Webservers will be frequently restarted if any of these core components are down. To make Webservers less prone to other components' failures, consider using endpoints like ``api/v2/version``.
0 commit comments