This is an automated email from the ASF dual-hosted git repository.
gosonzhang 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 4155afc [INLONG-1822] Optimize the table formatting in some MD
documents (#192)
4155afc is described below
commit 4155afc0c82cacd127d35797efb2f8f9f2db29ca
Author: gosonzhang <[email protected]>
AuthorDate: Mon Nov 22 12:54:54 2021 +0800
[INLONG-1822] Optimize the table formatting in some MD documents (#192)
---
docs/modules/tubemq/http_access_api.md | 4 +-
docs/modules/tubemq/quick_start.md | 3 +-
.../modules/tubemq/configure_introduction.md | 32 ++----
.../current/modules/tubemq/deployment.md | 5 +-
.../current/modules/tubemq/error_code.md | 122 ++++++++++-----------
.../current/modules/tubemq/http_access_api.md | 2 +-
.../current/modules/tubemq/quick_start.md | 3 +-
7 files changed, 79 insertions(+), 92 deletions(-)
diff --git a/docs/modules/tubemq/http_access_api.md
b/docs/modules/tubemq/http_access_api.md
index 73ccdf7..628af94 100644
--- a/docs/modules/tubemq/http_access_api.md
+++ b/docs/modules/tubemq/http_access_api.md
@@ -227,7 +227,7 @@ __Request__
|acceptSubscribe|no|whether the broker accept subscribe, default true| Boolean|
|modifyUser|yes|the modifier|String|
|modifyDate|yes|the modify date in format `yyyyMMddHHmmss`|String|
-|confModAuthToken|yes|the authorized key for configuration update|String|
+| confModAuthToken | yes | the authorized key for configuration update |
String |
#### 1.2.4 `admin_query_broker_configure`
@@ -913,7 +913,7 @@ __Request__
|needRefresh|no|whether it needs to refresh, default false|Boolean|
More API see:
-<a href="appendixfiles/http_access_api_definition_cn.xls"
target="_blank">TubeMQ HTTP API</a>
+<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank"
download="w3logo>TubeMQ HTTP API</a>
---
<a href="#top">Back to top</a>
\ No newline at end of file
diff --git a/docs/modules/tubemq/quick_start.md
b/docs/modules/tubemq/quick_start.md
index b51dbb1..4e5aff5 100644
--- a/docs/modules/tubemq/quick_start.md
+++ b/docs/modules/tubemq/quick_start.md
@@ -7,11 +7,12 @@ title: Quick Start
There're two components in the cluster: **Master** and **Broker**. Master and
Broker
can be deployed on the same server or different servers. In this example, we
setup our cluster
like this, and all services run on the same node. Zookeeper should be setup in
your environment also.
+
| Role | TCP Port | TLS Port | Web Port | Comment |
| ---- | -------- | -------- | -------- | ------- |
| Master | 8099 | 8199 | 8080 | Meta data is stored at /stage/meta_data |
| Broker | 8123 | 8124 | 8081 | Message is stored at /stage/msg_data |
-| Zookeeper | 2181 | | | Offset is stored at /tubemq |
+| Zookeeper | 2181 | | | Offset is stored at /tubemq |
### 1.2 Prerequisites
- ZooKeeper Cluster
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
index 57e882a..c90e21d 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/configure_introduction.md
@@ -23,7 +23,7 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
-| [master] | Master系统运行主配置单元，必填单元，值固定为"[master]" |
+| | [master]是Master系统运行主配置单元，必填单元，值固定为"[master]" | | | |
| [master] | hostName | 是 | String |
Master对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
| port | 否 | int | Master监听的端口，可选项，缺省值为8715 |
| webPort | 否 | int | Master Web控制台的访问端口，缺省值为8080 |
@@ -49,18 +49,14 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| startConsumeAuthorize | 否 | boolean | 是否启用消费端消费授权认证，缺省为false |
| maxGroupBrokerConsumeRate | 否 | int |
集群Broker数与消费组里成员数的最大比值，可选项，缺省为50，50台Broker集群里允许1个消费组最少启动1个客户端消费 |
| metaDataPath | 否 | String |
Metadata存储路径，可以是绝对路径、或者相对TubeMQ安装目录（"$BASE_DIR"）的相对路径。缺省为"var/meta_data"
|
-|
- |
-| [zookeeper] |
Master对应的TubeMQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]" |
+| |
[zookeeper]是Master对应的TubeMQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]"
| | | |
| [zookeeper] | zkServerAddr | 否 | String |
zk服务器地址，可选配置，缺省为"localhost:2181" |
| zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
| zkSessionTimeoutMs | 否 | long | zk心跳超时，单位毫秒，默认30秒 |
| zkConnectionTimeoutMs | 否 | long | zk连接超时时间，单位毫秒，默认30秒 |
| zkSyncTimeMs | 否 | long | zk数据同步时间，单位毫秒，默认5秒 |
| zkCommitPeriodMs | 否 | long | Master缓存数据刷新到zk上的时间间隔，单位毫秒，默认5秒 |
-|
- |
-| [replication] | 集群数据复制的相关配置，用于实现元数据多节点热备，必填单元，值固定为"[replication]" |
+| | [replication]是集群数据复制的相关配置，用于实现元数据多节点热备，必填单元，值固定为"[replication]"
| | | |
| [replication] | repGroupName | 否 | String |
集群名，所属主备Master节点值必须相同，可选字段，缺省为"tubemqMasterGroup" |
| repNodeName | 是 | String | 所属Master在集群中的节点名，该值各个节点必须不重复，必填字段 |
| repNodePort | 否 | int | 节点复制通讯端口，可选字段，缺省为9001 |
@@ -69,9 +65,7 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| metaReplicaSyncPolicy | 否 | int |
数据节点同步保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘 |
| repReplicaAckPolicy | 否 | int |
节点数据同步时的应答策略，该字段取值范围为[1，2，3]，缺省为1：其中1为超过1/2多数为有效，2为所有节点应答才有效；3为不需要节点应答 |
| repStatusCheckTimeoutMs | 否 | long | 节点状态检查间隔，可选字段，单位毫秒，缺省为10秒 |
-|
- |
-| [bdbStore] |
已弃用，请在"[replication]"单元进行相关配置。Master所属BDB集群的相关配置，Master采用BDB进行元数据存储以及多节点热备，必填单元，值固定为"[bdbStore]"
|
+| |
[bdbStore]已弃用，请在"[replication]"单元进行相关配置。Master所属BDB集群的相关配置，Master采用BDB进行元数据存储以及多节点热备，必填单元，值固定为"[bdbStore]"
| | | |
| [bdbStore] | bdbRepGroupName | 是 | String | BDB集群名，所属主备Master节点值必须相同，必填字段 |
| bdbNodeName | 是 | String | 所属Master在BDB集群中的节点名，该值各个BDB节点必须不重复，必填字段 |
| bdbNodePort | 否 | int | BDB节点通讯端口，可选字段，缺省为9001 |
@@ -81,9 +75,7 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| bdbReplicaSync | 否 | int |
BDB数据节点同步保存方式，该字段取值范围[1，2，3]，缺省为1：其中1为数据保存到磁盘，2为数据只保存到内存，3为只将数据写文件系统buffer，但不刷盘
|
| bdbReplicaAck | 否 | int |
BDB节点数据同步时的应答策略，该字段取值范围为[1，2，3]，缺省为1：其中1为超过1/2多数为有效，2为所有节点应答才有效；3为不需要节点应答 |
| bdbStatusCheckTimeoutMs | 否 | long | BDB状态检查间隔，可选字段，单位毫秒，缺省为10秒 |
-|
- |
-| [tlsSetting] |
Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" |
+| |
[tlsSetting]是Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]"
| | | |
| [tlsSetting] | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
| tlsPort | 否 | int | Master的TLS端口号，可选配置，缺省为8716 |
| tlsKeyStorePath | 否 | String |
TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
@@ -96,14 +88,13 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
-|
- | file.resource.loader.path | 是 | String |
Master的Web的模板绝对路径，该部分为实际部署Master时的工程绝对路径+/resources/templates，该配置要与实际部署相吻合，配置失败会导致Master前端页面访问失败。
|
+| | file.resource.loader.path | 是 | String |
Master的Web的模板绝对路径，该部分为实际部署Master时的工程绝对路径+/resources/templates，该配置要与实际部署相吻合，配置失败会导致Master前端页面访问失败。
|
### 2.3 broker.ini文件中关键配置内容说明：
| 配置单元 | 配置项 | 是否必选 | 值类型 | 配置说明 |
| --- | --- | --- | --- | --- |
-| [broker] | Broker系统运行主配置单元，必填单元，值固定为"[broker]" |
+| | [broker]是Broker系统运行主配置单元，必填单元，值固定为"[broker]" | | | |
| [broker] | brokerId | 是 | int |
服务器唯一标志，必填字段，可设为0；设为0时系统将默认取本机IP转化为int值再取abs绝对值，避免brokerId为负数，如果使用环境的IP比较复杂存在生成的brokerId值冲突时，则需要指定brokerId值进行设置。
|
| hostName | 是 | String |
Broker对外服务的主机地址，必填项，必须在网卡中已配置，处于启用状态，非回环且不能为127.0.0.1的IP |
| port | 否 | int | Broker监听的端口，可选项，缺省值为8123 |
@@ -125,10 +116,7 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| visitName | 否 | String |
访问Master的用户名，缺省为空字符串，在visitMasterAuth为true时该值必须存在，该值必须与master.ini里的visitName字段值同
|
| visitPassword | 否 | String |
访问Master的密码，缺省为空字符串，在visitMasterAuth为true时该值必须存在，该值必须与master.ini里的visitPassword字段值同
|
| logFlushMemDurMs | 否 | long | 批量检查消息内存持久化到文件的检查周期,单位为毫秒, 缺省为10秒进行一次全量的检查及刷盘 |
-|
- |
- |
-| [zookeeper] | Broker对应的Tube
MQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]" |
+| | [zookeeper]是Broker对应的Tube
MQ集群存储Offset的ZooKeeper集群相关信息，必填单元，值固定为"[zookeeper]" | | | |
| [zookeeper] | zkServerAddr | 否 | String |
zk服务器地址，可选配置，缺省为"localhost:2181" |
| zkNodeRoot | 否 | String | zk上的节点根目录路径，可选配置，缺省为"/tubemq" |
| zkSessionTimeoutMs | 否 | long | zk心跳超时，单位毫秒，默认30秒 |
@@ -136,9 +124,7 @@ Master除了后端系统配置文件外，还在resources里存放了Web前端
| zkSyncTimeMs | 否 | long | zk数据同步时间，单位毫秒，默认5秒 |
| zkCommitPeriodMs | 否 | long | Broker缓存数据刷新到zk上的时间间隔，单位毫秒，默认5秒 |
| zkCommitFailRetries | 否 | int | Broker刷新缓存数据到Zk失败后的最大重刷次数 |
-|
- |
-| [tlsSetting] |
Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]" |
+| |
[tlsSetting]是Master采用TLS进行传输层数据加密，启用TLS时通过该配置单元提供相关的设置，可选单元，值固定为"[tlsSetting]"
| | | |
| [tlsSetting] | tlsEnable | 否 | boolean | 是否启用TLS功能，可选配置，缺省为false |
| tlsPort | 否 | int | Broker的TLS端口号，可选配置，缺省为8124 |
| tlsKeyStorePath | 否 | String |
TLS的keyStore文件的绝对存储路径+keyStore文件名，在启动TLS功能时，该字段必填且不能为空 |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/deployment.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/deployment.md
index 32c5ba0..9313276 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/deployment.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/deployment.md
@@ -37,9 +37,8 @@ mvn clean package -Dmaven.test.skip
| | ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
| 9.23.28.24 | **Master** | 8099 | 8199 | 8080 | 元数据存储在 `/stage/meta_data` |
| | Broker | 8123 | 8124 | 8081 | 消息储存在`/stage/msg_data` |
-| 9.23.27.160 | Producer ||||
-| | Consumer ||||
-|
+| 9.23.27.160 | Producer | | | | |
+| | Consumer | | | | |
部署Master时需要注意：
1.
部署Master的机器，Master集群可以部署1台、2台或者3台：如果要保证高可靠建议3台（任意坏1台Master对外仍然可读写配置及接入新的生产或者消费），如果只需要保证一般情况2台（任意坏1台Master对外仍然可读配置及已接入的生产和消费不受影响），最低1台（坏1台Master对外配置不可读写及已接入的生产和消费不受影响）；
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/error_code.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/error_code.md
index cc7def2..4772d29 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/error_code.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/error_code.md
@@ -8,52 +8,52 @@ title: 错误码定义
## 2 错误码
-| 错误类别 | 错误码 | 错误标记
| 含义
| 备注 |
-| ------------ | --------------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ |
---------------------------------------------- |
-| 成功操作 | 200 | SUCCESS
| 操作成功
| |
-|成功操作| 201 | NOT_READY |
请求已接纳，但服务器还没有ready，服务还没有运行 | 保留错误，暂未使用
| |
-| 临时处理冲突 | 301 | MOVED
| 数据临时切换导致操作不成功，需要重新发起操作请求 |
|
-| 客户端错误 | 400 | BAD_REQUEST
| 客户端侧异常，包括参数异常，状态异常等 |
需要结合错误信息确定问题原因后重试 |
-| 客户端错误| 401 | UNAUTHORIZED |
未授权的操作，确认客户端有权限进行该项操作 | 需要检查配置，同时与管理员确认原因
| |
-| 客户端错误| 403 | FORBIDDEN | 操作的Topic不存在，或者已删除
| 需要与管理员确认具体问题原因
| |
-| 客户端错误| 404 | NOT_FOUND | 消费offset已经达到最大位置
|
| |
-| 客户端错误| 405 | ALL_PARTITION_FROZEN | 所有可用分区都被冻结
| 可用分区已被客户端冻结，需要解冻处理或者等待一段时间再重试
| |
-| 客户端错误| 406 | NO_PARTITION_ASSIGNED | 当前客户端没有被分配分区进行消费
| 客户端个数超过分区个数，或者服务器还没有进行负载均衡操作，需要等待并重试
| |
-| 客户端错误| 407 | ALL_PARTITION_WAITING | 当前可用分区都达到了最大消费位置
| 需要等待再重试 |
|
-| 客户端错误| 408 | ALL_PARTITION_INUSE | 当前可用分区都被业务使用未释放
| 需要等待业务逻辑调用confirm接口释放分区，需要等待并再重试
| |
-| 客户端错误| 410 | PARTITION_OCCUPIED | 分区消费冲突，忽略即可
| 内部注册的临时状态，业务接口一般不会遇到该报错 |
|
-| 客户端错误| 411 | HB_NO_NODE |
节点超时，需要降低操作等待一阵后再重试处理 |
一般出现在客户端在服务器侧心跳超时，这个时候需要降低操作频率，等待一阵待lib注册成功后再重试处理 |
|
-| 客户端错误| 412 | DUPLICATE_PARTITION | 分区消费冲突，忽略即可
| 一般是由于节点超时引起，重试即可 |
|
-| 客户端错误| 415 | CERTIFICATE_FAILURE |
认证失败,包括用户身份认证,以及操作授权不通过 | 一般是用户名密码不一致,或者操作的范围未授权,需要结合错误详情进行排查 |
|
-| 客户端错误| 419 | SERVER_RECEIVE_OVERFLOW |
服务器接收overflow，需要重试处理 |
如果长期的overflow，需要联系管理员扩容存储实例，或者扩大内存缓存大小 |
|
-| 客户端错误| 450 | CONSUME_GROUP_FORBIDDEN | 消费组被纳入黑名单
| 联系管理员处理
| |
-| 客户端错误| 452 | SERVER_CONSUME_SPEED_LIMIT | 消费被限速
| 联系管理员处理，解除限速
| |
-| 客户端错误| 455 | CONSUME_CONTENT_FORBIDDEN |
消费内容拒绝，包括消费组禁止过滤消费，过滤的数据流ID集合与允许的ID集合不一致等 | 对齐过滤消费的设置确认没有问题后，再联系管理员处理
| |
-| 服务器侧异常 | 500 | INTERNAL_SERVER_ERROR
| 内部服务器错误
| 需要结合错误信息，联系管理员确定问题原因后重试 |
-| 服务器侧异常| 503 | SERVICE_UNAVILABLE | 业务临时禁读或者禁写
| 继续重试处理，如果持续的出现该类错误，需要联系管理员处理 |
|
-| 服务器侧异常| 510 | INTERNAL_SERVER_ERROR_MSGSET_NULL | 读取不到消息集合
| 继续重试处理，如果持续的出现该类错误，需要联系管理员处理 |
|
+| 错误类别 | 错误码 | 错误标记 | 含义
| 备注 |
+| ---------- | ---------- | -------------------------------- |
------------------------------------------------- |
----------------------------------------- |
+| 成功操作 | 200 | SUCCESS | 操作成功
| |
+| 成功操作 | 201 | NOT_READY |
请求已接纳，但服务器还没有ready，服务还没有运行 | 保留错误，暂未使用 |
+| 临时处理冲突 | 301 | MOVED |
数据临时切换导致操作不成功，需要重新发起操作请求 | |
+| 客户端错误| 400 | BAD_REQUEST |
客户端侧异常，包括参数异常，状态异常等 | 需要结合错误信息确定问题原因后重试 |
+| 客户端错误| 401 | UNAUTHORIZED |
未授权的操作，确认客户端有权限进行该项操作 | 需要检查配置，同时与管理员确认原因 |
+| 客户端错误| 403 | FORBIDDEN | 操作的Topic不存在，或者已删除
| 需要与管理员确认具体问题原因 |
+| 客户端错误| 404 | NOT_FOUND | 消费offset已经达到最大位置
| |
+| 客户端错误| 405 | ALL_PARTITION_FROZEN | 所有可用分区都被冻结
| 可用分区已被客户端冻结，需要解冻处理或者等待一段时间再重试 |
+| 客户端错误| 406 | NO_PARTITION_ASSIGNED | 当前客户端没有被分配分区进行消费
| 客户端个数超过分区个数，或者服务器还没有进行负载均衡操作，需要等待并重试 |
+| 客户端错误| 407 | ALL_PARTITION_WAITING | 当前可用分区都达到了最大消费位置
| 需要等待再重试 |
+| 客户端错误| 408 | ALL_PARTITION_INUSE | 当前可用分区都被业务使用未释放
| 需要等待业务逻辑调用confirm接口释放分区，需要等待并再重试 |
+| 客户端错误| 410 | PARTITION_OCCUPIED | 分区消费冲突，忽略即可
| 内部注册的临时状态，业务接口一般不会遇到该报错 |
+| 客户端错误| 411 | HB_NO_NODE |
节点超时，需要降低操作等待一阵后再重试处理 |
一般出现在客户端在服务器侧心跳超时，这个时候需要降低操作频率，等待一阵待lib注册成功后再重试处理 |
+| 客户端错误| 412 | DUPLICATE_PARTITION | 分区消费冲突，忽略即可
| 一般是由于节点超时引起，重试即可 |
+| 客户端错误| 415 | CERTIFICATE_FAILURE |
认证失败,包括用户身份认证,以及操作授权不通过 | 一般是用户名密码不一致,或者操作的范围未授权,需要结合错误详情进行排查 |
+| 客户端错误| 419 | SERVER_RECEIVE_OVERFLOW |
服务器接收overflow，需要重试处理 |
如果长期的overflow，需要联系管理员扩容存储实例，或者扩大内存缓存大小 |
+| 客户端错误| 450 | CONSUME_GROUP_FORBIDDEN | 消费组被纳入黑名单
| 联系管理员处理
|
+| 客户端错误| 452 | SERVER_CONSUME_SPEED_LIMIT | 消费被限速
| 联系管理员处理，解除限速
|
+| 客户端错误| 455 | CONSUME_CONTENT_FORBIDDEN |
消费内容拒绝，包括消费组禁止过滤消费，过滤的数据流ID集合与允许的ID集合不一致等 | 对齐过滤消费的设置确认没有问题后，再联系管理员处理 |
+| 服务器侧异常 | 500 | INTERNAL_SERVER_ERROR | 内部服务器错误
| 需要结合错误信息，联系管理员确定问题原因后重试 |
+| 服务器侧异常| 503 | SERVICE_UNAVILABLE | 业务临时禁读或者禁写
| 继续重试处理，如果持续的出现该类错误，需要联系管理员处理 |
+| 服务器侧异常| 510 | INTERNAL_SERVER_ERROR_MSGSET_NULL | 读取不到消息集合
| 继续重试处理，如果持续的出现该类错误，需要联系管理员处理 |
## 3 常见错误信息
-| 记录号 | 错误信息 | 含义
| 备注
|
-| ------ | ------------------------------------------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| 记录号 | 错误信息 |
含义 | 备注
|
+| ------ | ------------------------------------------------------------ |
---------------------------------------------------------- |
------------------------------------------------------------ |
| 1 | Status error: producer has been shutdown! |
客户端已停止 |
|
| 2 | Illegal parameter: blank topic! |
参数错误: 空的topic |
|
| 3 | Illegal parameter: topicSet is null or empty! |
参数错误: 空的topic集合 |
|
-| 4 | Illegal parameter: found blank topic value in topicSet : xxxxx |
参数错误: topic集合里含有空的topic |
|
+| 4 | Illegal parameter: found blank topic value in topicSet : xxxxx |
参数错误: topic集合里含有空的topic |
|
| 5 | Send message failed |
消息发送失败 |
|
| 6 | Illegal parameter: null message package! | 空消息包
|
|
| 7 | Illegal parameter: null data in message package! |
空消息内容 |
|
-| 8 | Illegal parameter: over max message length for the total size of
message data and attribute, allowed size is XX，message's real size is YY |
消息长度超过指定长 |
|
+| 8 | Illegal parameter: over max message length for the total size of
message data and attribute, allowed size is XX，message's real size is YY |
消息长度超过指定长 |
|
| 9 | Topic XX not publish, please publish first! |
topic没有发布 |
|
-| 10 | Topic XX not publish, make sure the topic exist or acceptPublish
and try later! | topic没有发布，或者发布的topic不存在 |
|
-| 11 | Null partition for topic: XX , please try later! |
对应topic暂时没有分配到分区 |
|
+| 10 | Topic XX not publish, make sure the topic exist or acceptPublish
and try later! | topic没有发布，或者发布的topic不存在 |
|
+| 11 | Null partition for topic: XX , please try later! |
对应topic暂时没有分配到分区 |
|
| 12 | No available partition for topic: XX |
没有有效分区 |
|
-| 13 | Current delayed messages over max allowed count, allowed is
xxxxx, current count is yyyy | 当前滞留未响应的消息超过了允许值 |
稍后再发，该值缺省40W，通过TubeClientConfig.setSessionMaxAllowedDelayedMsgCount()控制 |
-| 14 | The brokers of topic are all forbidden! |
对应Topic的Broker均因为网络质量问题被屏蔽 | 稍后再发，待屏蔽策略解除
|
+| 13 | Current delayed messages over max allowed count, allowed is
xxxxx, current count is yyyy | 当前滞留未响应的消息超过了允许值 |
稍后再发，该值缺省40W，通过TubeClientConfig.setSessionMaxAllowedDelayedMsgCount()控制 |
+| 14 | The brokers of topic are all forbidden! |
对应Topic的Broker均因为网络质量问题被屏蔽 | 稍后再发，待屏蔽策略解除
|
| 15 | Not found available partition for topic: XX |
没有找到有效分区 |
有分区分配但由于网络质量问题分配的分区处于屏蔽中， |
-| 16 | Channel is not writable, please try later! |
管道不可写 |
缺省10M，通过TubeClientConfig.setNettyWriteBufferHighWaterMark调大写buffer |
-| 17 | Put message failed from xxxxx, server receive message overflow! |
存储消息时对应服务器过载 |
重试消息发送,若持续的出现该类报错,则需要联系管理员进行扩容处理 |
+| 16 | Channel is not writable, please try later! |
管道不可写 |
缺省10M，通过TubeClientConfig.setNettyWriteBufferHighWaterMark调大写buffer |
+| 17 | Put message failed from xxxxx, server receive message overflow! |
存储消息时对应服务器过载 |
重试消息发送,若持续的出现该类报错,则需要联系管理员进行扩容处理 |
| 18 | Write StoreService temporary unavailable! |
对应服务器临时写无效 |
重试消息发送，如果连续写无效，联系管理员，调整分区在broker上的分布，同时处理异常的broker |
| 19 | Topic xxx not existed, please check your configure |
生产的Topic不存在 |
有可能是生产过程中topic被管理员删除,联系管理员处理 |
| 20 | Partition[xxx:yyy] has been closed |
生产的Topic已删除 |
有可能是生产过程中topic被管理员软删除,联系管理员处理 |
@@ -62,38 +62,38 @@ title: 错误码定义
| 23 | Put message failed from xxxxx |
存储消息失败 | 重发,同时将错误信息发给管理员确认问题原因
|
| 24 | Put message failed2 from |
存储消息失败2 | 重发,同时将错误信息发给管理员确认问题原因
|
| 25 | Null brokers to select sent, please try later! |
当前无可用的Broker进行消息发送 |
等待一阵时间再重试，如果一直如此联系管理员，该情况有可能是broker异常，或者未完成消息过多引起，需要查看Broker状态后确定。 |
-| 26 | Publish topic failure, make sure the topic xxx exist or
acceptPublish and try later! | publish topic失败，确认该topic存在或者处于可写状态 |
调用void publish(final String
topic)接口时如果对应topic还不在本地，或者topic不存在时将报该错误，等待1分钟左右，或者使用Set<String>
publish(Set</String> topicSet)接口完成topic的发布。 |
-| 27 | Register producer failure, response is null! |
注册producer失败 | 需要联系管理员处理
|
-| 28 | Register producer failure, error is XXX |
注册producer失败，错误原因是 XXX |
根据错误原因进行问题核对，如果仍错误，联系管理员处理。 |
-| 29 | Register producer exception, error is XXX |
注册producer发生异常，错误原因是 XXX | 根据错误原因进行问题核对，如果仍错误，联系管理员处理。
|
+| 26 | Publish topic failure, make sure the topic xxx exist or
acceptPublish and try later! | publish topic失败，确认该topic存在或者处于可写状态 | 调用void
publish(final String
topic)接口时如果对应topic还不在本地，或者topic不存在时将报该错误，等待1分钟左右，或者使用Set<String>
publish(Set</String> topicSet)接口完成topic的发布。 |
+| 27 | Register producer failure, response is null! |
注册producer失败 | 需要联系管理员处理
|
+| 28 | Register producer failure, error is XXX |
注册producer失败，错误原因是 XXX |
根据错误原因进行问题核对，如果仍错误，联系管理员处理。 |
+| 29 | Register producer exception, error is XXX |
注册producer发生异常，错误原因是 XXX |
根据错误原因进行问题核对，如果仍错误，联系管理员处理。 |
| 30 | Status error: please call start function first! |
需要首先调用start函数 |
接口使用问题，Producer不是从sessionFactory创建生成，调用sessionfactory里的createProducer()函数进行创建后再使用
|
| 31 | Status error: producer service has been shutdown! |
producer服务已经停止 |
producer已经停止服务，停止业务函数调用 |
-| 32 | Listener is null for topic XXX |
针对topic XXX传递的回调对象Listener为null | 输入参数不合法，需要检查业务代码
|
-| 33 | Please complete topic's Subscribe call first! |
请先完成对应topic的subscribe()函数调用 |
接口使用问题，需要先完成topic的订阅操作再进行消费消费处理 |
+| 32 | Listener is null for topic XXX |
针对topic XXX传递的回调对象Listener为null | 输入参数不合法，需要检查业务代码
|
+| 33 | Please complete topic's Subscribe call first! |
请先完成对应topic的subscribe()函数调用 |
接口使用问题，需要先完成topic的订阅操作再进行消费消费处理 |
| 34 | ConfirmContext is null ! |
空ConfirmContext内容，非法上下文 | 需要业务确认接口调用逻辑
|
-| 35 | ConfirmContext format error: value must be aaaa:bbbb:cccc:ddddd !
| ConfirmContext内容的格式不正确 | 需要业务确认接口调用逻辑
|
-| 36 | ConfirmContext's format error: item (XXX) is null ! |
ConfirmContext内容有异常，存在Blank内容 | 需要业务确认接口调用逻辑
|
-| 37 | The confirmContext's value invalid! |
无效ConfirmContext内容 |
有可能是不存在的上下文，或者因为负载均衡对应分区已释放上下文已经过期 |
-| 38 | Confirm XXX 's offset failed! |
confirm offset失败 |
需要根据日志详情确认问题原因，如果持续的出现该问题，联系管理员处理。 |
-| 39 | Not found the partition by confirmContext:XXX |
确认的partition未找到 | 服务端负载均衡对应分区已释放
|
-| 40 | Illegal parameter: messageSessionFactory or consumerConfig is
null! | messageSessionFactory或者 consumerConfig为null |
检查对象初始化逻辑，确认配置的准确性 |
+| 35 | ConfirmContext format error: value must be aaaa:bbbb:cccc:ddddd !
| ConfirmContext内容的格式不正确 | 需要业务确认接口调用逻辑
|
+| 36 | ConfirmContext's format error: item (XXX) is null ! |
ConfirmContext内容有异常，存在Blank内容 | 需要业务确认接口调用逻辑
|
+| 37 | The confirmContext's value invalid! |
无效ConfirmContext内容 |
有可能是不存在的上下文，或者因为负载均衡对应分区已释放上下文已经过期 |
+| 38 | Confirm XXX 's offset failed! |
confirm offset失败 |
需要根据日志详情确认问题原因，如果持续的出现该问题，联系管理员处理。 |
+| 39 | Not found the partition by confirmContext:XXX |
确认的partition未找到 | 服务端负载均衡对应分区已释放
|
+| 40 | Illegal parameter: messageSessionFactory or consumerConfig is
null! | messageSessionFactory或者 consumerConfig为null | 检查对象初始化逻辑，确认配置的准确性
|
| 41 | Get consumer id failed! |
consumer的唯一识别ID生成失败 | 持续失败时，将异常堆栈信息给到系统管理员处理
|
-| 42 | Parameter error: topic is Blank! |
输入的topic为Blank |
Blank包括参数为null，输入的参数不为空，但内容长度为0，或者内容为isWhitespace字符 |
-| 43 | Parameter error: Over max allowed filter count, allowed count is
XXX | 过滤项个数超过系统允许的最大量 | 参数异常，调整个数
|
-| 44 | Parameter error: blank filter value in parameter filterConds! |
filterConds里包含了为Blank的内容项 | 参数异常，调整内容项值
|
-| 45 | Parameter error: over max allowed filter length, allowed length
is XXX | 过滤项长度超标 |
|
-| 46 | Parameter error: null messageListener |
messageListener参数为null |
|
+| 42 | Parameter error: topic is Blank! |
输入的topic为Blank |
Blank包括参数为null，输入的参数不为空，但内容长度为0，或者内容为isWhitespace字符 |
+| 43 | Parameter error: Over max allowed filter count, allowed count is
XXX | 过滤项个数超过系统允许的最大量 | 参数异常，调整个数
|
+| 44 | Parameter error: blank filter value in parameter filterConds! |
filterConds里包含了为Blank的内容项 | 参数异常，调整内容项值
|
+| 45 | Parameter error: over max allowed filter length, allowed length
is XXX | 过滤项长度超标 |
|
+| 46 | Parameter error: null messageListener |
messageListener参数为null |
|
| 47 | Topic=XXX has been subscribed | Topic
XXX被重复订阅 |
|
| 48 | Not subscribe any topic, please subscribe first! |
未订阅任何topic即启动消费 | 接口调用逻辑异常，检查业务代码
|
-| 49 | Duplicated completeSubscribe call! |
重复调用completeSubscribe()函数 | 接口调用逻辑异常，检查业务代码
|
-| 50 | Subscribe has finished! |
重复调用completeSubscribe()函数 |
|
+| 49 | Duplicated completeSubscribe call! |
重复调用completeSubscribe()函数 | 接口调用逻辑异常，检查业务代码
|
+| 50 | Subscribe has finished! |
重复调用completeSubscribe()函数 |
|
| 51 | Parameter error: sessionKey is Blank! |
参数不合规，sessionKey值不允许为Blank内容 |
|
| 52 | Parameter error: sourceCount must over zero! |
参数不合规，sourceCount值必须大于0 |
|
-| 53 | Parameter error: partOffsetMap's key XXX format error: value must
be aaaa:bbbb:cccc ! | 参数不合规，partOffsetMap的key值内容必须是aaaa:bbbb:cccc格式 |
|
-| 54 | Parameter error: not included in subscribed topic list:
partOffsetMap's key is XXX , subscribed topics are YYY |
参数不合规，partOffsetMap里指定的topic在订阅列表里并不存在 |
|
-| 55 | Parameter error: illegal format error of XXX : value must not
include ',' char!" | 参数不合规，key值里面不能包含","字符 |
|
-| 56 | Parameter error: Offset must over or equal zero of partOffsetMap
key XXX, value is YYY | 参数不合规，offset值必须是大于等于0 |
|
-| 57 | Duplicated completeSubscribe call! |
重复调用completeSubscribe()函数 |
|
+| 53 | Parameter error: partOffsetMap's key XXX format error: value must
be aaaa:bbbb:cccc ! | 参数不合规，partOffsetMap的key值内容必须是aaaa:bbbb:cccc格式 |
|
+| 54 | Parameter error: not included in subscribed topic list:
partOffsetMap's key is XXX , subscribed topics are YYY |
参数不合规，partOffsetMap里指定的topic在订阅列表里并不存在 | |
+| 55 | Parameter error: illegal format error of XXX : value must not
include ',' char!" | 参数不合规，key值里面不能包含","字符 |
|
+| 56 | Parameter error: Offset must over or equal zero of partOffsetMap
key XXX, value is YYY | 参数不合规，offset值必须是大于等于0 |
|
+| 57 | Duplicated completeSubscribe call! |
重复调用completeSubscribe()函数 |
|
| 58 | Register to master failed! ConsumeGroup forbidden, XXX |
注册Master失败，消费组被禁止 | 服务端主动禁止行为，联系系统管理员处理
|
| 59 | Register to master failed! Restricted consume content, XXX |
注册Master失败，消费内容受限 | 过滤消费的数据流ID集合不在申请的集合范围内
|
| 60 | Register to master failed! please check and retry later. |
注册Master失败，请重试 |
这种情况需要查看客户端日志，确认问题原因，在核实没有异常日志，同时master地址填写正确，联系系统管理员处理。 |
@@ -103,9 +103,9 @@ title: 错误码定义
| 64 | Status error: consumer has been shutdown |
消费者已调用shutdown，不应该继续调用其它函数进行业务处理 |
|
| 65 | All partition in waiting, retry later! |
所有分区都在等待,请稍候 | 该错误信息可以不做打印,遇到该情况时拉取县城sleep
200 ~ 400ms |
| 66 | The request offset reached maxOffset |
请求的分区已经消费到最新位置 |
可以通过ConsumerConfig.setMsgNotFoundWaitPeriodMs()设置该情况时分区停止拉取的时间段来等待最新消息的到来 |
-| 67 | No partition info in local, please wait and try later
| 本地没有分区信息，需要等待并重试 |
可能情况包括服务器还没有进行rebalance，或者客户端个数大于了分区个数 |
-| 68 | No idle partition to consume, please wait and try later
| 没有空闲分区进行消费，需要等待并重试 |
可能情况业务占用了分区还没有释放，需要等待业务confirm消费后才能获取到空闲分区 |
-| 69 | All partition are frozen to consume, please unfreeze partition(s)
or wait | 所有分区都被冻结 |
可能情况业务调用freeze接口冻结可分区消费，需要业务调用unfreeze接口进行解冻处理 |
+| 67 | No partition info in local, please wait and try later
| 本地没有分区信息，需要等待并重试 |
可能情况包括服务器还没有进行rebalance，或者客户端个数大于了分区个数 |
+| 68 | No idle partition to consume, please wait and try later
| 没有空闲分区进行消费，需要等待并重试 |
可能情况业务占用了分区还没有释放，需要等待业务confirm消费后才能获取到空闲分区 |
+| 69 | All partition are frozen to consume, please unfreeze partition(s)
or wait | 所有分区都被冻结 |
可能情况业务调用freeze接口冻结可分区消费，需要业务调用unfreeze接口进行解冻处理 |
---
<a href="#top">Back to top</a>
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
index 819f9ee..31d469d 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/http_access_api.md
@@ -14,7 +14,7 @@ HTTP API是Master或者Broker对外功能暴露的接口，管控台的各项操
由于接口众多且参数繁杂，md格式不能比较好的表达，因而以excel附件形式提供给到大家：
-<a href="appendixfiles/http_access_api_definition_cn.xls"
target="_blank">TubeMQ HTTP API</a>
+<a href="appendixfiles/http_access_api_definition_cn.xls" target="_blank"
download="w3logo">TubeMQ HTTP API</a>
---
<a href="#top">Back to top</a>
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
index f4925b2..191bc30 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/tubemq/quick_start.md
@@ -5,11 +5,12 @@ title: 快速开始
### 1.1 配置示例
TubeMQ 集群包含有两个组件: **Master** 和 **Broker**. Master 和 Broker
可以部署在相同或者不同的节点上，依照业务对机器的规划进行处理。我们通过如下3台机器搭建有2台Master的生产、消费的集群进行配置示例：
+
| 所属角色 | TCP端口 | TLS端口 | WEB端口 | 备注 |
| --- | --- | --- | --- | --- |
| Master | 8099 | 8199 | 8080 | 元数据存储在`/stage/meta_data` |
| Broker | 8123 | 8124 | 8081 | 消息储存在`/stage/msg_data` |
-| ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
+| ZooKeeper | 2181 | | | Offset储存在根目录`/tubemq` |
### 1.2 准备工作
- ZooKeeper集群
