docs: add an FAQ item for apisix high latency due to etcd #7906

hansedong · 2022-09-13T09:14:18Z

Signed-off-by: hansedong [email protected]

Description

Add an FAQ item for apisix high latency due to Etcd

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)

tokers

Thanks for the contribution!

Please wrap the version number with the back quota. Also, rename Etcd to ETCD.

docs/en/latest/FAQ.md

tokers · 2022-09-13T09:46:08Z

docs/en/latest/FAQ.md

+
+```
+
+At present, Etcd officially maintains two main branches, 3.4 and 3.5.


Suggested change

At present, Etcd officially maintains two main branches, 3.4 and 3.5.

At present, Etcd officially maintains two main branches, `3.4` and `3.5`.

tokers · 2022-09-13T09:47:18Z

docs/en/latest/FAQ.md

+
+1. Change the communication method between APISIX and Etcd from HTTPS to HTTP (not recommended).
+2. Fallback version to 3.4.20 (not recommended).
+3. Clone the Etcd source code and compile the release-3.5 branch directly (this branch has fixed the problem of HTTP2 connections, but the new version has not been released yet). This method is recommended.


That's also not a recommended way to change the ETCD source code since users may deploy ETCD via image.

hansedong · 2022-09-13T10:25:36Z

@tokers I made some changes, please help to do a review, thanks.

SylviaBABY · 2022-09-14T01:22:11Z

docs/zh/latest/FAQ.md

+这些延迟问题，严重影响了 APISIX 的服务稳定性，而之所以会出现这类问题，主要是因为 ETCD 对外提供了 2 种操作方式：HTTP（HTTPS）、gRPC。而 APISIX 是基于 HTTP（HTTPS）协议来操作 ETCD 的。
+在这个场景中，ETCD 存在一个关于 HTTP/2 的 BUG：如果通过 HTTPS 操作 ETCD（HTTP 不受影响），HTTP/2 的连接数上限为 Golang 默认的 `250` 个。
+所以，当 APISIX 数据面节点数较多时，一旦所有 APISIX 节点与 ETCD 连接数超过这个上限，则 APISIX 的接口响应会非常的慢。


Suggested change

这些延迟问题，严重影响了 APISIX 的服务稳定性，而之所以会出现这类问题，主要是因为 ETCD 对外提供了 2 种操作方式：HTTP（HTTPS）、gRPC。而 APISIX 是基于 HTTP（HTTPS）协议来操作 ETCD 的。

在这个场景中，ETCD 存在一个关于 HTTP/2 的 BUG：如果通过 HTTPS 操作 ETCD（HTTP 不受影响），HTTP/2 的连接数上限为 Golang 默认的 `250` 个。

所以，当 APISIX 数据面节点数较多时，一旦所有 APISIX 节点与 ETCD 连接数超过这个上限，则 APISIX 的接口响应会非常的慢。

这些延迟问题，严重影响了 APISIX 的服务稳定性。之所以会出现这类问题，主要是因为 ETCD 对外提供了 2 种操作方式：HTTP（HTTPS）、gRPC，而 APISIX 是基于 HTTP（HTTPS）协议来操作 ETCD 的。

在上述场景中，ETCD 存在一个关于 HTTP/2 的 BUG：如果通过 HTTPS 操作 ETCD（HTTP 不受影响），HTTP/2 的连接数上限为 Golang 默认的 `250` 个。

所以，当 APISIX 数据面节点数较多时，一旦所有 APISIX 节点与 ETCD 连接数超过这个上限，则 APISIX 的接口响应会变得非常慢。

SylviaBABY · 2022-09-14T01:22:53Z

docs/zh/latest/FAQ.md

+
+```
+
+目前，ETCD 官方主要维护了 `3.4` 和 `3.5` 2 个主要版本。


Suggested change

目前，ETCD 官方主要维护了 `3.4` 和 `3.5` 2 个主要版本。

目前，ETCD 官方主要维护了 `3.4` 和 `3.5` 这两个主要版本。在 `3.4` 系列中，近期发布的 `3.4.20` 版本已修复了这个问题。至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）仍尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以参考以下几种方式解决这个问题：

SylviaBABY · 2022-09-14T01:24:44Z

docs/zh/latest/FAQ.md

+而 `3.4` 已有近期发布的 `3.4.20` 修复了这个问题。
+至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）也尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以有几种方式解决这个问题：


Suggested change

