docs(syslog): revert the removal of unused property name in #10644

This reverts commit 0609efa.
apache · Dec 14, 2023 · ad242db · ad242db
1 parent 553ac42
commit ad242db
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/en/latest/plugins/syslog.md b/docs/en/latest/plugins/syslog.md
@@ -37,7 +37,8 @@ Logs can be set as JSON objects.
 | Name             | Type    | Required | Default      | Valid values  | Description                                                                                                              |
 |------------------|---------|----------|--------------|---------------|--------------------------------------------------------------------------------------------------------------------------|
 | host             | string  | True     |              |               | IP address or the hostname of the Syslog server.                                                                         |
-| port             | integer | True     |              |               | Target port of the Syslog server.                                                                                        | |
+| port             | integer | True     |              |               | Target port of the Syslog server.                                                                                        |
+| name             | string  | False    | "sys logger" |               | Identifier for the server.                                                                                               |
 | timeout          | integer | False    | 3000         | [1, ...]      | Timeout in ms for the upstream to send data.                                                                             |
 | tls              | boolean | False    | false        |               | When set to `true` performs TLS verification.                                                                            |
 | flush_limit      | integer | False    | 4096         | [1, ...]      | Maximum size of the buffer (KB) and the current message before it is flushed and written to the server.                  |

diff --git a/docs/zh/latest/plugins/syslog.md b/docs/zh/latest/plugins/syslog.md
@@ -39,6 +39,7 @@ description: API 网关 Apache APISIX syslog 插件可用于将日志推送到 S
 | ---------------- | ------- | ------ | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
 | host             | string  | 是     |              |               | IP 地址或主机名。                                                                                                                      |
 | port             | integer | 是     |              |               | 目标上游端口。                                                                                                                         |
+| name             | string  | 否     | "sys logger" |               | syslog 服务器的标识符。                                                                                                                |
 | timeout          | integer | 否     | 3000         | [1, ...]      | 上游发送数据超时（以毫秒为单位）。                                                                                                       |
 | tls              | boolean | 否     | false        |               | 当设置为 `true` 时执行 SSL 验证。                                                                                                       |
 | flush_limit      | integer | 否     | 4096         | [1, ...]      | 如果缓冲的消息的大小加上当前消息的大小达到（> =）此限制（以字节为单位），则缓冲的日志消息将被写入日志服务器，默认为 4096（4KB）。              |