diff --git "a/i18n/en/docusaurus-plugin-content-docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" "b/i18n/en/docusaurus-plugin-content-docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" index ca530d7122..741cd4c2cd 100644 --- "a/i18n/en/docusaurus-plugin-content-docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" +++ "b/i18n/en/docusaurus-plugin-content-docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" @@ -2,22 +2,22 @@ There are many custom parameters and resource names in the Apache RocketMQ system. You are advised to set the system according to the following instructions to avoid application exceptions caused by improper setting of certain parameters. -| Parameters | Recommended range | Instructions | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| -| Topic name | Characters suggest：a\~z A\~Z 0\~9 （_）（-）（%）

Suggested length：1\~64 characters

System reserved character：The following reserved characters or characters with special prefixes are not allowed for topic names.

reserved characters: TBW102 * BenchmarkTest * SELF_TEST_TOPIC * OFFSET_MOVED_EVENT * SCHEDULE_TOPIC_XXXX * RMQ_SYS_TRANS_HALF_TOPIC * RMQ_SYS_TRACE_TOPIC * RMQ_SYS_TRANS_OP_HALF_TOPIC

reserved prefix characters: * rmq_sys_ %RETRY%_ %DLQ%_ rocketmq-broker- | Topic name should use short, common characters and avoid special characters. Special characters may cause exceptions in system parsing. If the characters are too long, messages may be rejected. | -| ConsumerGroup name | Characters suggest：a\~z A\~Z 0\~9 （_）（-）（%）

Suggested length：1\~64 characters

System reserved character：The following reserved characters or characters with special prefixes are not allowed for consumerGroup names.

reserved characters: * DEFAULT_CONSUMER * DEFAULT_PRODUCER * TOOLS_CONSUMER * FILTERSRV_CONSUMER * __MONITOR_CONSUMER * CLIENT_INNER_PRODUCER * SELF_TEST_P_GROUP * SELF_TEST_C_GROUP * CID_ONS-HTTP-PROXY * CID_ONSAPI_PERMISSION * CID_ONSAPI_OWNER * CID_ONSAPI_PULL * CID_RMQ_SYS_TRANS * reserved characters * CID_RMQ_SYS_ * CID_HOUSEKEEPING | null | -| ACL credentials | Characters suggest：AK（AccessKey ID）、SK（AccessKey Secret）and Token only support a\~z A\~Z 0\~9

Suggested length：less than 1024 characters. | null | -| Request timeout | Default value：3000ms. | The request timeout duration is the waiting time for local synchronous invocation of clients. Set a proper value based on the actual application to avoid long thread blocking time. | -| Max message size | Default value：4 MB. Message compression is not involved, only the size of the message body is calculated.

Value range：Suggest less than 4 MB. | The message transmission should be compressed and the load should be controlled to avoid the transmission of large files. | -| Message custom properties | Character limit：All visible characters.

Suggested length：Sum of all keys and values less than 16KB.

System reserved properties：The following reserved properties are not allowed as keys for custom properties. System reserved Keys | null | -| MessageGroup | Character limit：All visible characters.

Suggested length：1\~64. | Generally, messageGroup is set to a set of message identifiers that need to ensure order, such as order, user, etc. | -| Max number of message sending retries | Default values：3 times.

Value range：No limits. | Sending retry policy is invisible to applications. A small value is recommended to avoid blocking service threads. If the message is not sent successfully after the maximum number of retries is reached, it is recommended that the service side perform backtracking to ensure message reliability. | -| Max number of message consume retries | Default value：16 times. | Consumption retry times set a proper value based on actual service requirements to avoid unlimited consumption retry times. If the number of retry times is too large, the system pressure increases. | -| Transaction exception check interval | Default value：60 seconds. | Transaction exception check interval refers to the interval at which semi-transaction messages are not committed due to system restart or abnormal conditions. The producer client will check back the transaction status according to this interval. Do not set the interval too short. Otherwise, the system performance may be affected by frequent callback calls. | -| Time of the first callback of a semi-transaction message | Default value：Refer to \[Transaction exception check interval\] * Max check times | null | -| Maximum timeout duration of semi-transaction messages | Default value：4 Hour. | If the semi-transaction message is not committed due to system restart or abnormal conditions, the producer client will check back according to the transaction exception check interval. If no result is returned after the timeout period of the semi-transaction message, the semi-transaction message will be forcibly rolled back. | -| PushConsumer sdk cache |Default value：

* Maximum cache num：1024

