You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2021/11/04 10:31:46 UTC
[incubator-inlong-website] branch master updated: [INLONG-1744]
Modify bid and tid (or dsid) to inlongGroupId and inlongStreamId for
dataproxy doc (#172)
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 7532321 [INLONG-1744] Modify bid and tid (or dsid) to inlongGroupId and inlongStreamId for dataproxy doc (#172)
7532321 is described below
commit 7532321e7fdd821fc3654269b2f3e983b9f00d80
Author: dockerzhang <do...@apache.org>
AuthorDate: Thu Nov 4 18:31:39 2021 +0800
[INLONG-1744] Modify bid and tid (or dsid) to inlongGroupId and inlongStreamId for dataproxy doc (#172)
Co-authored-by: dockerzhang <do...@tencent.com>
---
docs/modules/dataproxy-sdk/architecture.md | 12 ++++++------
docs/modules/dataproxy/architecture.md | 2 +-
docs/modules/tubemq/clients_java.md | 4 ++--
docs/modules/tubemq/error_code.md | 4 ++--
docs/modules/tubemq/http_access_api.md | 2 +-
docs/user_guide/example.md | 6 +++---
.../current/modules/dataproxy-sdk/architecture.md | 12 ++++++------
.../current/modules/dataproxy/architecture.md | 2 +-
.../current/user_guide/example.md | 6 +++---
9 files changed, 25 insertions(+), 25 deletions(-)
diff --git a/docs/modules/dataproxy-sdk/architecture.md b/docs/modules/dataproxy-sdk/architecture.md
index ed44f96..aa48200 100644
--- a/docs/modules/dataproxy-sdk/architecture.md
+++ b/docs/modules/dataproxy-sdk/architecture.md
@@ -26,15 +26,15 @@ The original intention of API design is to simplify user access and assume some
### Synchronous batch function
- public SendResult sendMessage(List<byte[]> bodyList, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public SendResult sendMessage(List<byte[]> bodyList, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
Parameter Description
- bodyListIt is a collection of multiple pieces of data that users need to send. The total length is recommended to be less than 512k. bid represents the service id, and tid represents the interface id. dt represents the time stamp of the data, accurate to the millisecond level. It can also be set to 0 directly, and the api will get the current time as its timestamp in the background. timeout & timeUnit: These two parameters are used to set the timeout time for sending data, and it is [...]
+ bodyListIt is a collection of multiple pieces of data that users need to send. The total length is recommended to be less than 512k. groupId represents the service id, and streamId represents the interface id. dt represents the time stamp of the data, accurate to the millisecond level. It can also be set to 0 directly, and the api will get the current time as its timestamp in the background. timeout & timeUnit: These two parameters are used to set the timeout time for sending data, a [...]
### Synchronize a single function
- public SendResult sendMessage(byte[] body, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public SendResult sendMessage(byte[] body, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
Parameter Description
@@ -43,17 +43,17 @@ The original intention of API design is to simplify user access and assume some
### Asynchronous batch function
- public void asyncSendMessage(SendMessageCallback callback, List<byte[]> bodyList, String bid, String tid, long dt, long timeout,TimeUnit timeUnit)
+ public void asyncSendMessage(SendMessageCallback callback, List<byte[]> bodyList, String groupId, String streamId, long dt, long timeout,TimeUnit timeUnit)
Parameter Description
- SendMessageCallback is a callback for processing messages. The bodyList is a collection of multiple pieces of data that users need to send. The total length of multiple pieces of data is recommended to be less than 512k. bid is the service id, and tid is the interface id. dt represents the time stamp of the data, accurate to the millisecond level. It can also be set to 0 directly, and the api will get the current time as its timestamp in the background. timeout and timeUnit are the t [...]
+ SendMessageCallback is a callback for processing messages. The bodyList is a collection of multiple pieces of data that users need to send. The total length of multiple pieces of data is recommended to be less than 512k. groupId is the service id, and streamId is the interface id. dt represents the time stamp of the data, accurate to the millisecond level. It can also be set to 0 directly, and the api will get the current time as its timestamp in the background. timeout and timeUnit [...]
### Asynchronous single function
- public void asyncSendMessage(SendMessageCallback callback, byte[] body, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public void asyncSendMessage(SendMessageCallback callback, byte[] body, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
Parameter Description
diff --git a/docs/modules/dataproxy/architecture.md b/docs/modules/dataproxy/architecture.md
index f506320..239f217 100644
--- a/docs/modules/dataproxy/architecture.md
+++ b/docs/modules/dataproxy/architecture.md
@@ -47,7 +47,7 @@ Source configuration example and corresponding notes:
Limit the size of a single package, here if the compressed package is transmitted, it is the compressed package size, the limit is 512KB
agent1.sources.tcp-source.topic = test_token
- The default topic value, if the mapping relationship between bid and topic cannot be found, it will be sent to this topic
+ The default topic value, if the mapping relationship between groupId and topic cannot be found, it will be sent to this topic
agent1.sources.tcp-source.attr = m=9
The default value of m is set, where the value of m is the version of inlong's internal TdMsg protocol
diff --git a/docs/modules/tubemq/clients_java.md b/docs/modules/tubemq/clients_java.md
index 1d356fb..04c5172 100644
--- a/docs/modules/tubemq/clients_java.md
+++ b/docs/modules/tubemq/clients_java.md
@@ -112,9 +112,9 @@ public final class MessageConsumerExample {
我们没有采用指定Offset消费的模式进行订阅，也没有过滤需求，因而我们在如下代码里只做了Topic的指定，对应的过滤项集合我们传的是null值，同时，对于不同的Topic，我们可以传递不同的消息回调处理函数；我们这里订阅了3个topic，topic_1，topic_2，topic_3，每个topic分别调用subscribe函数进行对应参数设置：
```java
-public void subscribe(final Map<String, TreeSet<String>> topicTidsMap)
+public void subscribe(final Map<String, TreeSet<String>> topicStreamIdsMap)
throws TubeClientException {
- for (Map.Entry<String, TreeSet<String>> entry : topicTidsMap.entrySet()) {
+ for (Map.Entry<String, TreeSet<String>> entry : topicStreamIdsMap.entrySet()) {
this.messageConsumer.subscribe(entry.getKey(),
entry.getValue(),
new DefaultMessageListener(entry.getKey()));
diff --git a/docs/modules/tubemq/error_code.md b/docs/modules/tubemq/error_code.md
index 3a17c8d..123caad 100644
--- a/docs/modules/tubemq/error_code.md
+++ b/docs/modules/tubemq/error_code.md
@@ -30,7 +30,7 @@ title: Error Code
| Client Error | 419| SERVER_RECEIVE_OVERFLOW | Server receives overflow and need to retry. | For long-term overflow, try to expand the storage instance or expand the memory cache size. ||
| Client Error | 450| CONSUME_GROUP_FORBIDDEN | Consumer group is forbidden. |||
| Client Error | 452| SERVER_CONSUME_SPEED_LIMIT| Consumption speed is limited. |||
-| Client Error | 455| CONSUME_CONTENT_FORBIDDEN | Consumption is rejected, including that the consumer group is forbidden to filter consume and The filter `tid` set does not match the allowed `tid` set, etc. | Confirm the setting of filter of message. ||
+| Client Error | 455| CONSUME_CONTENT_FORBIDDEN | Consumption is rejected, including that the consumer group is forbidden to filter consume and The filter `streamId` set does not match the allowed `streamId` set, etc. | Confirm the setting of filter of message. ||
| Server Error | 500 | INTERNAL_SERVER_ERROR| Internal server error | Refer to ErrMsg for detail to location the error. |
| Server Error| 503| SERVICE_UNAVILABLE| Temporary ban on reading or writing for business. | Retry it. ||
| Server Error| 510| INTERNAL_SERVER_ERROR_MSGSET_NULL | Can not read Message Set. | Retry it. ||
@@ -97,7 +97,7 @@ title: Error Code
| 56 | Parameter error: Offset must over or equal zero of partOffsetMap key XXX, value is YYY | Parameter error: Offset must over or equal zero. ||
| 57 | Duplicated completeSubscribe call! | Call `completeSubscribe()` duplicately. ||
| 58 | Register to master failed! ConsumeGroup forbidden, XXX | Fail to register to master. Consumer group is forbidden | Server prohibits this operation, contact administrator to deal with it. |
-| 59 | Register to master failed! Restricted consume content, XXX | Fail to register to master, and comsumption is limited. | Filter consumption of `tid` sets that are not within the scope of the requested set. |
+| 59 | Register to master failed! Restricted consume content, XXX | Fail to register to master, and comsumption is limited. | Filter consumption of `streamId` sets that are not within the scope of the requested set. |
| 60 | Register to master failed! please check and retry later. | Fail to register to master, retry it. | In this case, check the client log to confirm the cause of the problem, and then contact the administrator to verify that there is no abnormal log and the master address is correct. |
| 61 | Get message error, reason is XXX | Pull message fail by some reason. | Submit the relevant error message to the relevant business owner for action, aligning the cause with the specific error message. |
| 62 | Get message null | Message pulled from topic is null. | Retry it. |
diff --git a/docs/modules/tubemq/http_access_api.md b/docs/modules/tubemq/http_access_api.md
index f0754a7..73ccdf7 100644
--- a/docs/modules/tubemq/http_access_api.md
+++ b/docs/modules/tubemq/http_access_api.md
@@ -851,7 +851,7 @@ __Request__
|topicName|yes|the topic name|String|
|msgCount|no|the max number of message to extract|int|
|partitionId|yes|the partition ID which must exists|int|
-|filterConds|yes|the tid value for filtering|String|
+|filterConds|yes|the streamId value for filtering|String|
### 4.2 `admin_manual_set_current_offset`
diff --git a/docs/user_guide/example.md b/docs/user_guide/example.md
index f3e127e..140269b 100644
--- a/docs/user_guide/example.md
+++ b/docs/user_guide/example.md
@@ -49,7 +49,7 @@ Here we use `docker exec` to enter the container of the agent and configure it.
$ docker exec -it agent sh
```
-Then we create a directory of `.inlong`, and new a file named `bid.local` (Here bid is the business id) and fill in the configuration of Dataproxy as follows.
+Then we create a directory of `.inlong`, and new a file named `groupid.local` (Here groupId is group id showed on data access in inlong-manager) and fill in the configuration of Dataproxy as follows.
```
$ mkdir .inlong
$ cd .inlong
@@ -80,8 +80,8 @@ curl --location --request POST 'http://localhost:8008/config/job' \
"channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
},
"proxy": {
-"bid": "b_test",
-"tid": "test_stream"
+"groupId": "b_test",
+"streamId": "test_stream"
},
"op": "add"
}'
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy-sdk/architecture.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy-sdk/architecture.md
index b3a329b..40a8a59 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy-sdk/architecture.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy-sdk/architecture.md
@@ -27,17 +27,17 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
### 同步批量函数
- public SendResult sendMessage(List<byte[]> bodyList, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public SendResult sendMessage(List<byte[]> bodyList, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
参数说明
- bodyList是用户需要发送的多条数据的集合，总长度建议小于512k。bid代表业务id，tid代表接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout & timeUnit:这两个参数是设置发送数据的超时时间，一般建议设置成20s。
+ bodyList是用户需要发送的多条数据的集合，总长度建议小于512k。groupId代表业务id，streamId代表接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout & timeUnit:这两个参数是设置发送数据的超时时间，一般建议设置成20s。
###同步单条函数
- public SendResult sendMessage(byte[] body, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public SendResult sendMessage(byte[] body, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
参数说明
@@ -47,16 +47,16 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
###异步批量函数
- public void asyncSendMessage(SendMessageCallback callback, List<byte[]> bodyList, String bid, String tid, long dt, long timeout,TimeUnit timeUnit)
+ public void asyncSendMessage(SendMessageCallback callback, List<byte[]> bodyList, String groupId, String streamId, long dt, long timeout,TimeUnit timeUnit)
参数说明
- SendMessageCallback 是处理消息的callback。bodyList为用户需要发送的多条数据的集合，多条数据的总长度建议小于512k。bid是业务id，tid是接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout和timeUnit是发送数据的超时时间，一般建议设置成20s。
+ SendMessageCallback 是处理消息的callback。bodyList为用户需要发送的多条数据的集合，多条数据的总长度建议小于512k。groupId是业务id，streamId是接口id。dt表示该数据的时间戳，精确到毫秒级别。也可直接设置为0，此时api会后台获取当前时间作为其时间戳。timeout和timeUnit是发送数据的超时时间，一般建议设置成20s。
###异步单条函数
- public void asyncSendMessage(SendMessageCallback callback, byte[] body, String bid, String tid, long dt, long timeout, TimeUnit timeUnit)
+ public void asyncSendMessage(SendMessageCallback callback, byte[] body, String groupId, String streamId, long dt, long timeout, TimeUnit timeUnit)
参数说明
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/architecture.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/architecture.md
index c9d3a75..27357fe 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/architecture.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/architecture.md
@@ -46,7 +46,7 @@ Source配置示例以及对应的注解：
限制单个包大小，这里如果传输的是压缩包，则是压缩包大小，限制512KB
agent1.sources.tcp-source.topic = test_token
- 默认topic值，如果bid和topic的映射关系找不到，则发送到此topic中
+ 默认topic值，如果groupId和topic的映射关系找不到，则发送到此topic中
agent1.sources.tcp-source.attr = m=9
默认m值设置，这里的m值是inlong内部TdMsg协议的版本
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/example.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/example.md
index 9c1c276..d211033 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/example.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/example.md
@@ -51,7 +51,7 @@ Hive 是运行的必备组件。如果您的机器上没有 Hive，这里推荐
$ docker exec -it agent sh
```
-然后我们新建 `.inlong` 文件夹，并创建以 `bid.local` 命名的文件，在其中填入 Dataproxy 有关配置。
+然后我们新建 `.inlong` 文件夹，并创建以 `groupId.local` 命名的文件，在其中填入 Dataproxy 有关配置。
```
$ mkdir .inlong
$ cd .inlong
@@ -82,8 +82,8 @@ curl --location --request POST 'http://localhost:8008/config/job' \
"channel": "org.apache.inlong.agent.plugin.channel.MemoryChannel"
},
"proxy": {
-"bid": "b_test",
-"tid": "test_stream"
+"groupId": "b_test",
+"streamId": "test_stream"
},
"op": "add"
}'