而 `3.4` 已有近期发布的 `3.4.20` 修复了这个问题。

至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）也尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以有几种方式解决这个问题：

SylviaBABY · 2022-09-14T01:26:04Z

docs/zh/latest/FAQ.md

+而 `3.4` 已有近期发布的 `3.4.20` 修复了这个问题。
+至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）也尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以有几种方式解决这个问题：
+
+1. APISIX 与 ETCD 的通讯方式，由 HTTPS 改为 HTTP。


Suggested change

1. APISIX 与 ETCD 的通讯方式，由 HTTPS 改为 HTTP。

1. 将 APISIX 与 ETCD 的通讯方式由 HTTPS 改为 HTTP。

SylviaBABY · 2022-09-14T01:27:06Z

docs/zh/latest/FAQ.md

+至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）也尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以有几种方式解决这个问题：
+
+1. APISIX 与 ETCD 的通讯方式，由 HTTPS 改为 HTTP。
+2. 回退版本到 `3.4.20`。


Suggested change

2. 回退版本到 `3.4.20`。

2. 将 ETCD 版本回退到 `3.4.20`。

SylviaBABY · 2022-09-14T01:34:18Z

docs/en/latest/FAQ.md

+
+```
+
+At present, ETCD officially maintains two main branches, `3.4` and `3.5`.


Suggested change

At present, ETCD officially maintains two main branches, `3.4` and `3.5`.

ETCD officially maintains two main versions, `3.4` and `3.5`. In the `3.4` series, the recently released `3.4.20` version has fixed this issue. As for the `3.5` version, the official was preparing to release the `3.5.5` version a long time ago, but it has not been released as of now (2022.09.13). So, if you are using ETCD version less than `3.5.5`, you can refer to the following ways to solve this problem:

SylviaBABY · 2022-09-14T01:34:32Z

docs/en/latest/FAQ.md

+The `3.4` branch has the recently released `3.4.20` which fixes this issue.
+As for the `3.5` branch, in fact, the official is preparing to release the `3.5.5` version a long time ago, but it has not been released so far. So, if you are using a version of ETCD less than `3.5.5`, there are several ways to solve this problem:


Suggested change

The `3.4` branch has the recently released `3.4.20` which fixes this issue.

As for the `3.5` branch, in fact, the official is preparing to release the `3.5.5` version a long time ago, but it has not been released so far. So, if you are using a version of ETCD less than `3.5.5`, there are several ways to solve this problem:

SylviaBABY · 2022-09-14T01:35:16Z

docs/en/latest/FAQ.md

+As for the `3.5` branch, in fact, the official is preparing to release the `3.5.5` version a long time ago, but it has not been released so far. So, if you are using a version of ETCD less than `3.5.5`, there are several ways to solve this problem:
+
+1. Change the communication method between APISIX and ETCD from HTTPS to HTTP.
+2. Fallback version to `3.4.20`.


Suggested change

2. Fallback version to `3.4.20`.

2. Roll back the ETCD version to `3.4.20`.

guitu168 · 2022-09-13T12:29:56Z

docs/zh/latest/FAQ.md

@@ -627,6 +627,58 @@ curl http://127.0.0.1:9180/apisix/admin/routes/health-info \

 :::

+## APISIX 与 ETCD 相关的延迟较高的问题有哪些，如何修复？


please change ETCD to etcd. please refer to https://etcd.io/

@hansedong I think this comment is not just to modify etcd in the title to the correct format, but to modify all the parts of etcd in this content to the correct format

@SylviaBABY It's fixed, thanks for pointing out the problem.

guitu168 · 2022-09-13T12:32:11Z

docs/zh/latest/FAQ.md

+make GOOS=linux GOARCH=amd64
+```
+
+编译的二进制在 bin 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。


Suggested change

编译的二进制在 bin 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。

编译的二进制在 `bin` 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。

guitu168 · 2022-09-14T01:41:27Z

docs/zh/latest/FAQ.md

+
+编译的二进制在 bin 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。
+
+相关的 issue 或 PR 可以参考：


Suggested change

相关的 issue 或 PR 可以参考：

更多信息，请参考：

guitu168 · 2022-09-14T01:43:10Z

docs/zh/latest/FAQ.md

+- https://github.com/etcd-io/etcd/issues/14185
+- https://github.com/apache/apisix/issues/7078
+- https://github.com/apache/apisix/issues/7353
+- https://github.com/etcd-io/etcd/pull/14169


Suggested change