* Maximum cache size：64 M. | The number and size of cached messages should be set to the limit allowed by system memory. | -| PushConsumer retry intervals | Default value：

* Concurrent deliver type：The interval time ladder changes.

* Fifo deliver type：3000 ms. | null | -| PushConsumer consume threads | Default value：20 | null | -| Get message batch size | Default value：32 | The consumer obtains the maximum number of messages from the server at a time. You are advised to set a proper parameter value based on actual services. If the number of messages obtained at one time is too large, a large number of messages may be duplicated when consumption fails. | -| SimpleConsumer max invisible time | Default value：This parameter is mandatory and has no default value.

Suggested range：10 seconds to 12 hours. | Consumption invisible time refers to the total time between message processing and retry after failure. You are advised to set the value to a little longer than the actual time. | \ No newline at end of file +| Parameters | Recommended range | Instructions | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| Topic name | Characters suggest：a\~z A\~Z 0\~9 （_）（-）（%）

Suggested length：1\~64 characters

System reserved characters
  • TBW102
  • BenchmarkTest
  • SELF_TEST_TOPIC
  • OFFSET_MOVED_EVENT
  • SCHEDULE_TOPIC_XXXX
  • RMQ_SYS_TRANS_HALF_TOPIC
  • RMQ_SYS_TRACE_TOPIC
  • RMQ_SYS_TRANS_OP_HALF_TOPIC
    • Reserved prefix characters
  • rmq_sys\_
  • %RETRY%\_
  • %DLQ%\_
  • rocketmq-broker-
    • | Topic name should use short, common characters and avoid special characters. Special characters may cause exceptions in system parsing. If the characters are too long, messages may be rejected. | +| ConsumerGroup name | Characters suggest：a\~z A\~Z 0\~9 （_）（-）（%）

    Suggested length：1\~64 characters

    System reserved characters
  • DEFAULT_CONSUMER
  • DEFAULT_PRODUCER
  • TOOLS_CONSUMER
  • FILTERSRV_CONSUMER
  • __MONITOR_CONSUMER
  • CLIENT_INNER_PRODUCER
  • SELF_TEST_P_GROUP
  • SELF_TEST_C_GROUP
  • CID_ONS-HTTP-PROXY
  • CID_ONSAPI_PERMISSION
  • CID_ONSAPI_OWNER
  • CID_ONSAPI_PULL
  • CID_RMQ_SYS_TRANS
    • Reserved characters
  • CID_RMQ_SYS\_
  • CID_HOUSEKEEPING
    • | null | +| ACL credentials | Characters suggest：AK（AccessKey ID）、SK（AccessKey Secret）and Token only support a\~z A\~Z 0\~9

    Suggested length：less than 1024 characters. | null | +| Request timeout | Default value：3000ms. | The request timeout duration is the waiting time for local synchronous invocation of clients. Set a proper value based on the actual application to avoid long thread blocking time. | +| Max message size | Default value：4 MB. Message compression is not involved, only the size of the message body is calculated.

    Value range：Suggest less than 4 MB. | The message transmission should be compressed and the load should be controlled to avoid the transmission of large files. | +| Message custom properties | Character limit：All visible characters.

    Suggested length：Sum of all keys and values less than 16KB.

    System reserved properties：The following reserved properties are not allowed as keys for custom properties. System reserved Keys | null | +| MessageGroup | Character limit：All visible characters.

    Suggested length：1\~64. | Generally, messageGroup is set to a set of message identifiers that need to ensure order, such as order, user, etc. | +| Max number of message sending retries | Default values：3 times.

    Value range：No limits. | Sending retry policy is invisible to applications. A small value is recommended to avoid blocking service threads. If the message is not sent successfully after the maximum number of retries is reached, it is recommended that the service side perform backtracking to ensure message reliability. | +| Max number of message consume retries | Default value：16 times. | Consumption retry times set a proper value based on actual service requirements to avoid unlimited consumption retry times. If the number of retry times is too large, the system pressure increases. | +| Transaction exception check interval | Default value：60 seconds. | Transaction exception check interval refers to the interval at which semi-transaction messages are not committed due to system restart or abnormal conditions. The producer client will check back the transaction status according to this interval. Do not set the interval too short. Otherwise, the system performance may be affected by frequent callback calls. | +| Time of the first callback of a semi-transaction message | Default value：Refer to \[Transaction exception check interval\] * Max check times | null | +| Maximum timeout duration of semi-transaction messages | Default value：4 Hour. | If the semi-transaction message is not committed due to system restart or abnormal conditions, the producer client will check back according to the transaction exception check interval. If no result is returned after the timeout period of the semi-transaction message, the semi-transaction message will be forcibly rolled back. | +| PushConsumer sdk cache | Default value：

    * Maximum cache num：1024

    * Maximum cache size：64 M. | The number and size of cached messages should be set to the limit allowed by system memory. | +| PushConsumer retry intervals | Default value：

    * Concurrent deliver type：The interval time ladder changes.

    * Fifo deliver type：3000 ms. | null | +| PushConsumer consume threads | Default value：20 | null | +| Get message batch size | Default value：32 | The consumer obtains the maximum number of messages from the server at a time. You are advised to set a proper parameter value based on actual services. If the number of messages obtained at one time is too large, a large number of messages may be duplicated when consumption fails. | +| SimpleConsumer max invisible time | Default value：This parameter is mandatory and has no default value.

    Suggested range：10 seconds to 12 hours. | Consumption invisible time refers to the total time between message processing and retry after failure. You are advised to set the value to a little longer than the actual time. | \ No newline at end of file diff --git "a/versioned_docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" "b/versioned_docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" index 05b1f03eab..7f0d05f444 100644 --- "a/versioned_docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" +++ "b/versioned_docs/version-5.0/01-\345\237\272\347\241\200\344\273\213\347\273\215/03limits.md" @@ -3,22 +3,22 @@ Apache RocketMQ 系统中存在很多自定义参数和资源命名，您在使用 Apache RocketMQ 时建议参考如下说明规范系统设置，避对某些具体参数设置不合理导致应用出现异常。 -| 参数 | 建议范围 | 说明 | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| -| Topic名称 | 字符建议：字母a\~z或A\~Z、数字0\~9以及下划线（_）、短划线（-）和百分号（%）。

    长度建议：1\~64个字符。

    系统保留字符：Topic名称不允许使用以下保留字符或含有特殊前缀的字符命名。

    保留字符: TBW102 * BenchmarkTest * SELF_TEST_TOPIC * OFFSET_MOVED_EVENT * SCHEDULE_TOPIC_XXXX * RMQ_SYS_TRANS_HALF_TOPIC * RMQ_SYS_TRACE_TOPIC * RMQ_SYS_TRANS_OP_HALF_TOPIC

    特殊前缀: * rmq_sys_ %RETRY%_ %DLQ%_ rocketmq-broker- | Topic命名应该尽量使用简短、常用的字符，避免使用特殊字符。特殊字符会导致系统解析出现异常，字符过长可能会导致消息收发被拒绝。 | -| ConsumerGroup名称 | 字符建议：支持字母a\~z或A\~Z、数字0\~9以及下划线（_）、短划线（-）和百分号（%）。

    长度建议：1\~64个字符。

    系统保留字符：ConsumerGroup不允许使用以下保留字符或含有特殊前缀的字符命名。

    保留字符: * DEFAULT_CONSUMER * DEFAULT_PRODUCER * TOOLS_CONSUMER * FILTERSRV_CONSUMER * __MONITOR_CONSUMER * CLIENT_INNER_PRODUCER * SELF_TEST_P_GROUP * SELF_TEST_C_GROUP * CID_ONS-HTTP-PROXY * CID_ONSAPI_PERMISSION * CID_ONSAPI_OWNER * CID_ONSAPI_PULL * CID_RMQ_SYS_TRANS * 特殊字符 * CID_RMQ_SYS_ * CID_HOUSEKEEPING | 无。 | -| ACL Credentials | 字符建议：AK（AccessKey ID）、SK（AccessKey Secret）和Token仅支持字母a\~z或A\~Z、数字0\~9。

    长度建议：不超过1024个字符。 | 无。 | -| 请求超时时间 | 默认值：3000毫秒。

    取值范围：该参数为客户端本地行为，取值范围建议不要超过30000毫秒。 | 请求超时时间是客户端本地同步调用的等待时间，请根据实际应用设置合理的取值，避免线程阻塞时间过长。 | -| 消息大小 | 默认值：不超过4 MB。不涉及消息压缩，仅计算消息体body的大小。

    取值范围：建议不超过4 MB。 | 消息传输应尽量压缩和控制负载大小，避免超大文件传输。若消息大小不满足限制要求，可以尝试分割消息或使用OSS存储，用消息传输URL。 | -| 消息自定义属性 | 字符限制：所有可见字符。

    长度建议：属性的Key和Value总长度不超过16 KB。

    系统保留属性：不允许使用以下保留属性作为自定义属性的Key。 保留属性Key | 无。 | -| MessageGroup | 字符限制：所有可见字符。

    长度建议：1\~64字节。 | MessageGroup是顺序消息的分组标识。一般设置为需要保证顺序的一组消息标识，例如订单ID、用户ID等。 | -| 消息发送重试次数 | 默认值：3次。

    取值范围：无限制。 | 消息发送重试是客户端SDK内置的重试策略，对应用不可见，建议取值不要过大，避免阻塞业务线程。 如果消息达到最大重试次数后还未发送成功，建议业务侧做好兜底处理，保证消息可靠性。 | -| 消息消费重试次数 | 默认值：16次。 | 消费重试次数应根据实际业务需求设置合理的参数值，避免使用重试进行无限触发。重试次数过大容易造成系统压力过量增加。 | -| 事务异常检查间隔 | 默认值：60秒。 | 事务异常检查间隔指的是，半事务消息因系统重启或异常情况导致没有提交，生产者客户端会按照该间隔时间进行事务状态回查。 间隔时长不建议设置过短，否则频繁的回查调用会影响系统性能。 | -| 半事务消息第一次回查时间 | 默认值：取值等于\[事务异常检查间隔\] * 最大限制：不超过1小时。 | 无。 | -| 半事务消息最大超时时长 | 默认值：4小时。 * 取值范围：不支持自定义修改。 | 半事务消息因系统重启或异常情况导致没有提交，生产者客户端会按照事务异常检查间隔时间进行回查，若超过半事务消息超时时长后没有返回结果，半事务消息将会被强制回滚。 您可以通过监控该指标避免异常事务。 | -| PushConsumer本地缓存 |默认值：

    * 最大缓存数量：1024条。

    * 最大缓存大小：64 M。

    取值范围：支持用户自定义设置，无限制。 | 消费者类型为PushConsumer时，为提高消费者吞吐量和性能，客户端会在SDK本地缓存部分消息。缓存的消息的数量和大小应设置在系统内存允许的范围内。 | -| PushConsumer重试间隔时长 | 默认值：

    * 非顺序性投递：间隔时间阶梯变化，具体取值，请参见PushConsumer消费重试策略。

    * 顺序性投递：3000毫秒。 | 无。 | -| PushConsumer消费并发度 | 默认值：20个线程。 | 无。 | -| 获取消息最大批次 | 默认值：32条。 | 消费者从服务端获取消息时，一次获取到最大消息条数。建议按照实际业务设置合理的参数值，一次获取消息数量过大容易在消费失败时造成大批量消息重复。 | -| SimpleConsumer最大不可见时间 | 默认值：用户必填参数，无默认值。

    取值范围建议：最小10秒；最大12小时。 | 消费不可见时间指的是消息处理+失败后重试间隔的总时长，建议设置时取值比实际需要耗费的时间稍微长一些。 | \ No newline at end of file +| 参数 | 建议范围 | 说明 | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| Topic名称 | 字符建议：字母a\~z或A\~Z、数字0\~9以及下划线（_）、短划线（-）和百分号（%）。

    长度建议：1\~64个字符。

    系统保留字符：Topic名称不允许使用以下保留字符或含有特殊前缀的字符命名。

    保留字符
  • TBW102
  • BenchmarkTest
  • SELF_TEST_TOPIC
  • OFFSET_MOVED_EVENT
  • SCHEDULE_TOPIC_XXXX
  • RMQ_SYS_TRANS_HALF_TOPIC
  • RMQ_SYS_TRACE_TOPIC
  • RMQ_SYS_TRANS_OP_HALF_TOPIC
    • 特殊前缀
  • rmq_sys\_
  • %RETRY%\_
  • %DLQ%\_
  • rocketmq-broker-
    • | Topic命名应该尽量使用简短、常用的字符，避免使用特殊字符。特殊字符会导致系统解析出现异常，字符过长可能会导致消息收发被拒绝。 | +| ConsumerGroup名称 | 字符建议：支持字母a\~z或A\~Z、数字0\~9以及下划线（_）、短划线（-）和百分号（%）。

    长度建议：1\~64个字符。

    系统保留字符：ConsumerGroup不允许使用以下保留字符或含有特殊前缀的字符命名。

    保留字符
  • DEFAULT_CONSUMER
  • DEFAULT_PRODUCER
  • TOOLS_CONSUMER
  • FILTERSRV_CONSUMER
  • __MONITOR_CONSUMER
  • CLIENT_INNER_PRODUCER
  • SELF_TEST_P_GROUP
  • SELF_TEST_C_GROUP
  • CID_ONS-HTTP-PROXY
  • CID_ONSAPI_PERMISSION
  • CID_ONSAPI_OWNER
  • CID_ONSAPI_PULL
  • CID_RMQ_SYS_TRANS
    • 特殊字符
  • CID_RMQ_SYS\_
  • CID_HOUSEKEEPING
    • | 无。 | +| ACL Credentials | 字符建议：AK（AccessKey ID）、SK（AccessKey Secret）和Token仅支持字母a\~z或A\~Z、数字0\~9。

    长度建议：不超过1024个字符。 | 无。 | +| 请求超时时间 | 默认值：3000毫秒。

    取值范围：该参数为客户端本地行为，取值范围建议不要超过30000毫秒。 | 请求超时时间是客户端本地同步调用的等待时间，请根据实际应用设置合理的取值，避免线程阻塞时间过长。 | +| 消息大小 | 默认值：不超过4 MB。不涉及消息压缩，仅计算消息体body的大小。

    取值范围：建议不超过4 MB。 | 消息传输应尽量压缩和控制负载大小，避免超大文件传输。若消息大小不满足限制要求，可以尝试分割消息或使用OSS存储，用消息传输URL。 | +| 消息自定义属性 | 字符限制：所有可见字符。

    长度建议：属性的Key和Value总长度不超过16 KB。

    系统保留属性：不允许使用以下保留属性作为自定义属性的Key。 保留属性Key | 无。 | +| MessageGroup | 字符限制：所有可见字符。

    长度建议：1\~64字节。 | MessageGroup是顺序消息的分组标识。一般设置为需要保证顺序的一组消息标识，例如订单ID、用户ID等。 | +| 消息发送重试次数 | 默认值：3次。

    取值范围：无限制。 | 消息发送重试是客户端SDK内置的重试策略，对应用不可见，建议取值不要过大，避免阻塞业务线程。 如果消息达到最大重试次数后还未发送成功，建议业务侧做好兜底处理，保证消息可靠性。 | +| 消息消费重试次数 | 默认值：16次。 | 消费重试次数应根据实际业务需求设置合理的参数值，避免使用重试进行无限触发。重试次数过大容易造成系统压力过量增加。 | +| 事务异常检查间隔 | 默认值：60秒。 | 事务异常检查间隔指的是，半事务消息因系统重启或异常情况导致没有提交，生产者客户端会按照该间隔时间进行事务状态回查。 间隔时长不建议设置过短，否则频繁的回查调用会影响系统性能。 | +| 半事务消息第一次回查时间 | 默认值：取值等于\[事务异常检查间隔\] * 最大限制：不超过1小时。 | 无。 | +| 半事务消息最大超时时长 | 默认值：4小时。 * 取值范围：不支持自定义修改。 | 半事务消息因系统重启或异常情况导致没有提交，生产者客户端会按照事务异常检查间隔时间进行回查，若超过半事务消息超时时长后没有返回结果，半事务消息将会被强制回滚。 您可以通过监控该指标避免异常事务。 | +| PushConsumer本地缓存 | 默认值：

    * 最大缓存数量：1024条。

    * 最大缓存大小：64 M。

    取值范围：支持用户自定义设置，无限制。 | 消费者类型为PushConsumer时，为提高消费者吞吐量和性能，客户端会在SDK本地缓存部分消息。缓存的消息的数量和大小应设置在系统内存允许的范围内。 | +| PushConsumer重试间隔时长 | 默认值：

    * 非顺序性投递：间隔时间阶梯变化，具体取值，请参见PushConsumer消费重试策略。

    * 顺序性投递：3000毫秒。 | 无。 | +| PushConsumer消费并发度 | 默认值：20个线程。 | 无。 | +| 获取消息最大批次 | 默认值：32条。 | 消费者从服务端获取消息时，一次获取到最大消息条数。建议按照实际业务设置合理的参数值，一次获取消息数量过大容易在消费失败时造成大批量消息重复。 | +| SimpleConsumer最大不可见时间 | 默认值：用户必填参数，无默认值。

    取值范围建议：最小10秒；最大12小时。 | 消费不可见时间指的是消息处理+失败后重试间隔的总时长，建议设置时取值比实际需要耗费的时间稍微长一些。 | \ No newline at end of file