This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new cb27fa9 modify dataproxy sdk overview (#271)
cb27fa9 is described below
commit cb27fa9e7db3f728655150175c0aeedc6c7b602f
Author: baomingyu <[email protected]>
AuthorDate: Wed Jan 26 15:30:36 2022 +0800
modify dataproxy sdk overview (#271)
---
docs/sdk/dataproxy-sdk/overview.md | 7 +++----
.../current/sdk/dataproxy-sdk/overview.md | 23 +++++++++++-----------
2 files changed, 14 insertions(+), 16 deletions(-)
diff --git a/docs/sdk/dataproxy-sdk/overview.md
b/docs/sdk/dataproxy-sdk/overview.md
index 5938ba0..d254a6b 100644
--- a/docs/sdk/dataproxy-sdk/overview.md
+++ b/docs/sdk/dataproxy-sdk/overview.md
@@ -1,11 +1,10 @@
---
title: Overview
---
-When the business uses the message access method, the business generally only
needs to format the data in a proxy-recognizable format (such as six-segment
protocol, digital protocol, etc.)
-After group packet transmission, data can be connected to inlong. But in order
to ensure data reliability, load balancing, and dynamic update of the proxy
list and other security features
-The user program needs to consider more and ultimately leads to the program
being too cumbersome and bloated.
-The original intention of API design is to simplify user access and assume
some reliability-related logic. After the user integrates the API in the
service delivery program, the data can be sent to the proxy without worrying
about the grouping format, load balancing and other logic.
+DataProxy supports multi-data format for access, and users can assemble and
send data according to the format recognized by DataProxy (such as six-segment
protocol, digital protocol, etc.).
+Alternatively, use the SDK provided by DataProxy for data access.
+The DataProxy SDK provides multi-features such as load balance and dynamically
updating the proxy list, which can ensure the reliability of access data,
simplify the user's access logic, and reduce the user's access difficulty. It
is recommended to use the SDK method to access.
## Functions
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/dataproxy-sdk/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/dataproxy-sdk/overview.md
index 22eeaac..af68ca4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/dataproxy-sdk/overview.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sdk/dataproxy-sdk/overview.md
@@ -2,22 +2,21 @@
title: 总览
---
-在业务使用消息接入方式时，业务一般仅需将数据按照DataProxy可识别的格式（如六段协议、数字化协议等）
-进行组包发送，就可以将数据接入到inlong。但为了保证数据可靠性、负载均衡、动态更新proxy列表等安全特性
-用户程序就需要考虑更多最终导致程序过于繁琐臃肿。
+DataProxy 支持多种格式的数据的识别，用户既可以按照 DataProxy 可识别的格式（如六段协议、数字化协议等）自定义组装数据发送。
+也可以，采用 DataProxy 提供的 SDK 进行数据接入。
-API的设计初衷就是为了简化用户接入，承担部分可靠性相关的逻辑。用户通过在服务送程序中集成API后，即可将数据发送到DataProxy，而不用关心组包格式、负载均衡等逻辑。
+DataProxy SDK 提供负载均衡、动态更新 proxy
列表等安全特性，能够保证接入数据的可靠性，简化用户的接入逻辑，降低用户的接入难度，这里建议使用 SDK 方式接入。
## 功能说明
| 功能 | 详细描述 |
| ---- | ---- |
-| 组包功能（新） | 将用户数据按打包发送到DataProxy可识别的组包格式（如六段协议、数字化协议等）打包发送到DataProxy|
-| 压缩功能 | 发送打包发送到DataProxy前，将用户数据进行压缩，减少网络带宽占用 |
-| 维护DataProxy列表 | 每隔五分钟获取打包发送到DataProxy列表
，以检测运维侧是否存在上下线DataProxy机器的情况；每隔20s自动剔除不可用连接，以保证已连接的DataProxy能正常运作 |
+| 组包功能（新） | 将用户数据按打包发送到 DataProxy 可识别的组包格式（如六段协议、数字化协议等）打包发送到 DataProxy|
+| 压缩功能 | 发送打包发送到 DataProxy 前，将用户数据进行压缩，减少网络带宽占用 |
+| 维护 DataProxy 列表 | 每隔五分钟获取打包发送到DataProxy列表 ，以检测运维侧是否存在上下线 DataProxy
机器的情况；每隔20s自动剔除不可用连接，以保证已连接的 DataProxy 能正常运作 |
| 指标统计（新） | 增加业务分钟级别发送量的指标（接口级） |
-| 负载均衡（新） | 使用新的策略将发送的数据在多个DataProxy间进行负载均衡，不再依靠简单的随机+轮询机制来保证 |
-| DataProxy列表持久化（新） | 根据业务id对DataProxy列表持久化，防止程序启动时配置中心发生故障无法发送数据
+| 负载均衡（新） | 使用新的策略将发送的数据在多个 DataProxy 间进行负载均衡，不再依靠简单的随机+轮询机制来保证 |
+| DataProxy 列表持久化（新） | 根据业务id对 DataProxy 列表持久化，防止程序启动时配置中心发生故障无法发送数据
## 数据发送
@@ -28,7 +27,7 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
参数说明
-
bodyList是用户需要发送的多条数据的集合，总长度建议小于512k。groupId代表业务id，streamId代表接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout
& timeUnit:这两个参数是设置发送数据的超时时间，一般建议设置成20s。
+ bodyList 是用户需要发送的多条数据的集合，总长度建议小于512k。groupId 代表业务 id，streamId 代表接口id。dt
表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout &
timeUnit:这两个参数是设置发送数据的超时时间，一般建议设置成20s。
```
@@ -48,7 +47,7 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
参数说明
- SendMessageCallback
是处理消息的callback。bodyList为用户需要发送的多条数据的集合，多条数据的总长度建议小于512k。groupId是业务id，streamId是接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout和timeUnit是发送数据的超时时间，一般建议设置成20s。
+ SendMessageCallback 是处理消息的 callback。bodyList
为用户需要发送的多条数据的集合，多条数据的总长度建议小于512k。groupId 是业务 id，streamId 是接口 id。dt
表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时 api 会后台获取当前时间作为其时间戳。timeout 和timeUnit
是发送数据的超时时间，一般建议设置成 20s。
```
### 异步单条函数
@@ -57,5 +56,5 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
参数说明
- body为单条消息内容，其余各参数涵义基本与批量发送接口一致
+ body 为单条消息内容，其余各参数涵义基本与批量发送接口一致
```
\ No newline at end of file
