feat: add healthcheck for sync configuration by Revolyssup · Pull Request #12200 · apache/apisix

Revolyssup · 2025-05-08T14:07:28Z

Description

Standalone mode: This PR aims to add a healthcheck endpoint which can be used by to indicate where APISIX is ready and has loaded the configuration from clients such as ingress controller.
Config provider etcd: The above endpoint can be used to get the healthcheck status which will be false until all the workers have first time loaded the configuration from etcd.

Refer: #12179 (review)

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

…lthcheck-standalone

…ssup/apisix into revolyssup/healthcheck-standalone

bzp2010

LGTM

kayx23 · 2025-05-21T05:49:07Z

+
+```json
+{
+  "status": "ok"


What if the status is not ok? The section below shows output when its "not ok" - what about this section?

If APISIX is running, this endpoint will always return 200 and no other response. If APISIX is not running, then it wouldn't return any HTTP response, the request will error out while establishing tcp connection.

Make sense. Maybe add a sentence at the end of this section?

If APISIX is not running, the request will error out while establishing TCP connection.

wdyt

kayx23 · 2025-05-21T05:51:08Z

+
+Returns `ok` when all workers have loaded the configuration, otherwise returns the specific error with `503` error code. Below are specific examples.
+
+When all workers have loaded the configuration


Suggested change

When all workers have loaded the configuration

When all workers have loaded the configuration:

Please do the same for other sentences missing punctuation in this doc.

kayx23 · 2025-05-21T05:51:40Z

+#
+-->
+
+在 Apache APISIX 中，状态 API 用于：


Suggested change

在 Apache APISIX 中，状态 API 用于：

在 Apache APISIX 中，Status API 用于：

kayx23 · 2025-05-21T05:53:00Z

+在 Apache APISIX 中，状态 API 用于：
+
+* 检查 APISIX 是否已成功启动并正确运行
+* 检查所有工作人员是否已收到并加载配置。


Suggested change

* 检查所有工作人员是否已收到并加载配置。

* 检查所有 workers 是否已收到配置并加载。

kayx23 · 2025-05-21T05:54:29Z

+
+### GET /status
+
+返回报告 APISIX 工作者状态的 JSON


Suggested change

返回报告 APISIX 工作者状态的 JSON

返回报告 APISIX worker 状态的 JSON：

similarly add missing punctuation in this doc

kayx23 · 2025-05-21T05:55:01Z

+}
+```
+
+当特定工作器尚未加载配置时


Suggested change

当特定工作器尚未加载配置时

当特定 worker 尚未加载配置时：

kayx23 · 2025-05-21T05:55:40Z

+
+当所有 Worker 都已加载配置时，返回 `ok`；否则，返回特定错误，错误代码为 `503`。以下是具体示例。
+
+当所有 Worker 都已加载配置时


lower case the Worker, thanks

kayx23 · 2025-05-21T06:14:58Z

+}
+```
+
+When 1 workers has't been initialised


Suggested change

When 1 workers has't been initialised

When 1 workers has't been initialised:

kayx23 · 2025-05-21T06:15:07Z

+}
+```
+
+When a particular worker hasn't loaded the configuration


Suggested change

When a particular worker hasn't loaded the configuration

When a particular worker hasn't loaded the configuration:

kayx23 · 2025-05-21T06:15:34Z

+在 Apache APISIX 中，Status API 用于：
+
+* 检查 APISIX 是否已成功启动并正确运行
+* 检查所有 workers 是否已收到配置并加载。


Suggested change

* 检查所有 workers 是否已收到配置并加载。

* 检查所有 workers 是否已收到配置并加载

kayx23 · 2025-05-21T06:16:00Z

