Skip to main content
Version: 2.14

node-status

描述#

node-status 是 APISIX 的请求状态查询插件，返回基本的状态信息。

插件属性#

无。

插件接口#

插件增加接口 /apisix/status，需要通过 public-api 插件来暴露它。

启用插件#

  1. 配置文件 conf/config.yaml 的 plugin list 中配置 node-status
plugins:                          # plugin list
  - example-plugin
  - limit-req
  - node-status
  - jwt-auth
  - zipkin
  ......
  1. 为状态 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": {}
    }
}'

测试插件#

  1. 发送请求
$ curl localhost: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"}
  1. 参数说明
参数说明
status状态信息
total客户端请求总数
waiting当前等待客户端请求的空闲连接数
accepted已经接受的客户端连接总数
writing当前正在写给客户端响应的连接数
handled已经处理的连接总数，通常等于 accepted
active当前活跃的客户端连接数
reading当前正在读取请求头的连接数
idAPISIX uid 信息，保存在 apisix/conf/apisix.uid

禁用插件#

  1. 配置文件 apisix/conf/config.yaml 的 plugin list 中删除 node-status
plugins:                          # plugin list
  - example-plugin
  - limit-req
  - jwt-auth
  - zipkin
  ......
  1. 删除 route 中的 node-status 插件信息
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
    "uri": "/route1",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "192.168.1.100:80": 1
        }
    },
    "plugins": {}
}'