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
+3-3Lines changed: 3 additions & 3 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
-
``/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.
40
40
41
41
.. code-block:: JSON
42
42
@@ -79,7 +79,7 @@ To check the health status of your Airflow instance, you can simply access the e
79
79
Note that the ``status`` and ``latest_dag_processor_heartbeat`` fields in the health check response will be null for
80
80
deployments that do not include a ``dag_processor`` component.
81
81
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
83
83
status of the application. The return code is only indicative of the state of the rest call (200 for success).
84
84
85
85
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
96
96
-----------------------------
97
97
98
98
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
100
100
is healthy and status code ``503`` when the scheduler is unhealthy. To run this server in each scheduler, set
101
101
``[scheduler]enable_health_check`` to ``True``. By default, it is ``False``. The server is running on the port
102
102
specified by the ``[scheduler]scheduler_health_check_server_port`` option. By default, it is ``8974``. We are
0 commit comments