Skip to content

Commit 1d6e79f

Browse files
authored
[DISCUSSION-54853] Update webserver probe health check doc (#59942)
* [DISCUSSION-54853] Update webserver probe health check doc * Remove empty line before health check note * fix indentation on docs
1 parent c8aa74a commit 1d6e79f

File tree

1 file changed

+7
-4
lines changed
  • airflow-core/docs/administration-and-deployment/logging-monitoring

1 file changed

+7
-4
lines changed

airflow-core/docs/administration-and-deployment/logging-monitoring/check-health.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Webserver Health Check Endpoint
3636
-------------------------------
3737

3838
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.
4040

4141
.. code-block:: JSON
4242
@@ -86,9 +86,12 @@ Served by the web server, this health check endpoint is independent of the newer
8686

8787
.. note::
8888

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``.
9295

9396
.. _check-health/scheduler-health-check-server:
9497

0 commit comments

Comments
 (0)