You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/11/03 13:51:38 UTC
[GitHub] [apisix] HelloBug0 opened a new pull request #2615: doc: node-status.md
HelloBug0 opened a new pull request #2615:
URL: https://github.com/apache/apisix/pull/2615
This is the description of plugin node-status in Chinese, and I'd love to submit the document in lEnglish later.
This PR is relate with [issue#2379](https://github.com/apache/apisix/issues/2379)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517034210
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
Review comment:
add a blank line
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
Review comment:
need a space between Chinese and English
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "39.97.63.215:80:": 1
Review comment:
we can use a local IP address, eg: `192.168.1.100:80`
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
Review comment:
and please fix other similar points
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
Review comment:
we can remove this line, it is not important
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
Review comment:
ditto
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517034210
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
Review comment:
add a blank line before this line
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r518462839
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
Review comment:
Oh!! My suggestion is lost, just ignored this one.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
spacewander commented on pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#issuecomment-722785519
@HelloBug0
Wait for your English one 😃
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r518458134
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
Review comment:
This means?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517037833
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
Review comment:
Thanks for your comments, and here you mean remove from line 61 to line 81?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517055790
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "39.97.63.215:80:": 1
+ }
+ },
+ "plugins": {
+ "node-status":{}
+ }
+}'
+```
+
+发送该请求的前提是apisix/conf/conf.yaml中已经配置node-status，此时node-status插件对该请求处理无影响，所以一般不会将node-status插件设置到路由中。
Review comment:
OK, Thanks~
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517766186
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
Review comment:
I misunderstand this comment before. I have changed it in the newest commit. Thanks for your comments : )
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#issuecomment-722810511
Tracking issue https://github.com/apache/apisix/issues/2379
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
membphis commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517757526
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
Review comment:
@HelloBug0 any news?
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
Review comment:
only remove `"methods": ["PUT", "GET"],` ^_^
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] membphis commented on pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
membphis commented on pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#issuecomment-721219914
CI failed, please take a look at the output: https://github.com/apache/apisix/pull/2615/checks?check_run_id=1347360640#step:11:51
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517762968
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
Review comment:
OK, I will remove it now~
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517047381
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "39.97.63.215:80:": 1
+ }
+ },
+ "plugins": {
+ "node-status":{}
+ }
+}'
+```
+
+发送该请求的前提是apisix/conf/conf.yaml中已经配置node-status，此时node-status插件对该请求处理无影响，所以一般不会将node-status插件设置到路由中。
Review comment:
Do you mean `apisix/conf/config.yaml`? Also, need spaces between Chinese and English word.
Please fix other similar places in the PR.
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
Review comment:
Need a space after `interceptors.md)`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Firstsawyou commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517045677
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "39.97.63.215:80:": 1
+ }
+ },
+ "plugins": {
+ "node-status":{}
+ }
+}'
+```
+
+发送该请求的前提是apisix/conf/conf.yaml中已经配置node-status，此时node-status插件对该请求处理无影响，所以一般不会将node-status插件设置到路由中。
Review comment:
The file name of conf.yaml is incorrect, it should be config.yaml.
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动APISIX之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建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",
+ "methods": ["PUT", "GET"],
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "39.97.63.215:80:": 1
+ }
+ },
+ "plugins": {
+ "node-status":{}
+ }
+}'
+```
+
+发送该请求的前提是apisix/conf/conf.yaml中已经配置node-status，此时node-status插件对该请求处理无影响，所以一般不会将node-status插件设置到路由中。
+
+
+## 测试插件
+
+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"}
+```
+
+2. 参数说明
+
+| 参数 | 说明 |
+| ------------ | -------------------------------------------- |
+| status | 状态信息 |
+| total | 客户端请求总数 |
+| waiting | 当前等待客户端请求的空闲连接数 |
+| accepted | 已经接受的客户端连接总数 |
+| writing | 当前正在写给客户端响应的连接数 |
+| handled | 已经处理的连接总数,通常等于accepted |
+| active | 当前活跃的客户端连接数 |
+| reading | 当前正在读取请求头的连接数 |
+| id | APISIX uid信息，保存在apisix/conf/apisix.uid |
+
+
+## 禁用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中删除node-status
Review comment:
ditto.
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
Review comment:
The file name of `conf.yaml` is incorrect, it should be `config.yaml`, right?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on a change in pull request #2615: doc: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r517055583
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+# 目录
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是APISIX的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口`/apisix/status`，可通过 [interceptors](plugin-interceptors.md)保护该接口。
+
+
+## 启用插件
+
+1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
Review comment:
yes, I will change it. Thanks~
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan merged pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged pull request #2615:
URL: https://github.com/apache/apisix/pull/2615
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a change in pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#discussion_r518155709
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
Review comment:
```suggestion
`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
```
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
Review comment:
There should be `插件接口`
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口 `/apisix/status`，可通过 [interceptors](plugin-interceptors.md) 保护该接口。
+
+
+## 启用插件
+
+1. 配置文件 `apisix/conf/config.yaml` 的 plugin list 中配置 `node-status`
+
+```
+plugins: # plugin list
+ - example-plugin
+ - limit-req
+ - node-status
+ - jwt-auth
+ - zipkin
+ ......
+```
+
+启动 `APISIX` 之后，即可访问该插件提供的接口，获得基本的状态信息。
+
+2. 在创建 route 时添加插件 `node-status`
+
+```
Review comment:
```
```sh
```
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
+
+
+## 插件接口
+
+插件增加接口 `/apisix/status`，可通过 [interceptors](plugin-interceptors.md) 保护该接口。
+
+
+## 启用插件
+
+1. 配置文件 `apisix/conf/config.yaml` 的 plugin list 中配置 `node-status`
+
+```
Review comment:
```suggestion
Not sure what this format is, cc @membphis
```
##########
File path: doc/zh-cn/plugins/node-status.md
##########
@@ -0,0 +1,142 @@
+<!--
+#
+# 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.
+#
+-->
+
+
+
+# 目录
+
+- [**插件简介**](#插件简介)
+- [**插件属性**](#插件属性)
+- [**插件接口**](#接口插件)
+- [**启用插件**](#启用插件)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+
+## 插件简介
+
+`node-status` 是 `APISIX` 的请求状态查询插件，返回基本的状态信息。
+
+
+## 插件属性
+
+插件属性为空。
Review comment:
无
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] HelloBug0 commented on pull request #2615: docs: node-status.md
Posted by GitBox <gi...@apache.org>.
HelloBug0 commented on pull request #2615:
URL: https://github.com/apache/apisix/pull/2615#issuecomment-721474427
I miss adding the commment when I commit the document at the third time, sorry about it.
I update this document according to the comments except [this](https://github.com/apache/apisix/pull/2615#discussion_r517034614). I will change it later after making sure about it.
I really appreciate all your comments.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org