node-status

目录

插件简介

node-statusAPISIX 的请求状态查询插件,返回基本的状态信息。

插件属性

无。

插件接口

插件增加接口 /apisix/status,可通过 interceptors 保护该接口。

启用插件

  1. 配置文件 conf/config.yaml 的 plugin list 中配置 node-status
  1. plugins: # plugin list
  2. - example-plugin
  3. - limit-req
  4. - node-status
  5. - jwt-auth
  6. - zipkin
  7. ......

启动 APISIX 之后,即可访问该插件提供的接口,获得基本的状态信息。

  1. 在创建 route 时添加插件 node-status
  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  2. {
  3. "uri": "/route1",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "192.168.1.100:80:": 1
  8. }
  9. },
  10. "plugins": {
  11. "node-status":{}
  12. }
  13. }'

发送该请求的前提是 apisix/conf/config.yaml 中已经配置 node-status,此时 node-status 插件对该请求处理无影响,所以一般不会将 node-status 插件设置到路由中。

测试插件

  1. 发送请求
  1. $ curl localhost:9080/apisix/status -i
  2. HTTP/1.1 200 OK
  3. Date: Tue, 03 Nov 2020 11:12:55 GMT
  4. Content-Type: text/plain; charset=utf-8
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server
  8. {"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
  1. plugins: # plugin list
  2. - example-plugin
  3. - limit-req
  4. - jwt-auth
  5. - zipkin
  6. ......
  1. 删除 route 中的 node-status 插件信息
  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  2. {
  3. "uri": "/route1",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "nodes": {
  7. "192.168.1.100:80": 1
  8. }
  9. },
  10. "plugins": {}
  11. }'