Skip to content

Update Webserver health check endpoint in document #51497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shahar1 merged 2 commits into from
Jun 7, 2025
Merged

Update Webserver health check endpoint in document #51497

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55aa15c
Update Webserver healtch check endpoint in document
rapsealk Jun 7, 2025
1c1dc47
Merge branch 'main' into docs/update-webserver-health-check-endpoint
rapsealk Jun 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...low-core/docs/administration-and-deployment/logging-monitoring/check-health.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Webserver Health Check Endpoint
-------------------------------

To check the health status of your Airflow instance, you can simply access the endpoint
``/health``. It will return a JSON object in which a high-level glance is provided.
``/api/v2/monitor/health``. It will return a JSON object in which a high-level glance is provided.

.. code-block:: JSON

Expand Down Expand Up @@ -79,7 +79,7 @@ To check the health status of your Airflow instance, you can simply access the e
Note that the ``status`` and ``latest_dag_processor_heartbeat`` fields in the health check response will be null for
deployments that do not include a ``dag_processor`` component.

Please keep in mind that the HTTP response code of ``/health`` endpoint **should not** be used to determine the health
Please keep in mind that the HTTP response code of ``/api/v2/monitor/health`` endpoint **should not** be used to determine the health
status of the application. The return code is only indicative of the state of the rest call (200 for success).

Served by the web server, this health check endpoint is independent of the newer :ref:`Scheduler Health Check Server <check-health/scheduler-health-check-server>`, which optionally runs on each scheduler.
Expand All @@ -96,7 +96,7 @@ Scheduler Health Check Server
-----------------------------

In order to check scheduler health independent of the web server, Airflow optionally starts a small HTTP server
in each scheduler to serve a scheduler ``\health`` endpoint. It returns status code ``200`` when the scheduler
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 unhealthy. To run this server in each scheduler, set
``[scheduler]enable_health_check`` to ``True``. By default, it is ``False``. The server is running on the port
specified by the ``[scheduler]scheduler_health_check_server_port`` option. By default, it is ``8974``. We are
Expand Down
⚡