- https://github.com/etcd-io/etcd/issues/14185

- https://github.com/apache/apisix/issues/7078

- https://github.com/apache/apisix/issues/7353

- https://github.com/etcd-io/etcd/pull/14169

- [when etcd node have many http long polling connections, it may cause etcd to respond slowly to http requests.](https://github.com/etcd-io/etcd/issues/14185)

- [bug: when apisix starts for a while, its communication with etcd starts to time out](https://github.com/apache/apisix/issues/7078)

- [the prometheus metrics API is tool slow](https://github.com/apache/apisix/issues/7353)

- [Support configuring `MaxConcurrentStreams` for http2](https://github.com/etcd-io/etcd/pull/14169)

guitu168 · 2022-09-14T01:43:53Z

docs/en/latest/FAQ.md

+- https://github.com/etcd-io/etcd/issues/14185
+- https://github.com/apache/apisix/issues/7078
+- https://github.com/apache/apisix/issues/7353
+- https://github.com/etcd-io/etcd/pull/14169


Suggested change

- https://github.com/etcd-io/etcd/issues/14185

- https://github.com/apache/apisix/issues/7078

- https://github.com/apache/apisix/issues/7353

- https://github.com/etcd-io/etcd/pull/14169

- [when etcd node have many http long polling connections, it may cause etcd to respond slowly to http requests.](https://github.com/etcd-io/etcd/issues/14185)

- [bug: when apisix starts for a while, its communication with etcd starts to time out](https://github.com/apache/apisix/issues/7078)

- [the prometheus metrics API is tool slow](https://github.com/apache/apisix/issues/7353)

- [Support configuring `MaxConcurrentStreams` for http2](https://github.com/etcd-io/etcd/pull/14169)

guitu168 · 2022-09-14T01:44:40Z

docs/en/latest/FAQ.md

+
+The compiled binary is in the bin directory, replace it with the ETCD binary of your server environment, and then restart ETCD:
+
+Related issues or PRs can refer to：


Suggested change

Related issues or PRs can refer to：

For more information, please refer to:

guitu168 · 2022-09-14T01:45:05Z

docs/en/latest/FAQ.md

+2. Fallback version to `3.4.20`.
+3. Clone the ETCD source code and compile the `release-3.5` branch directly (this branch has fixed the problem of HTTP/2 connections, but the new version has not been released yet).
+
+The way to recompile ETCD is as follows：


Suggested change

The way to recompile ETCD is as follows：

The way to recompile etcd is as follows:

guitu168 · 2022-09-14T01:45:28Z

docs/en/latest/FAQ.md

+These problems related to higher latency seriously affect the service stability of APISIX, and the reason why such problems occur is mainly because ETCD provides two modes of operation: HTTP (HTTPS) and gRPC. And APISIX uses the HTTP (HTTPS) protocol to operate ETCD.
+In this scenario, ETCD has a bug about HTTP/2: if ETCD is operated over HTTPS (HTTP is not affected), the upper limit of HTTP/2 connections is the default `250` in Golang. Therefore, when the number of APISIX data plane nodes is large, once the number of connections between all APISIX nodes and ETCD exceeds this upper limit, the response of APISIX API interface will be very slow.
+
+In Golang, the default upper limit of HTTP/2 connections is `250`, the code is as follows：


Suggested change

In Golang, the default upper limit of HTTP/2 connections is `250`, the code is as follows：

In Golang, the default upper limit of HTTP/2 connections is `250`, the code is as follows:

hansedong · 2022-09-14T02:11:51Z

@hf400159 Fixed as you suggested. Thank you very much for taking the time to point out the problem so patiently.

Signed-off-by: hansedong <[email protected]>

Signed-off-by: hansedong <[email protected]> Signed-off-by: hansedong <[email protected]>

hansedong mentioned this pull request Sep 13, 2022

the prometheus metrics API is tool slow #7353

Closed

hansedong changed the title ~~docs: add FAQ for apisix high latency due to etcd~~ docs: add an FAQ item for apisix high latency due to etcd Sep 13, 2022

tokers reviewed Sep 13, 2022

View reviewed changes

hansedong force-pushed the master branch 4 times, most recently from ea566bf to 47606db Compare September 13, 2022 10:23

hansedong force-pushed the master branch from 47606db to 9205729 Compare September 14, 2022 01:05

SylviaBABY reviewed Sep 14, 2022

View reviewed changes

guitu168 reviewed Sep 14, 2022

View reviewed changes

hansedong force-pushed the master branch from 9205729 to 046ca7c Compare September 14, 2022 02:09

hansedong force-pushed the master branch 2 times, most recently from c8683ee to 974ed0f Compare September 14, 2022 13:11

docs: add an FAQ item for apisix high latency due to etcd

b1f7492

Signed-off-by: hansedong <[email protected]>

hansedong force-pushed the master branch from 974ed0f to b1f7492 Compare September 15, 2022 01:49

SylviaBABY approved these changes Sep 15, 2022

View reviewed changes

SylviaBABY requested review from guitu168 and tokers and removed request for guitu168 September 15, 2022 02:02

bzp2010 approved these changes Sep 15, 2022

View reviewed changes

SylviaBABY merged commit ed437af into apache:master Sep 15, 2022

Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request Nov 4, 2022

docs: add an FAQ item for apisix high latency due to etcd (apache#7906)

048b404

Signed-off-by: hansedong <[email protected]> Signed-off-by: hansedong <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add an FAQ item for apisix high latency due to etcd #7906

docs: add an FAQ item for apisix high latency due to etcd #7906

hansedong commented Sep 13, 2022 •

edited

Loading

tokers left a comment

tokers Sep 13, 2022

tokers Sep 13, 2022

hansedong commented Sep 13, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

SylviaBABY Sep 14, 2022

guitu168 Sep 13, 2022

SylviaBABY Sep 15, 2022

hansedong Sep 15, 2022

guitu168 Sep 13, 2022

guitu168 Sep 14, 2022

guitu168 Sep 14, 2022

guitu168 Sep 14, 2022

guitu168 Sep 14, 2022

guitu168 Sep 14, 2022

guitu168 Sep 14, 2022

hansedong commented Sep 14, 2022


		```

		At present, Etcd officially maintains two main branches, 3.4 and 3.5.


		```

		目前，ETCD 官方主要维护了 `3.4` 和 `3.5` 2 个主要版本。

		而 `3.4` 已有近期发布的 `3.4.20` 修复了这个问题。
		至于 `3.5` 版本，其实，官方很早之前就在筹备发布 `3.5.5` 版本了，但截止目前（2022.09.13）也尚未发布。所以，如果你使用的是 ETCD 的版本小于 `3.5.5`，可以有几种方式解决这个问题：

	1. APISIX 与 ETCD 的通讯方式，由 HTTPS 改为 HTTP。
	1. 将 APISIX 与 ETCD 的通讯方式由 HTTPS 改为 HTTP。

	2. 回退版本到 `3.4.20`。
	2. 将 ETCD 版本回退到 `3.4.20`。

		The `3.4` branch has the recently released `3.4.20` which fixes this issue.
		As for the `3.5` branch, in fact, the official is preparing to release the `3.5.5` version a long time ago, but it has not been released so far. So, if you are using a version of ETCD less than `3.5.5`, there are several ways to solve this problem:

	2. Fallback version to `3.4.20`.
	2. Roll back the ETCD version to `3.4.20`.

		@@ -627,6 +627,58 @@ curl http://127.0.0.1:9180/apisix/admin/routes/health-info \

		:::

		## APISIX 与 ETCD 相关的延迟较高的问题有哪些，如何修复？

	编译的二进制在 bin 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。
	编译的二进制在 `bin` 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。


		编译的二进制在 bin 目录下，将其替换掉你服务器环境的 ETCD 二进制后，然后重启 ETCD 即可。

		相关的 issue 或 PR 可以参考：

	相关的 issue 或 PR 可以参考：
	更多信息，请参考：


		The compiled binary is in the bin directory, replace it with the ETCD binary of your server environment, and then restart ETCD:

		Related issues or PRs can refer to：

	Related issues or PRs can refer to：
	For more information, please refer to:

	The way to recompile ETCD is as follows：
	The way to recompile etcd is as follows:

	In Golang, the default upper limit of HTTP/2 connections is `250`, the code is as follows：
	In Golang, the default upper limit of HTTP/2 connections is `250`, the code is as follows:

docs: add an FAQ item for apisix high latency due to etcd #7906

docs: add an FAQ item for apisix high latency due to etcd #7906

Conversation

hansedong commented Sep 13, 2022 • edited Loading

Description

Checklist

tokers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hansedong commented Sep 13, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hansedong commented Sep 14, 2022

hansedong commented Sep 13, 2022 •

edited

Loading