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/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 23e75a49c9 [INLONG-823] Sync the error code with the change of inlong
(#833)
23e75a49c9 is described below
commit 23e75a49c907e956590813837e27ce3bc9c2c92b
Author: EpicMo <[email protected]>
AuthorDate: Mon Aug 21 10:28:15 2023 +0800
[INLONG-823] Sync the error code with the change of inlong (#833)
Co-authored-by: healchow <[email protected]>
---
docs/modules/tubemq/error_code.md | 49 +++++++++++----------
.../current/modules/tubemq/error_code.md | 51 ++++++++++++----------
2 files changed, 53 insertions(+), 47 deletions(-)
diff --git a/docs/modules/tubemq/error_code.md
b/docs/modules/tubemq/error_code.md
index ea8c4fc6e9..98089170ba 100644
--- a/docs/modules/tubemq/error_code.md
+++ b/docs/modules/tubemq/error_code.md
@@ -5,33 +5,36 @@ title: Error Code
## 1 Introduction of TubeMQ Error
TubeMQ use `errCode` and `errMsg` combined to return specific operation
result. Firstly, determine the type of result(problem) by errCode, and then
determine the specific reson of the errCode based on errMsg. The following
table summarizes all the errCodes and errMsgs that may return during operation.
+TubeMQ's computation is parallel, and all child operations are surrounded by
the parent value. Note that the error code of the parent class and the subclass
have no synchronization relationship, and the error code of the parent class
only indicates whether the allocator of the TubeMQ child request works properly.
+The following error codes represent the error codes for sub-operations.
## 2 errCodes
| Error Type | errCode | Error Mark | Meaning | Note |
-| ---------- | ------- | ---------- | ------- | ---- |
-| Operation Success | 200 | Operation Success| Success. ||
-| Operation Success| 201| NOT_READY | The request is accepted, but the server
is not ready or the service is not running.| unused now, reserved. ||
-| Temporary Conflict Resolved | 301 | MOVED| Temporary switching of data
results in an unsuccessful operation and a request for a new operation needs to
be initiated. ||
-| Client Error | 400 | BAD_REQUEST| Client error, including parameter error,
status error, etc. |Refer to ErrMsg for detail to location the error. |
-| Client Error | 401| UNAUTHORIZED| Unauthorized operation, make sure that the
client has permission to perform the operation. | Need to check configuration.
||
-| Client Error | 403| FORBIDDEN | Topic not found or already deleted. |||
-| Client Error | 404| NOT_FOUND | Consumer has reach the max offset of the
topic. |||
-| Client Error | 405| ALL_PARTITION_FROZEN | All available partitions are
frozen. | The available partition has been frozen by the client, and it needs
to be unfrozen or wait a while and try again. ||
-| Client Error | 406| NO_PARTITION_ASSIGNED | The current client is not
allocated a partition for consumption. | The number of clients exceeds the
number of partitions, or the server has not performed load balancing
operations, so you need to wait and try again. ||
-| Client Error | 407| ALL_PARTITION_WAITING | The current available partitions
have reached the maximum consumption position. | Need to wait and try again. ||
-| Client Error | 408| ALL_PARTITION_INUSE | Currently available partitions are
all used by business but not released. | Need to wait for the business logic to
call the confirm API to release the partition, wait and try again. ||
-| Client Error | 410| PARTITION_OCCUPIED| Partition consumption conflicts.
Ignore it. | Temporary status of internal registration. ||
-| Client Error | 411| HB_NO_NODE| Node timeout, need to reduce the frequency
of the operation and wait a while before retrying. | It usually occurs when the
heartbeat sent from client to the server is timeout, try to reduce the
operation frequency and wait for a while for the lib to register successfully
before retrying the process. ||
-| Client Error | 412| DUPLICATE_PARTITION | Partition consumption conflicts.
Ignore it. | Usually caused by node timeout, retry it. ||
-| Client Error | 415| CERTIFICATE_FAILURE | Authorization fails, including
user authentication and operational authorization. | Usually occurs when the
user name and password are inconsistent, the operation is not authorized. ||
-| 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
`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. ||
+| ---------- |---------| ---------- | ------- | ---- |
+| Operation Success | 0 | Operation Success| This is the normal error
code that is currently used uniformly ||
+| Operation Success | 200 | Operation Success| This is the original normal
error code, this part of the error code is gradually modified to 0, but 200
still means normal ||
+| Operation Success| 201 | NOT_READY | The request is accepted, but the
server is not ready or the service is not running.| unused now, reserved. ||
+| Temporary Conflict Resolved | 301 | MOVED| Temporary switching of data
results in an unsuccessful operation and a request for a new operation needs to
be initiated. ||
+| Client Error | 400 | BAD_REQUEST| Client error, including parameter
error, status error, etc. |Refer to ErrMsg for detail to location the error. |
+| Client Error | 401 | UNAUTHORIZED| Unauthorized operation, make sure
that the client has permission to perform the operation. | Need to check
configuration. ||
+| Client Error | 403 | FORBIDDEN | Topic not found or already deleted. |||
+| Client Error | 404 | NOT_FOUND | Consumer has reach the max offset of
the topic. |||
+| Client Error | 405 | ALL_PARTITION_FROZEN | All available partitions are
frozen. | The available partition has been frozen by the client, and it needs
to be unfrozen or wait a while and try again. ||
+| Client Error | 406 | NO_PARTITION_ASSIGNED | The current client is not
allocated a partition for consumption. | The number of clients exceeds the
number of partitions, or the server has not performed load balancing
operations, so you need to wait and try again. ||
+| Client Error | 407 | ALL_PARTITION_WAITING | The current available
partitions have reached the maximum consumption position. | Need to wait and
try again. ||
+| Client Error | 408 | ALL_PARTITION_INUSE | Currently available
partitions are all used by business but not released. | Need to wait for the
business logic to call the confirm API to release the partition, wait and try
again. ||
+| Client Error | 410 | PARTITION_OCCUPIED| Partition consumption
conflicts. Ignore it. | Temporary status of internal registration. ||
+| Client Error | 411 | HB_NO_NODE| Node timeout, need to reduce the
frequency of the operation and wait a while before retrying. | It usually
occurs when the heartbeat sent from client to the server is timeout, try to
reduce the operation frequency and wait for a while for the lib to register
successfully before retrying the process. ||
+| Client Error | 412 | DUPLICATE_PARTITION | Partition consumption
conflicts. Ignore it. | Usually caused by node timeout, retry it. ||
+| Client Error | 415 | CERTIFICATE_FAILURE | Authorization fails,
including user authentication and operational authorization. | Usually occurs
when the user name and password are inconsistent, the operation is not
authorized. ||
+| 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 `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. ||
## 3 Common errMsgs
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 2187b4004b..aec25c20dd 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
@@ -5,33 +5,36 @@ title: 错误码定义
## 1 TubeMQ错误信息介绍
TubeMQ采用的是错误码(errCode) +
错误详情(errMsg)相结合的方式返回具体的操作结果。首先根据错误码确定是哪类问题，然后根据错误详情来确定具体的错误原因。表格汇总了所有的错误码以及运行中大家可能遇到的错误详情的相关对照。
+TubeMQ的计算是并行的，所有子操作被父值包围，注意，父类的错误码和子类并没有同步关系，父类的错误码仅表示TubeMQ子请求的分配器是否工作正常。
+以下错误码表示的是子操作的错误码。
## 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 | 读取不到消息集合
| 继续重试处理，如果持续的出现该类错误，需要联系管理员处理 |
+| 错误类别 | 错误码 | 错误标记 | 含义
| 备注 |
+| ---------- |-----| -------------------------------- |
-------------------------------------------------
|--------------------------------------------------|
+| 成功操作 | 0 | SUCCESS | 操作成功
| 这是目前统一采用的正常错误码 |
+| 成功操作 | 200 | SUCCESS | 操作成功
| 这是原先表示正常的错误码，这部分错误码正在逐渐修改为 0 ，但是 200 仍表示正常 |
+| 成功操作 | 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 常见错误信息
