Skip to content

Commit 311d23d

Browse files
rapsealksanederchik
authored andcommitted
Update Webserver health check endpoint in document (apache#51497)
1 parent 40ca20e commit 311d23d

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

  • airflow-core/docs/administration-and-deployment/logging-monitoring

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

Lines changed: 3 additions & 3 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-
``/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 in which a high-level glance is provided.
4040

4141
.. code-block:: JSON
4242
@@ -79,7 +79,7 @@ To check the health status of your Airflow instance, you can simply access the e
7979
Note that the ``status`` and ``latest_dag_processor_heartbeat`` fields in the health check response will be null for
8080
deployments that do not include a ``dag_processor`` component.
8181

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

8585
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.
@@ -96,7 +96,7 @@ Scheduler Health Check Server
9696
-----------------------------
9797

9898
In order to check scheduler health independent of the web server, Airflow optionally starts a small HTTP server
99-
in each scheduler to serve a scheduler ``\health`` endpoint. It returns status code ``200`` when the scheduler
99+
in each scheduler to serve a scheduler ``/health`` endpoint. It returns status code ``200`` when the scheduler
100100
is healthy and status code ``503`` when the scheduler is unhealthy. To run this server in each scheduler, set
101101
``[scheduler]enable_health_check`` to ``True``. By default, it is ``False``. The server is running on the port
102102
specified by the ``[scheduler]scheduler_health_check_server_port`` option. By default, it is ``8974``. We are

0 commit comments

Comments
 (0)