apisix/docs/zh/latest/FAQ.md

397 lines
13 KiB
Markdown
Raw Normal View History

---
title: 常见问题
---
2019-10-31 09:27:28 +08:00
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-->
2019-08-07 13:12:40 +08:00
## 为什么要做 API 网关?不是已经有其他的开源网关了吗?
微服务领域对 API 网关有新的需求:更高的灵活性、更高的性能要求,以及云原生的贴合。
## APISIX 和其他的 API 网关有什么不同之处?
APISIX 基于 etcd 来完成配置的保存和同步,而不是 postgres 或者 MySQL 这类关系型数据库。
这样不仅去掉了轮询,让代码更加的简洁,配置同步也更加实时。同时系统也不会存在单点,可用性更高。
另外APISIX 具备动态路由和插件热加载,特别适合微服务体系下的 API 管理。
## APISIX 的性能怎么样?
APISIX 设计和开发的目标之一,就是业界最高的性能。具体测试数据见这里:[benchmark](https://github.com/apache/apisix/blob/master/docs/en/latest/benchmark.md)
2019-08-07 13:12:40 +08:00
APISIX 是当前性能最好的 API 网关,单核 QPS 达到 2.3 万,平均延时仅有 0.6 毫秒。
## APISIX 是否有控制台界面?
是的APISIX 具有功能强大的 Dashboard。APISIX 与 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 是相互独立的项目,你可以部署 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来操作 APISIX。
2019-08-07 13:12:40 +08:00
## 我可以自己写插件吗?
当然可以APISIX 提供了灵活的自定义插件,方便开发者和企业编写自己的逻辑。
[如何开发插件](plugin-develop.md)
2019-08-23 09:52:41 +08:00
## 我们为什么选择 etcd 作为配置中心?
2019-08-23 09:52:41 +08:00
对于配置中心配置存储只是最基本功能APISIX 还需要下面几个特性:
2019-08-23 09:52:41 +08:00
1. 集群支持
2. 事务
3. 历史版本管理
4. 变化通知
5. 高性能
APISIX 需要一个配置中心,上面提到的很多功能是传统关系型数据库和 KV 数据库是无法提供的。与 etcd 同类软件还有 Consul、ZooKeeper 等,更详细比较可以参考这里:[etcd why](https://etcd.io/docs/v3.4.0/learning/why/),在将来也许会支持其他配置存储方案。
## 为什么在用 Luarocks 安装 APISIX 依赖时会遇到超时,很慢或者不成功的情况?
遇到 luarocks 慢的问题,有以下两种可能:
1. luarocks 安装所使用的服务器不能访问
2. 你所在的网络到 github 服务器之间有地方对 `git` 协议进行封锁
针对第一个问题,你可以使用 https_proxy 或者使用 `--server` 选项来指定一个你可以访问或者访问更快的
luarocks 服务。 运行 `luarocks config rocks_servers` 命令(这个命令在 luarocks 3.0 版本后开始支持)
可以查看有哪些可用服务。对于中国大陆用户,你可以使用 `luarocks.cn` 这一个 luarocks 服务。
我们已经封装好了选择服务地址的操作:
```bash
LUAROCKS_SERVER=https://luarocks.cn make deps
```
如果使用代理仍然解决不了这个问题,那可以在安装的过程中添加 `--verbose` 选项来查看具体是慢在什么地方。排除前面的
第一种情况,只可能是第二种,`git` 协议被封。这个时候可以执行 `git config --global url."https://".insteadOf git://` 命令使用 `https` 协议替代。
2019-12-11 13:44:43 +08:00
## 如何通过 APISIX 支持灰度发布?
2019-12-11 13:44:43 +08:00
2020-07-29 19:23:08 +08:00
比如,`foo.com/product/index.html?id=204&page=2`, 根据 URL 中 query string 中的 `id` 作为条件来灰度发布:
2019-12-11 13:44:43 +08:00
1. A 组id <= 1000
2. B 组id > 1000
2019-12-11 13:44:43 +08:00
有两种不同的方法来实现:
1、使用 route 的 `vars` 字段来实现
2019-12-12 15:41:13 +08:00
```shell
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
2019-12-11 13:44:43 +08:00
{
"uri": "/index.html",
"vars": [
2019-12-12 15:41:13 +08:00
["arg_id", "<=", "1000"]
],
2019-12-11 13:44:43 +08:00
"plugins": {
"redirect": {
"uri": "/test?group_id=1"
}
}
}'
curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
2019-12-11 13:44:43 +08:00
{
"uri": "/index.html",
"vars": [
2019-12-12 15:41:13 +08:00
["arg_id", ">", "1000"]
],
2019-12-11 13:44:43 +08:00
"plugins": {
"redirect": {
"uri": "/test?group_id=2"
}
}
}'
```
更多的 lua-resty-radixtree 匹配操作,可查看操作列表:
https://github.com/api7/lua-resty-radixtree#operator-list
2、通过 traffic-split 插件来实现
详细使用示例请参考 [traffic-split.md](plugins/traffic-split.md) 插件文档。
## 如何支持 http 自动跳转到 https
比如,将 `http://foo.com` 重定向到 `https://foo.com`
有几种不同的方法来实现:
1. 直接使用 `redirect` 插件的 `http_to_https` 功能:
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/hello",
"host": "foo.com",
"plugins": {
"redirect": {
"http_to_https": true
}
}
}'
```
2. 结合高级路由规则 `vars``redirect` 插件一起使用:
```shell
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/hello",
"host": "foo.com",
"vars": [
[
"scheme",
"==",
"http"
]
],
"plugins": {
"redirect": {
"uri": "https://$host$request_uri",
"ret_code": 301
}
}
}'
```
3. 使用`serverless`插件:
```shell
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/hello",
"plugins": {
"serverless-pre-function": {
"phase": "rewrite",
"functions": ["return function() if ngx.var.scheme == \"http\" and ngx.var.host == \"foo.com\" then ngx.header[\"Location\"] = \"https://foo.com\" .. ngx.var.request_uri; ngx.exit(ngx.HTTP_MOVED_PERMANENTLY); end; end"]
}
}
}'
```
然后测试下是否生效:
```shell
curl -i -H 'Host: foo.com' http://127.0.0.1:9080/hello
```
响应体应该是:
```
HTTP/1.1 301 Moved Permanently
Date: Mon, 18 May 2020 02:56:04 GMT
Content-Type: text/html
Content-Length: 166
Connection: keep-alive
Location: https://foo.com/hello
Server: APISIX web server
<html>
<head><title>301 Moved Permanently</title></head>
<body>
<center><h1>301 Moved Permanently</h1></center>
<hr><center>openresty</center>
</body>
</html>
```
## 如何修改日志等级
默认的 APISIX 日志等级为`warn`,如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。
具体步骤:
1、修改 conf/config.yaml 中的 nginx log 配置参数`error_log_level: "warn"`为`error_log_level: "info"`。
2、重启抑或 reload APISIX
之后便可以在 logs/error.log 中查看到 info 的日志了。
## 如何加载自己编写的插件
Apache APISIX 的插件支持热加载。
具体怎么做参考 [插件](./plugins.md) 中关于“热加载”的部分。
## 如何让 APISIX 在处理 HTTP 或 HTTPS 请求时监听多个端口
默认情况下APISIX 在处理 HTTP 请求时只监听 9080 端口。如果你想让 APISIX 监听多个端口,你需要修改配置文件中的相关参数,具体步骤如下:
1. 修改 `conf/config.yaml` 中 HTTP 端口监听的参数`node_listen`,示例:
```
apisix:
node_listen:
- 9080
- 9081
- 9082
```
处理 HTTPS 请求也类似,修改`conf/config.yaml`中 HTTPS 端口监听的参数`ssl.listen_port`,示例:
```
apisix:
ssl:
listen_port:
- 9443
- 9444
- 9445
```
2.重启抑或 reload APISIX
2020-10-31 17:40:07 +08:00
## APISIX 利用 etcd 如何实现毫秒级别的配置同步
2020-10-31 17:40:07 +08:00
etcd 提供订阅接口用于监听指定关键字、目录是否发生变更(比如: [watch](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watch)、[watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir))。
2020-10-31 17:40:07 +08:00
APISIX 主要使用 [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) 监视目录内容变更:
* 如果监听目录没有数据更新:该调用会被阻塞,直到超时或其他错误返回。
* 如果监听目录有数据更新etcd 将立刻返回订阅(毫秒级)到的新数据APISIX 将它更新到内存缓存。
2020-10-31 17:40:07 +08:00
借助 etcd 增量通知毫秒级特性APISIX 也就完成了毫秒级的配置同步。
## 如何自定义 APISIX 实例 id
默认情况下APISIX 会从 `conf/apisix.uid` 中读取实例 id。如果找不到且没有配置 idAPISIX 会生成一个 `uuid` 作为实例 id。
如果你想指定一个有意义的 id 来绑定 APISIX 实例到你的内部系统,你可以在 `conf/config.yaml` 中进行配置,示例:
```
apisix:
id: "your-meaningful-id"
```
2020-12-03 12:31:57 +08:00
## 为什么 `error.log` 中会有许多诸如 "failed to fetch data from etcd, failed to read etcd dir, etcd key: xxxxxx" 的错误?
首先请确保 APISIX 和 etcd 之间不存在网络分区的情况。
如果网络的确是健康的,请检查你的 etcd 集群是否启用了 [gRPC gateway](https://etcd.io/docs/v3.4.0/dev-guide/api_grpc_gateway/) 特性。然而,当你使用命令行参数或配置文件启动 etcd 时,此特性的默认启用情况又是不同的。
1. 当使用命令行参数启动 etcd该特性默认被启用相关选项是 `enable-grpc-gateway`
```sh
etcd --enable-grpc-gateway --data-dir=/path/to/data
```
注意该选项并没有展示在 `etcd --help` 的输出中。
2. 使用配置文件时,该特性默认被关闭,请明确启用 `enable-grpc-gateway` 配置项。
```json
# etcd.json
{
"enable-grpc-gateway": true,
"data-dir": "/path/to/data"
}
```
事实上这种差别已经在 etcd 的 master 分支中消除,但并没有向后移植到已经发布的版本中,所以在部署 etcd 集群时,依然需要小心。
## 如何创建高可用的 Apache APISIX 集群?
APISIX 的高可用可分为两个部分:
1、Apache APISIX 的数据平面是无状态的,可以进行随意的弹性伸缩,前面加一层 LB 即可。
2、Apache APISIX 的控制平面是依赖于 `etcd cluster` 的高可用实现的,不需要任何关系型数据库的依赖。
## 为什么源码安装中执行 `make deps` 命令失败?
2021-03-16 19:31:28 +08:00
1、当执行 `make deps` 命令时,发生诸如下面所示的错误。这是由于缺少 OpenResty 的 `openssl` 开发软件包导致的,你需要先安装它。请参考 [install-dependencies.md](install-dependencies.md) 文档进行安装。
```shell
$ make deps
......
Error: Failed installing dependency: https://luarocks.org/luasec-0.9-1.src.rock - Could not find header file for OPENSSL
No file openssl/ssl.h in /usr/local/include
You may have to install OPENSSL in your system and/or pass OPENSSL_DIR or OPENSSL_INCDIR to the luarocks command.
Example: luarocks install luasec OPENSSL_DIR=/usr/local
make: *** [deps] Error 1
```
## 如何通过 APISIX 代理访问 APISIX Dashboard
1、保持 APISIX 代理端口和 Admin API 端口不同(或禁用 Admin API。例如`conf/config.yaml` 中做如下配置。
Admin API 使用独立端口 9180
```yaml
apisix:
port_admin: 9180 # use a separate port
```
2、添加 APISIX Dashboard 的代理路由:
注意:这里的 APISIX Dashboard 服务正在监听 `127.0.0.1:9000`
```shell
curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uris":[ "/*" ],
"name":"apisix_proxy_dashboard",
"upstream":{
"nodes":[
{
"host":"127.0.0.1",
"port":9000,
"weight":1
}
],
"type":"roundrobin"
}
}'
```
## route 的 `uri` 如何进行正则匹配
这里通过 route 的 `vars` 字段来实现 uri 的正则匹配。
```shell
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/*",
"vars": [
["uri", "~~", "^/[a-z]+$"]
],
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'
```
测试请求:
```shell
# uri 匹配成功
$ curl http://127.0.0.1:9080/hello -i
HTTP/1.1 200 OK
...
# uri 匹配失败
curl http://127.0.0.1:9080/12ab -i
HTTP/1.1 404 Not Found
...
```
在 route 中,我们可以通过 `uri` 结合 `vars` 字段来实现更多的条件匹配,`vars` 的更多使用细节请参考 [lua-resty-expr](https://github.com/api7/lua-resty-expr)。