Skip to main content
Version: 2.15

node-status

描述#

node-status 插件可用于通过暴露的 API 查询 APISIX 的请求状态，并返回基本的状态信息。

插件属性#

无。

插件接口#

该插件将会增加 /apisix/status 的接口用来暴露 APISIX 的状态，你需要通过 public-api 插件来暴露该接口。

启用插件#

node-status 插件默认为禁用状态，如果你需要使用该插件，请在配置文件 ./conf/config.yaml 中启用它：

./conf/config.yaml
plugins:
  - limit-req
  - node-status
  - jwt-auth
  - zipkin
  ......

你需要为 /apisix/status API 配置路由，并使用 public-api 插件暴露它。

curl http://127.0.0.1:9080/apisix/admin/routes/ns -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/apisix/status",
    "plugins": {
        "public-api": {}
    }
}'

测试插件#

完成上述配置后，你可以通过以下命令向 /apisix/status 发送请求以获取状态信息。

curl http://127.0.0.1:9080/apisix/status -i
HTTP/1.1 200 OK
Date: Tue, 03 Nov 2020 11:12:55 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: APISIX web server

{"status":{"total":"23","waiting":"0","accepted":"22","writing":"1","handled":"22","active":"1","reading":"0"},"id":"6790a064-8f61-44ba-a6d3-5df42f2b1bb3"}

返回结果中的参数释义如下：

参数说明
statusAPISIX 的状态信息。
total客户端请求总数。
waiting当前等待客户端请求的空闲连接数。
accepted当前已经接受的客户端连接总数。
writing当前正在写给客户端响应的连接数。
handled当前已经处理的连接总数，除非达到其他资源的限制，否则此值与 accepted 相同。
active当前活跃的客户端连接数。
reading当前正在读取请求头的连接数。
idAPISIX UID 信息，保存在 ./conf/apisix.uid 文件中。

禁用插件#

如果你不再需要该插件，可以从配置文件 (./conf/config.yaml) 中删除它：

conf/config.yaml
  - limit-req
  - jwt-auth
  - zipkin
  ......

你也可以移除暴露 /apisix/status 接口的路由。

curl http://127.0.0.1:9080/apisix/admin/routes/ns -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X DELETE