+}
+```
+
+当 1 个 workers 尚未初始化时


Suggested change

当 1 个 workers 尚未初始化时

当 1 个 workers 尚未初始化时：

kayx23 · 2025-05-21T06:16:11Z

+
+当所有 worker 都已加载配置时，返回 `ok`；否则，返回特定错误，错误代码为 `503`。以下是具体示例。
+
+当所有 worker 都已加载配置时


Suggested change

当所有 worker 都已加载配置时

当所有 worker 都已加载配置时：

kayx23

Others LGTM. Please fix for doc lint errors as well, likely due to punctuations.

kayx23 · 2025-05-21T06:23:51Z

 ### GET /status

-返回报告 APISIX worker 状态的 JSON：
+返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行，则建立 TCP 连接时请求将出错。否则，如果请求到达正在运行的工作线程，此端点将始终返回 ok


Suggested change

返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行，则建立 TCP 连接时请求将出错。否则，如果请求到达正在运行的工作线程，此端点将始终返回 ok

返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行，建立 TCP 连接时请求将报错。否则，如果请求到达正在运行的 worker，此端点将始终返回 ok。

feat: add healthcheck for standalone mode

c5fb85c

dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label May 8, 2025

Revolyssup marked this pull request as draft May 8, 2025 14:07

dosubot Bot added the enhancement New feature or request label May 8, 2025

Revolyssup added 13 commits May 9, 2025 02:10

fix typo

938a200

fix

8603920

fix test

ecf42be

add testcase

b589e28

modify test

5700a7e

remove sleep

4788196

fix

8311fe1

fix reload issue

5ba7356

fix lint

671c6e5

fix lint

75bbd45

Merge branch 'master' of github.com:apache/apisix into revolyssup/hea…

b3d7544

…lthcheck-standalone

fix lint

403bd68

send request twice

ea8ed7b

Revolyssup marked this pull request as ready for review May 12, 2025 18:32

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 12, 2025

fix lint

c9a6a9c

Revolyssup requested review from bzp2010 and nic-6443 May 12, 2025 19:50

nic-6443 reviewed May 13, 2025

View reviewed changes

Comment thread apisix/cli/config.lua Outdated

nic-6443 reviewed May 13, 2025

View reviewed changes

Comment thread apisix/cli/ngx_tpl.lua Outdated

Revolyssup added 3 commits May 13, 2025 13:01

make API provider agnostic

6c4541f

add support for etcd backed health check

70d2bd6

Merge branch 'revolyssup/healthcheck-standalone' of github.com:Revoly…

c8e639d

…ssup/apisix into revolyssup/healthcheck-standalone

dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels May 13, 2025

Revolyssup added 5 commits May 20, 2025 15:35

fix

1c599ad

fix bug introduced during merging

1c0cde6

revert

c4bb98b

add doc

b59923b

add chinese doc

5311d47

dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels May 20, 2025

Revolyssup added 2 commits May 20, 2025 16:33

fix doc lint

2487df8

fix lint

9cf7a67

Revolyssup requested review from bzp2010 and kayx23 May 20, 2025 11:15

bzp2010 reviewed May 20, 2025

View reviewed changes

nic-6443 previously approved these changes May 21, 2025

View reviewed changes

kayx23 reviewed May 21, 2025

View reviewed changes

apply doc suggestions

41e3988

Revolyssup dismissed nic-6443’s stale review via 41e3988 May 21, 2025 06:10

kayx23 reviewed May 21, 2025

View reviewed changes

apply suggestions

66b3114

kayx23 reviewed May 21, 2025

View reviewed changes

fix lint and apply suggestions

746c24f

kayx23 approved these changes May 21, 2025

View reviewed changes

nic-6443 approved these changes May 21, 2025

View reviewed changes

bzp2010 approved these changes May 21, 2025

View reviewed changes

Revolyssup merged commit e430a2b into apache:master May 21, 2025

Revolyssup deleted the revolyssup/healthcheck-standalone branch May 21, 2025 06:44

laz-xyr pushed a commit to laz-xyr/apisix that referenced this pull request Jun 19, 2025

feat: add healthcheck for sync configuration (apache#12200)

eb0a32d


		Returns `ok` when all workers have loaded the configuration, otherwise returns the specific error with `503` error code. Below are specific examples.

		When all workers have loaded the configuration

	在 Apache APISIX 中，状态 API 用于：
	在 Apache APISIX 中，Status API 用于：

	* 检查所有工作人员是否已收到并加载配置。
	* 检查所有 workers 是否已收到配置并加载。

	返回报告 APISIX 工作者状态的 JSON
	返回报告 APISIX worker 状态的 JSON：

	当特定工作器尚未加载配置时
	当特定 worker 尚未加载配置时：


		当所有 Worker 都已加载配置时，返回 `ok`；否则，返回特定错误，错误代码为 `503`。以下是具体示例。

		当所有 Worker 都已加载配置时

	When 1 workers has't been initialised
	When 1 workers has't been initialised:

	When a particular worker hasn't loaded the configuration
	When a particular worker hasn't loaded the configuration:

	* 检查所有 workers 是否已收到配置并加载。
	* 检查所有 workers 是否已收到配置并加载

	当 1 个 workers 尚未初始化时
	当 1 个 workers 尚未初始化时：

	当所有 worker 都已加载配置时
	当所有 worker 都已加载配置时：

	返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行，则建立 TCP 连接时请求将出错。否则，如果请求到达正在运行的工作线程，此端点将始终返回 ok
	返回报告 APISIX 工作人员状态的 JSON。如果 APISIX 未运行，建立 TCP 连接时请求将报错。否则，如果请求到达正在运行的 worker，此端点将始终返回 ok。

Uh oh!

Conversation

Revolyssup commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Uh oh!

Uh oh!

bzp2010 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Revolyssup May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kayx23 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Revolyssup commented May 8, 2025 •

edited

Loading

Revolyssup May 21, 2025 •

edited

Loading