[incubator-apisix] branch master updated: doc: added http logger Chinese docs (#1581)

[me...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 05b3c39  doc: added http logger Chinese docs (#1581)
05b3c39 is described below

commit 05b3c39f30d141f1c3a54769bbe9769592c88196
Author: Scaat Feng <sc...@gmail.com>
AuthorDate: Thu May 14 22:41:46 2020 +0800

    doc: added http logger Chinese docs (#1581)
---
 doc/plugins/http-logger-cn.md | 97 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)

diff --git a/doc/plugins/http-logger-cn.md b/doc/plugins/http-logger-cn.md
new file mode 100644
index 0000000..2cca9a3
--- /dev/null
+++ b/doc/plugins/http-logger-cn.md
@@ -0,0 +1,97 @@
+<!--
+#
+# 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.
+#
+-->
+
+# Summary
+- [**定义**](#name)
+- [**属性列表**](#attributes)
+- [**如何开启**](#how-to-enable)
+- [**测试插件**](#test-plugin)
+- [**禁用插件**](#disable-plugin)
+
+## 定义
+
+`http-logger` 是一个插件，可将Log数据请求推送到HTTP / HTTPS服务器。
+
+这将提供将Log数据请求作为JSON对象发送到监视工具和其他HTTP服务器的功能。
+
+## 属性列表
+
+|属性名称          |必选项  |描述|
+|---------     |--------|-----------|
+| uri |必要的| 服务器的URI |
+| authorization |可选的| 授权头部 |
+| keepalive |可选的|发送请求后保持连接活动的时间|
+| name |可选的|标识logger的唯一标识符|
+| batch_max_size |可选的|每批的最大大小，默认为1000|
+| inactive_timeout |可选的|刷新缓冲区的最大时间（以秒为单位），默认值为5s|
+| buffer_duration |可选的|必须先处理批次中最旧条目的最长期限（以秒为单位），默认值为5|
+| max_retry_count |可选的|从处理管道中移除之前的最大重试次数，默认为0|
+| retry_delay |可选的|如果执行失败，则应延迟执行流程的秒数，默认为1|
+
+## 如何开启
+
+1. 这是有关如何为特定路由启用http-logger插件的示例。
+
+```shell
+curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+      "plugins": {
+            "http-logger": {
+                 "uri": "127.0.0.1:80/postendpoint?param=1"
+            }
+       },
+      "upstream": {
+           "type": "roundrobin",
+           "nodes": {
+               "127.0.0.1:1980": 1
+           }
+      },
+      "uri": "/hello"
+}'
+```
+
+## 测试插件
+
+* 成功:
+
+```shell
+$ curl -i http://127.0.0.1:9080/hello
+HTTP/1.1 200 OK
+...
+hello, world
+```
+
+## 禁用插件
+
+在插件配置中删除相应的json配置以禁用http-logger。APISIX插件是热重载的，因此无需重新启动APISIX：
+
+```shell
+$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value='
+{
+    "methods": ["GET"],
+    "uri": "/hello",
+    "plugins": {},
+    "upstream": {
+        "type": "roundrobin",
+        "nodes": {
+            "127.0.0.1:1980": 1
+        }
+    }
+}'
+```