This is an automated email from the ASF dual-hosted git repository. jinrongtong pushed a commit to branch new-official-website in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
The following commit(s) were added to refs/heads/new-official-website by this push: new 57d7bb959a [ISSUE #700] Fix typo. (#701) 57d7bb959a is described below commit 57d7bb959aa083e50863a4432e1dd5f98a74e81b Author: luozongle01 <luozon...@hotmail.com> AuthorDate: Fri Dec 27 16:48:26 2024 +0800 [ISSUE #700] Fix typo. (#701) --- docs/03-consumer/02push.md | 2 +- docs/04-deployment/02admintool.md | 8 ++--- docs/05-bestPractice/01bestpractice.md | 32 ++++++++--------- docs/05-bestPractice/02dledger.md | 2 +- docs/05-bestPractice/06log.md | 14 ++++---- docs/11-contributionGuide/01how-to-contribute.md | 2 +- .../current/03-consumer/02push.md | 2 +- .../current/04-deployment/02admintool.md | 10 +++--- .../current/05-bestPractice/01bestpractice.md | 32 ++++++++--------- .../current/05-bestPractice/06log.md | 14 ++++---- .../11-contributionGuide/01how-to-contribute.md | 2 +- .../05-deploymentOperations/02admintool.md | 10 +++--- .../version-5.0/06-bestPractice/01bestpractice.md | 32 ++++++++--------- .../version-5.0/06-bestPractice/06FAQ.md | 2 +- .../11-contributionGuide/01how-to-contribute.md | 2 +- .../version-5.0/12-observability/01metrics.md | 40 +++++++++++----------- .../05-deploymentOperations/02admintool.md | 8 ++--- .../version-5.0/06-bestPractice/01bestpractice.md | 32 ++++++++--------- .../version-5.0/06-bestPractice/02dledger.md | 2 +- .../version-5.0/06-bestPractice/06FAQ.md | 2 +- .../10-connect/01RocketMQ Connect Overview.md | 2 +- .../11-contributionGuide/01how-to-contribute.md | 2 +- 22 files changed, 127 insertions(+), 127 deletions(-) diff --git a/docs/03-consumer/02push.md b/docs/03-consumer/02push.md index 5ce15c5d6f..b9045aec9f 100644 --- a/docs/03-consumer/02push.md +++ b/docs/03-consumer/02push.md @@ -125,7 +125,7 @@ Tag在生产者章节已经介绍过,用于对某个Topic下的消息进行分 ![Tag过滤](../picture/Tag过滤.png) -对于物流系统和支付系统来说,它们都只订阅单个Tag,此时只需要在调用subcribe接口时明确标明Tag即可。 +对于物流系统和支付系统来说,它们都只订阅单个Tag,此时只需要在调用subscribe接口时明确标明Tag即可。 ```java consumer.subscribe("TagFilterTest", "TagA"); diff --git a/docs/04-deployment/02admintool.md b/docs/04-deployment/02admintool.md index 519f8a2401..1519c735c1 100644 --- a/docs/04-deployment/02admintool.md +++ b/docs/04-deployment/02admintool.md @@ -1316,7 +1316,7 @@ -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -2420,7 +2420,7 @@ -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -3896,7 +3896,7 @@ width: "65pt" }} > - consumerConnec tion + consumerConnection </td> <td rowSpan={3} @@ -3952,7 +3952,7 @@ width: "65pt" }} > - producerConnec tion + producerConnection </td> <td rowSpan={4} diff --git a/docs/05-bestPractice/01bestpractice.md b/docs/05-bestPractice/01bestpractice.md index 00bbede8ed..0b3f119600 100644 --- a/docs/05-bestPractice/01bestpractice.md +++ b/docs/05-bestPractice/01bestpractice.md @@ -213,20 +213,20 @@ msgId一定是全局唯一标识符,但是实际使用中,可能会存在相 SYNC_FLUSH(同步刷新)相比于ASYNC_FLUSH(异步处理)会损失很多性能,但是也更可靠,所以需要根据实际的业务场景做好权衡。 ### Broker 配置 -| 参数名 | 默认值 | 说明 | -| -------------------------------- | ----------------------------- | ------------------------------------------------------------ | -| listenPort | 10911 | 接受客户端连接的监听端口 | -| namesrvAddr | null | nameServer 地址 | -| brokerIP1 | 网卡的 InetAddress | 当前 broker 监听的 IP | -| brokerIP2 | 跟 brokerIP1 一样 | 存在主从 broker 时,如果在 broker 主节点上配置了 brokerIP2 属性,broker 从节点会连接主节点配置的 brokerIP2 进行同步 | -| brokerName | null | broker 的名称 | -| brokerClusterName | DefaultCluster | 本 broker 所属的 Cluser 名称 | -| brokerId | 0 | broker id, 0 表示 master, 其他的正整数表示 slave | -| storePathCommitLog | $HOME/store/commitlog/ | 存储 commit log 的路径 | -| storePathConsumerQueue | $HOME/store/consumequeue/ | 存储 consume queue 的路径 | -| mapedFileSizeCommitLog | 1024 * 1024 * 1024(1G) | commit log 的映射文件大小 | -| deleteWhen | 04 | 在每天的什么时间删除已经超过文件保留时间的 commit log | -| fileReservedTime | 72 | 以小时计算的文件保留时间 | -| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | -| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 | +| 参数名 | 默认值 | 说明 | +| -------------------------------- | ----------------------------- |-----------------------------------------------------------------------------------------------------------------| +| listenPort | 10911 | 接受客户端连接的监听端口 | +| namesrvAddr | null | nameServer 地址 | +| brokerIP1 | 网卡的 InetAddress | 当前 broker 监听的 IP | +| brokerIP2 | 跟 brokerIP1 一样 | 存在主从 broker 时,如果在 broker 主节点上配置了 brokerIP2 属性,broker 从节点会连接主节点配置的 brokerIP2 进行同步 | +| brokerName | null | broker 的名称 | +| brokerClusterName | DefaultCluster | 本 broker 所属的 Cluster 名称 | +| brokerId | 0 | broker id, 0 表示 master, 其他的正整数表示 slave | +| storePathCommitLog | $HOME/store/commitlog/ | 存储 commit log 的路径 | +| storePathConsumerQueue | $HOME/store/consumequeue/ | 存储 consume queue 的路径 | +| mappedFileSizeCommitLog | 1024 * 1024 * 1024(1G) | commit log 的映射文件大小 | +| deleteWhen | 04 | 在每天的什么时间删除已经超过文件保留时间的 commit log | +| fileReservedTime | 72 | 以小时计算的文件保留时间 | +| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | +| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 | diff --git a/docs/05-bestPractice/02dledger.md b/docs/05-bestPractice/02dledger.md index 60b4f50d48..4d8f3da4c6 100644 --- a/docs/05-bestPractice/02dledger.md +++ b/docs/05-bestPractice/02dledger.md @@ -120,7 +120,7 @@ $ nohup sh bin/mqbroker -c conf/dledger/xxx-n2.conf & #### 2.2 检查旧的 Commitlog RocketMQ-on-DLedger 组中的每个节点,可以兼容旧的 Commitlog ,但其 Raft 复制过程,只能针对新增加的消息。因此,为了避免出现异常,需要保证 旧的 Commitlog 是一致的。 -如果旧的集群是采用 Master-Slave 方式部署,有可能在shutdown时,其数据并不是一致的,建议通过md5sum 的方式,检查最近的最少 2 个 Commmitlog 文件,如果发现不一致,则通过拷贝的方式进行对齐。 +如果旧的集群是采用 Master-Slave 方式部署,有可能在shutdown时,其数据并不是一致的,建议通过md5sum 的方式,检查最近的最少 2 个 Commitlog 文件,如果发现不一致,则通过拷贝的方式进行对齐。 虽然 RocketMQ-on-DLedger Group 也可以以 2 节点方式部署,但其会丧失容灾切换能力(2n + 1 原则,至少需要3个节点才能容忍其中 1 个宕机)。 所以在对齐了 Master 和 Slave 的 Commitlog 之后,还需要准备第 3 台机器,并把旧的 Commitlog 从 Master 拷贝到 第 3 台机器(记得同时拷贝一下 config 文件夹)。 diff --git a/docs/05-bestPractice/06log.md b/docs/05-bestPractice/06log.md index 52fa2e9d12..5a11f00954 100644 --- a/docs/05-bestPractice/06log.md +++ b/docs/05-bestPractice/06log.md @@ -108,14 +108,14 @@ clean dependency:tree | grep log```命令排查。 RocketMQ 客户端支持自定义日志保存路径、日志级别以及保存历史日志文件的最大个数。考虑到日志传输以及阅读的便利性,暂不允许自定义单个日志文件大小,仍保持默认的64 MB。各参数的配置说明如下: -| 参数 | 说明 | 配置参数 | 自定义取值 | -| ----------------------------- | ------------------------------------------------------------ | ------------------------------- | ------------------------------------------------------------ | +| 参数 | 说明 | 配置参数 | 自定义取值 | +| ----------------------------- | ------------------------------------------------------------ | ------------------------------- |--------------------------------------------------| | 日志保存路径 | 请确保应用进程有对该路径写的权限,否则日志 不会打印。 | rocketmq.client.logRoot | 可自定义为您需要将日志文件保存到本地的路径。请确保您的应用进程有该路径的写权限,否则日志无法打印。 | -| 保存历史日志文件的最大个数 | 支持1到100之前的数值;若输入的值超出该范围 或格式错误,则系统默认保存10个。 | rocketmq.client.logFileMaxIndex | 取值范围:1~100。若设置的值超出该范围或格式错误,则以系统默认值(10个)为准。 | -| 日志级别 | 支持ERROR、WARN、INFO、DEBUG中任何一 种,不匹配默认INFO。 | rocketmq.client.logLevel | 取值如下:**ERROR****WARN****INFO****DEBUG** | -| 单个文件日志大小 | 支持以bytes为单位指定 | rocketmq.client.logFileMaxSize | 取值在0~1GB, 默认1GB, 建议64 MB | -| logback是否使用父级logger打印 | children-logger是否使用 rootLogger配置的appender进行输出 | rocketmq.client.log.additive | true/false | -| 使用项目的slf4j实现记录日志 | 如果需要实现记录日志 则为true | rocketmq.client.logUseSlf4j | true/flase | +| 保存历史日志文件的最大个数 | 支持1到100之前的数值;若输入的值超出该范围 或格式错误,则系统默认保存10个。 | rocketmq.client.logFileMaxIndex | 取值范围:1~100。若设置的值超出该范围或格式错误,则以系统默认值(10个)为准。 | +| 日志级别 | 支持ERROR、WARN、INFO、DEBUG中任何一 种,不匹配默认INFO。 | rocketmq.client.logLevel | 取值如下:**ERROR****WARN****INFO****DEBUG** | +| 单个文件日志大小 | 支持以bytes为单位指定 | rocketmq.client.logFileMaxSize | 取值在0~1GB, 默认1GB, 建议64 MB | +| logback是否使用父级logger打印 | children-logger是否使用 rootLogger配置的appender进行输出 | rocketmq.client.log.additive | true/false | +| 使用项目的slf4j实现记录日志 | 如果需要实现记录日志 则为true | rocketmq.client.logUseSlf4j | true/false | ## 默认配置 diff --git a/docs/11-contributionGuide/01how-to-contribute.md b/docs/11-contributionGuide/01how-to-contribute.md index df9ea17dda..39ae823614 100644 --- a/docs/11-contributionGuide/01how-to-contribute.md +++ b/docs/11-contributionGuide/01how-to-contribute.md @@ -133,7 +133,7 @@ Apache RocketMQ 官网代表着 Apache RocketMQ 和 Apache RocketMQ 社区。其 Committers 是社区中修改项目仓库的成员,可修改代码,文档和网站或接纳其他成员的贡献。 -成为 commiter 并没有严格的协议,候选人通常是社区中活跃的贡献者。 +成为 committer 并没有严格的协议,候选人通常是社区中活跃的贡献者。 活跃的贡献者意味着:参加邮箱列表中的讨论,帮助他人解决问题,验证预发布版本,礼贤下士并持续优化社区管理,这部分关乎社区在 Apache 中的发展。 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/03-consumer/02push.md b/i18n/en/docusaurus-plugin-content-docs/current/03-consumer/02push.md index 955955ace6..915c86fadc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/03-consumer/02push.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/03-consumer/02push.md @@ -125,7 +125,7 @@ The filtering schematic is shown below ![Tag过滤](../picture/Tag过滤.png) -For logistics systems and payment systems, they both subscribe to a single Tag, at which point it is sufficient to mark the Tag when calling the subcribe interface. +For logistics systems and payment systems, they both subscribe to a single Tag, at which point it is sufficient to mark the Tag when calling the subscribe interface. ```java consumer.subscribe("TagFilterTest", "TagA"); diff --git a/i18n/en/docusaurus-plugin-content-docs/current/04-deployment/02admintool.md b/i18n/en/docusaurus-plugin-content-docs/current/04-deployment/02admintool.md index fa5cc40c63..07264c434b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/04-deployment/02admintool.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/04-deployment/02admintool.md @@ -1316,7 +1316,7 @@ Query based on msgId. msgId is different from offsetMsgId, for more information -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -2420,7 +2420,7 @@ Reset offset based on timestamp, both Broker and consumer will be reset. -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -3746,7 +3746,7 @@ Consumer group consumption status, including specific client IP's message accumu -g </td> <td className="xl68" width={87} style={{ width: "65pt" }}> - Counsumer group name + Consumer group name </td> </tr> <tr height={57} style={{ height: "43.0pt" }}> @@ -3894,7 +3894,7 @@ Consumer group consumption status, including specific client IP's message accumu width: "65pt" }} > - consumerConnec tion + consumerConnection </td> <td rowSpan={3} @@ -3950,7 +3950,7 @@ Consumer group consumption status, including specific client IP's message accumu width: "65pt" }} > - producerConnec tion + producerConnection </td> <td rowSpan={4} diff --git a/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/01bestpractice.md b/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/01bestpractice.md index 63b1d31bac..7b1ddf33fe 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/01bestpractice.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/01bestpractice.md @@ -230,19 +230,19 @@ CONSUME_FROM_FIRST_OFFSET will consume every information that exists in the Brok ### Broker Configuration -| Parameter | Default | Description | -|------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| listenPort | 10911 | A listening port that accepts client connections | -| namesrvAddr | null | nameServer address | -| brokerIP1 | The network InetAddress | The IP address on which the broker is currently listening | -| brokerIP2 | same to brokerIP1 | When a master/slave broker exists, if the brokerIP2 property is configured on the broker master node, the broker slave node will connect to the brokerIP2 configured on the master node for synchronization | -| brokerName | null | broker name | -| brokerClusterName | DefaultCluster | The Cluser name to which this broker belongs | -| brokerId | 0 | broker id 0 indicates master, and other positive integers indicate slave | -| storePathCommitLog | $HOME/store/commitlog/ | Path to store the commit log | -| storePathConsumerQueue | $HOME/store/consumequeue/ | A path that consumes queue is stored | -| mapedFileSizeCommitLog | 1024 * 1024 * 1024(1G) | commit log mapping file size | -| deleteWhen | 04 | At what time of day should I delete the commit log whose file retention time has exceeded | -| fileReservedTime | 72 | File retention time in hours | -| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | -| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH The broker in SYNC_FLUSH mode guarantees to flush messages before receiving the acknowledged producer. ASYNC_FLUSH brokers use the flush mode to flush a group of messages for better performance. | \ No newline at end of file +| Parameter | Default | Description | +|------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| listenPort | 10911 | A listening port that accepts client connections | +| namesrvAddr | null | nameServer address | +| brokerIP1 | The network InetAddress | The IP address on which the broker is currently listening | +| brokerIP2 | same to brokerIP1 | When a master/slave broker exists, if the brokerIP2 property is configured on the broker master node, the broker slave node will connect to the brokerIP2 configured on the master node for synchronization | +| brokerName | null | broker name | +| brokerClusterName | DefaultCluster | The Cluster name to which this broker belongs | +| brokerId | 0 | broker id 0 indicates master, and other positive integers indicate slave | +| storePathCommitLog | $HOME/store/commitlog/ | Path to store the commit log | +| storePathConsumerQueue | $HOME/store/consumequeue/ | A path that consumes queue is stored | +| mappedFileSizeCommitLog | 1024 * 1024 * 1024(1G) | commit log mapping file size | +| deleteWhen | 04 | At what time of day should I delete the commit log whose file retention time has exceeded | +| fileReservedTime | 72 | File retention time in hours | +| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | +| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH The broker in SYNC_FLUSH mode guarantees to flush messages before receiving the acknowledged producer. ASYNC_FLUSH brokers use the flush mode to flush a group of messages for better performance. | \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/06log.md b/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/06log.md index efa58f4ca7..6e77a3fbb3 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/06log.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/06log.md @@ -106,14 +106,14 @@ Having both log4j and logback log implementations in the application will cause The RocketMQ client supports customizing the log save path, log level, and maximum number of historical log files to save. To ensure convenience in log transfer and reading, customizing the size of a single log file is currently not allowed and remains at the default of 64 MB. The configuration instructions for each parameter are as follows: -| Parameter | Explain | Configuration parameter | Custom value | -| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------- | ------------------------------------------------------------ | +| Parameter | Explain | Configuration parameter | Custom value | +| ----------------------------------------------------- | ------------------------------------------------------------ | ------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Log save path | Please make sure that the application process has write permission to the specified path, otherwise the log will not be printed. | rocketmq.client.logRoot | You can customize the path where you want to save the log files locally. Please make sure that your application process has write permission to that path, otherwise the log will not be printed. | -| Maximum number of historical log files to save | The supported value range is between 1 to 100; if the input value is outside of this range or in the wrong format, the system will default to saving 10 logs. | rocketmq.client.logFileMaxIndex | The value range is 1~100. If the value set is out of range or in the wrong format, the default value (10) will be used. | -| Log level | The supported log levels are ERROR, WARN, INFO, DEBUG, if no match is found the default is INFO. | rocketmq.client.logLevel | Values:**ERROR WARN INFO DEBUG** | -| Size of a single log file | Support specifying in bytes | rocketmq.client.logFileMaxSize | The value range is 0~1GB, the default is 1GB, it is recommended to use 64 MB | -| Whether to use parent logger to print logback | Whether children-logger use the appender configured by rootLogger for output | rocketmq.client.log.additive | true/false | -| Use the project's slf4j implementation to record logs | If need to implement log recording, set it to true | rocketmq.client.logUseSlf4j | true/flase | +| Maximum number of historical log files to save | The supported value range is between 1 to 100; if the input value is outside of this range or in the wrong format, the system will default to saving 10 logs. | rocketmq.client.logFileMaxIndex | The value range is 1~100. If the value set is out of range or in the wrong format, the default value (10) will be used. | +| Log level | The supported log levels are ERROR, WARN, INFO, DEBUG, if no match is found the default is INFO. | rocketmq.client.logLevel | Values:**ERROR WARN INFO DEBUG** | +| Size of a single log file | Support specifying in bytes | rocketmq.client.logFileMaxSize | The value range is 0~1GB, the default is 1GB, it is recommended to use 64 MB | +| Whether to use parent logger to print logback | Whether children-logger use the appender configured by rootLogger for output | rocketmq.client.log.additive | true/false | +| Use the project's slf4j implementation to record logs | If need to implement log recording, set it to true | rocketmq.client.logUseSlf4j | true/false | ## Default configuration diff --git a/i18n/en/docusaurus-plugin-content-docs/current/11-contributionGuide/01how-to-contribute.md b/i18n/en/docusaurus-plugin-content-docs/current/11-contributionGuide/01how-to-contribute.md index 2f6647c0e6..3c5150e97b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/11-contributionGuide/01how-to-contribute.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/11-contributionGuide/01how-to-contribute.md @@ -117,7 +117,7 @@ There are many more ways to contribute to the RocketMQ community that you can ch Committers are members of a community's project repository who can modify code, documents, and websites or accept contributions from other members. -There is no strict protocol for becoming a commiter, and candidates are usually active contributors in the community. +There is no strict protocol for becoming a committer, and candidates are usually active contributors in the community. Being an active contributor means: participating in discussions on email lists, helping others solve problems, verifying pre-release versions, honoring the good people and continuously optimizing community management, which is part of the community in Apache. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/05-deploymentOperations/02admintool.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/05-deploymentOperations/02admintool.md index 2395ab31b4..c519a16535 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/05-deploymentOperations/02admintool.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/05-deploymentOperations/02admintool.md @@ -1310,7 +1310,7 @@ Query based on msgId. msgId is different from offsetMsgId, for more information -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -2411,7 +2411,7 @@ Reset offset based on timestamp, both Broker and consumer will be reset. -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -3738,7 +3738,7 @@ Consumer group consumption status, including specific client IP's message accumu -g </td> <td className="xl68" width={87} style={{ width: "65pt" }}> - Counsumer group name + Consumer group name </td> </tr> <tr height={57} style={{ height: "43.0pt" }}> @@ -3885,7 +3885,7 @@ Consumer group consumption status, including specific client IP's message accumu width: "65pt" }} > - consumerConnec tion + consumerConnection </td> <td rowSpan={3} @@ -3941,7 +3941,7 @@ Consumer group consumption status, including specific client IP's message accumu width: "65pt" }} > - producerConnec tion + producerConnection </td> <td rowSpan={4} diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/01bestpractice.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/01bestpractice.md index a8242a6d03..ff1373380d 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/01bestpractice.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/01bestpractice.md @@ -100,19 +100,19 @@ Compared with ASYNC_FLUSH, SYNC_FLUSH suffers from performance loss but is more ### Broker Configuration -| Parameter | Default | Description | -|------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| listenPort | 10911 | A listening port that accepts client connections | -| namesrvAddr | null | nameServer address | -| brokerIP1 | The network InetAddress | The IP address on which the broker is currently listening | -| brokerIP2 | same to brokerIP1 | When a master/slave broker exists, if the brokerIP2 property is configured on the broker master node, the broker slave node will connect to the brokerIP2 configured on the master node for synchronization | -| brokerName | null | broker name | -| brokerClusterName | DefaultCluster | The Cluser name to which this broker belongs | -| brokerId | 0 | broker id 0 indicates master, and other positive integers indicate slave | -| storePathCommitLog | $HOME/store/commitlog/ | Path to store the commit log | -| storePathConsumerQueue | $HOME/store/consumequeue/ | A path that consumes queue is stored | -| mapedFileSizeCommitLog | 1024 \* 1024 \* 1024(1G) | commit log mapping file size | -| deleteWhen | 04 | At what time of day should I delete the commit log whose file retention time has exceeded | -| fileReservedTime | 72 | File retention time in hours | -| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | -| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH The broker in SYNC_FLUSH mode guarantees to flush messages before receiving the acknowledged producer. ASYNC_FLUSH brokers use the flush mode to flush a group of messages for better performance. | +| Parameter | Default | Description | +|------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| listenPort | 10911 | A listening port that accepts client connections | +| namesrvAddr | null | nameServer address | +| brokerIP1 | The network InetAddress | The IP address on which the broker is currently listening | +| brokerIP2 | same to brokerIP1 | When a master/slave broker exists, if the brokerIP2 property is configured on the broker master node, the broker slave node will connect to the brokerIP2 configured on the master node for synchronization | +| brokerName | null | broker name | +| brokerClusterName | DefaultCluster | The Cluster name to which this broker belongs | +| brokerId | 0 | broker id 0 indicates master, and other positive integers indicate slave | +| storePathCommitLog | $HOME/store/commitlog/ | Path to store the commit log | +| storePathConsumerQueue | $HOME/store/consumequeue/ | A path that consumes queue is stored | +| mappedFileSizeCommitLog | 1024 \* 1024 \* 1024(1G) | commit log mapping file size | +| deleteWhen | 04 | At what time of day should I delete the commit log whose file retention time has exceeded | +| fileReservedTime | 72 | File retention time in hours | +| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | +| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH The broker in SYNC_FLUSH mode guarantees to flush messages before receiving the acknowledged producer. ASYNC_FLUSH brokers use the flush mode to flush a group of messages for better performance. | diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/06FAQ.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/06FAQ.md index 8cd883f39f..ebac061bca 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/06FAQ.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/06-bestPractice/06FAQ.md @@ -164,7 +164,7 @@ The following answers are default values, which can be modified through configur - **reason** - 1)If the Consumer Group or DleayQueue encounters an error while getting subscription information. + 1)If the Consumer Group or DelayQueue encounters an error while getting subscription information. - **solution** diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/11-contributionGuide/01how-to-contribute.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/11-contributionGuide/01how-to-contribute.md index d3d4de5149..ce4fe822c5 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/11-contributionGuide/01how-to-contribute.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/11-contributionGuide/01how-to-contribute.md @@ -117,7 +117,7 @@ There are many more ways to contribute to the RocketMQ community that you can ch Committers are members of a community's project repository who can modify code, documents, and websites or accept contributions from other members. -There is no strict protocol for becoming a commiter, and candidates are usually active contributors in the community. +There is no strict protocol for becoming a committer, and candidates are usually active contributors in the community. Being an active contributor means: participating in discussions on email lists, helping others solve problems, verifying pre-release versions, honoring the good people and continuously optimizing community management, which is part of the community in Apache. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md index d12289b1a0..597c7d88ff 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/12-observability/01metrics.md @@ -26,27 +26,27 @@ The following table describes the labels of the metrics that are related to the - consumer_group: the ID of the consumer group. - invocation_status: the result of the API call for create topic or consumer group, which includes success and failure. -| Type | Name | Unit | Description | Label | -|-----------|-----------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| -| counter | rocketmq_messages_in_total | count | The number of messages that are produced. | cluster,node_type,node_id,topic,message_type | -| counter | rocketmq_messages_out_total | count | The number of messages that are consumed. | cluster,node_type,node_id,topic, consumer_group | -| counter | rocketmq_throughput_in_total | byte | The write throughput that are produced. | cluster,node_type,node_id,topic,message_type | -| counter | rocketmq_throughput_out_total | byte | The read throughput that are produced. | cluster,node_type,node_id,topic, consumer_group | +| Type | Name | Unit | Description | Label | +|-----------|-----------------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| counter | rocketmq_messages_in_total | count | The number of messages that are produced. | cluster,node_type,node_id,topic,message_type | +| counter | rocketmq_messages_out_total | count | The number of messages that are consumed. | cluster,node_type,node_id,topic, consumer_group | +| counter | rocketmq_throughput_in_total | byte | The write throughput that are produced. | cluster,node_type,node_id,topic,message_type | +| counter | rocketmq_throughput_out_total | byte | The read throughput that are produced. | cluster,node_type,node_id,topic, consumer_group | | histogram | rocketmq_message_size | byte | The distribution of message sizes. This metric is counted only when messages are sent. The following shows the distribution ranges:<br />le_1_kb: ≤ 1 KB<br /> le_4_kb: ≤ 4 KB<br />le_512_kb: ≤ 512 KB<br />le_1_mb: ≤ 1 MB<br />le_2_mb: ≤ 2 MB<br />le_4_mb: ≤ 4 MB<br />le_overflow: > 4 MB | cluster,node_type,node_id,topic,message_type | -| gauge | rocketmq_consumer_ready_messages | count | The number of ready messages. | cluster,node_type,node_id,topic, consumer_group | -| gauge | rocketmq_consumer_inflight_messages | count | The number of inflight messages. | cluster,node_type,node_id,topic, consumer_group | -| gauge | rocketmq_consumer_queueing_latency | millisecond | Ready messages queueing delay time. | cluster,node_type,node_id,topic, consumer_group | -| gauge | rocketmq_consumer_lag_latency | millisecond | The delayed time before messages are consumed. | cluster,node_type,node_id,topic, consumer_group | -| counter | rocketmq_send_to_dlq_messages_total | count | The number of messages that are sent to the dead-letter queue. | cluster,node_type,node_id,topic, consumer_group | -| histogram | rocketmq_rpc_latency | millisecond | The rpc call latency | cluster,node_typ,node_id,protocol_type,request_code,response_code | -| gauge | rocketmq_storage_message_reserve_time | millisecond | Message retention time. | cluster,node_type,node_id | -| gauge | rocketmq_storage_dispatch_behind_bytes | byte | Undispatched message size. | cluster,node_type,node_id | -| gauge | rocketmq_storage_flush_behind_bytes | byte | Unflushed messsage size. | cluster,node_type,node_id | -| gauge | rocketmq_thread_pool_wartermark | count | The number of tasks queued in the thread pool. | cluster,node_type,node_id,name | -| histogram | rocketmq_topic_create_execution_time | millisecond | The execution time for creating topic: <br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br />le_overflow | cluster,node_type,node_id,invocation_status,is_system | -| histogram | rocketmq_consumer_group_create_execution_time | millisecond | The execution time for creating consumer group: <br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br />le_overflow | cluster,node_type,node_id,invocation_status | -| gauge | rocketmq_topic_number | count | The number of topics | cluster,node_type,node_id | -| gauge | rocketmq_consumer_group_number | count | The number of consumer group | cluster,node_type,node_id | +| gauge | rocketmq_consumer_ready_messages | count | The number of ready messages. | cluster,node_type,node_id,topic, consumer_group | +| gauge | rocketmq_consumer_inflight_messages | count | The number of inflight messages. | cluster,node_type,node_id,topic, consumer_group | +| gauge | rocketmq_consumer_queueing_latency | millisecond | Ready messages queueing delay time. | cluster,node_type,node_id,topic, consumer_group | +| gauge | rocketmq_consumer_lag_latency | millisecond | The delayed time before messages are consumed. | cluster,node_type,node_id,topic, consumer_group | +| counter | rocketmq_send_to_dlq_messages_total | count | The number of messages that are sent to the dead-letter queue. | cluster,node_type,node_id,topic, consumer_group | +| histogram | rocketmq_rpc_latency | millisecond | The rpc call latency | cluster,node_typ,node_id,protocol_type,request_code,response_code | +| gauge | rocketmq_storage_message_reserve_time | millisecond | Message retention time. | cluster,node_type,node_id | +| gauge | rocketmq_storage_dispatch_behind_bytes | byte | Undispatched message size. | cluster,node_type,node_id | +| gauge | rocketmq_storage_flush_behind_bytes | byte | Unflushed message size. | cluster,node_type,node_id | +| gauge | rocketmq_thread_pool_wartermark | count | The number of tasks queued in the thread pool. | cluster,node_type,node_id,name | +| histogram | rocketmq_topic_create_execution_time | millisecond | The execution time for creating topic: <br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br />le_overflow | cluster,node_type,node_id,invocation_status,is_system | +| histogram | rocketmq_consumer_group_create_execution_time | millisecond | The execution time for creating consumer group: <br />le_10_ms<br />le_100_ms<br />le_1_s<br />le_3_s<br />le_5_s<br />le_overflow | cluster,node_type,node_id,invocation_status | +| gauge | rocketmq_topic_number | count | The number of topics | cluster,node_type,node_id | +| gauge | rocketmq_consumer_group_number | count | The number of consumer group | cluster,node_type,node_id | ### Producer metrics diff --git a/versioned_docs/version-5.0/05-deploymentOperations/02admintool.md b/versioned_docs/version-5.0/05-deploymentOperations/02admintool.md index 519f8a2401..1519c735c1 100644 --- a/versioned_docs/version-5.0/05-deploymentOperations/02admintool.md +++ b/versioned_docs/version-5.0/05-deploymentOperations/02admintool.md @@ -1316,7 +1316,7 @@ -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -2420,7 +2420,7 @@ -i </td> <td className="xl67" width={87} style={{ width: "65pt" }}> - uniqe msg id + unique msg id </td> </tr> <tr height={36} style={{ height: "27.0pt" }}> @@ -3896,7 +3896,7 @@ width: "65pt" }} > - consumerConnec tion + consumerConnection </td> <td rowSpan={3} @@ -3952,7 +3952,7 @@ width: "65pt" }} > - producerConnec tion + producerConnection </td> <td rowSpan={4} diff --git a/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md b/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md index 3822042deb..3e35c5aa88 100644 --- a/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md +++ b/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md @@ -85,20 +85,20 @@ msgId一定是全局唯一标识符,但是实际使用中,可能会存在相 SYNC_FLUSH(同步刷新)相比于ASYNC_FLUSH(异步处理)会损失很多性能,但是也更可靠,所以需要根据实际的业务场景做好权衡。 ### Broker 配置 -| 参数名 | 默认值 | 说明 | -| -------------------------------- | ----------------------------- | ------------------------------------------------------------ | -| listenPort | 10911 | 接受客户端连接的监听端口 | -| namesrvAddr | null | nameServer 地址 | -| brokerIP1 | 网卡的 InetAddress | 当前 broker 监听的 IP | -| brokerIP2 | 跟 brokerIP1 一样 | 存在主从 broker 时,如果在 broker 主节点上配置了 brokerIP2 属性,broker 从节点会连接主节点配置的 brokerIP2 进行同步 | -| brokerName | null | broker 的名称 | -| brokerClusterName | DefaultCluster | 本 broker 所属的 Cluser 名称 | -| brokerId | 0 | broker id, 0 表示 master, 其他的正整数表示 slave | -| storePathCommitLog | $HOME/store/commitlog/ | 存储 commit log 的路径 | -| storePathConsumerQueue | $HOME/store/consumequeue/ | 存储 consume queue 的路径 | -| mapedFileSizeCommitLog | 1024 \* 1024 \* 1024(1G) | commit log 的映射文件大小 | -| deleteWhen | 04 | 在每天的什么时间删除已经超过文件保留时间的 commit log | -| fileReservedTime | 72 | 以小时计算的文件保留时间 | -| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | -| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 | +| 参数名 | 默认值 | 说明 | +| -------------------------------- | ----------------------------- |-----------------------------------------------------------------------------------------------------------------| +| listenPort | 10911 | 接受客户端连接的监听端口 | +| namesrvAddr | null | nameServer 地址 | +| brokerIP1 | 网卡的 InetAddress | 当前 broker 监听的 IP | +| brokerIP2 | 跟 brokerIP1 一样 | 存在主从 broker 时,如果在 broker 主节点上配置了 brokerIP2 属性,broker 从节点会连接主节点配置的 brokerIP2 进行同步 | +| brokerName | null | broker 的名称 | +| brokerClusterName | DefaultCluster | 本 broker 所属的 Cluster 名称 | +| brokerId | 0 | broker id, 0 表示 master, 其他的正整数表示 slave | +| storePathCommitLog | $HOME/store/commitlog/ | 存储 commit log 的路径 | +| storePathConsumerQueue | $HOME/store/consumequeue/ | 存储 consume queue 的路径 | +| mappedFileSizeCommitLog | 1024 \* 1024 \* 1024(1G) | commit log 的映射文件大小 | +| deleteWhen | 04 | 在每天的什么时间删除已经超过文件保留时间的 commit log | +| fileReservedTime | 72 | 以小时计算的文件保留时间 | +| brokerRole | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE | +| flushDiskType | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 | diff --git a/versioned_docs/version-5.0/06-bestPractice/02dledger.md b/versioned_docs/version-5.0/06-bestPractice/02dledger.md index bebb1ddb72..4e66b66eb1 100644 --- a/versioned_docs/version-5.0/06-bestPractice/02dledger.md +++ b/versioned_docs/version-5.0/06-bestPractice/02dledger.md @@ -118,7 +118,7 @@ $ nohup sh bin/mqbroker -c conf/dledger/xxx-n2.conf & #### 2.2 检查旧的 Commitlog RocketMQ-on-DLedger 组中的每个节点,可以兼容旧的 Commitlog ,但其 Raft 复制过程,只能针对新增加的消息。因此,为了避免出现异常,需要保证 旧的 Commitlog 是一致的。 -如果旧的集群是采用 Master-Slave 方式部署,有可能在shutdown时,其数据并不是一致的,建议通过md5sum 的方式,检查最近的最少 2 个 Commmitlog 文件,如果发现不一致,则通过拷贝的方式进行对齐。 +如果旧的集群是采用 Master-Slave 方式部署,有可能在shutdown时,其数据并不是一致的,建议通过md5sum 的方式,检查最近的最少 2 个 Commitlog 文件,如果发现不一致,则通过拷贝的方式进行对齐。 虽然 RocketMQ-on-DLedger Group 也可以以 2 节点方式部署,但其会丧失容灾切换能力(2n + 1 原则,至少需要3个节点才能容忍其中 1 个宕机)。 所以在对齐了 Master 和 Slave 的 Commitlog 之后,还需要准备第 3 台机器,并把旧的 Commitlog 从 Master 拷贝到 第 3 台机器(记得同时拷贝一下 config 文件夹)。 diff --git a/versioned_docs/version-5.0/06-bestPractice/06FAQ.md b/versioned_docs/version-5.0/06-bestPractice/06FAQ.md index 367f48e57b..a1fff00116 100644 --- a/versioned_docs/version-5.0/06-bestPractice/06FAQ.md +++ b/versioned_docs/version-5.0/06-bestPractice/06FAQ.md @@ -164,7 +164,7 @@ - **原因** - 1)Consumer Group 或 DleayQueue 获取订阅信息异常。 + 1)Consumer Group 或 DelayQueue 获取订阅信息异常。 - **解决方案** diff --git a/versioned_docs/version-5.0/10-connect/01RocketMQ Connect Overview.md b/versioned_docs/version-5.0/10-connect/01RocketMQ Connect Overview.md index 68373e7293..f3ba4e4415 100644 --- a/versioned_docs/version-5.0/10-connect/01RocketMQ Connect Overview.md +++ b/versioned_docs/version-5.0/10-connect/01RocketMQ Connect Overview.md @@ -33,7 +33,7 @@ CDC作为ETL模式之一,可以近乎实时的捕获增量数据库INSERT、UP ![RocketMQ Connect任务模型2](../picture/32rocketmq-connect/deploy2.png) RocketMQ Connect Worker支持两种运行模式,集群和单机 -集群模式,顾名思义,由多个Worker节点组成,推荐最少有2个Worker节点,组成高可用集群。集群间的配置信息,offset信息,status信息则通过指定的RocketMQ Topic进行存储,新增Worker节点也会获取到集群中的这些配置,offset,status信息,并且触发负载均衡,重新分配集群中的任务,使集群达到均衡的状态,减少Woker节点或者Worker宕机也会触发负载均衡,从而保障集群中所有的任务都可以均衡的在集群中存活的节点中正常运行。 +集群模式,顾名思义,由多个Worker节点组成,推荐最少有2个Worker节点,组成高可用集群。集群间的配置信息,offset信息,status信息则通过指定的RocketMQ Topic进行存储,新增Worker节点也会获取到集群中的这些配置,offset,status信息,并且触发负载均衡,重新分配集群中的任务,使集群达到均衡的状态,减少Worker节点或者Worker宕机也会触发负载均衡,从而保障集群中所有的任务都可以均衡的在集群中存活的节点中正常运行。 ![RocketMQ Connect部署模型集群](../picture/32rocketmq-connect/deploy3.png) diff --git a/versioned_docs/version-5.0/11-contributionGuide/01how-to-contribute.md b/versioned_docs/version-5.0/11-contributionGuide/01how-to-contribute.md index 2f720256e1..3b7a6d9f88 100644 --- a/versioned_docs/version-5.0/11-contributionGuide/01how-to-contribute.md +++ b/versioned_docs/version-5.0/11-contributionGuide/01how-to-contribute.md @@ -129,7 +129,7 @@ Apache RocketMQ 官网代表着 Apache RocketMQ 和 Apache RocketMQ 社区。其 Committers 是社区中修改项目仓库的成员,可修改代码,文档和网站或接纳其他成员的贡献。 -成为 commiter 并没有严格的协议,候选人通常是社区中活跃的贡献者。 +成为 committer 并没有严格的协议,候选人通常是社区中活跃的贡献者。 活跃的贡献者意味着:参加邮箱列表中的讨论,帮助他人解决问题,验证预发布版本,礼贤下士并持续优化社区管理,这部分关乎社区在 Apache 中的发展。