Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE #700] Fix typo. #701

Merged
merged 1 commit into from
Dec 27, 2024
Merged

[ISSUE #700] Fix typo. #701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/03-consumer/02push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Tag在生产者章节已经介绍过，用于对某个Topic下的消息进行分

![Tag过滤](../picture/Tag过滤.png)

对于物流系统和支付系统来说，它们都只订阅单个Tag，此时只需要在调用subcribe接口时明确标明Tag即可。
对于物流系统和支付系统来说，它们都只订阅单个Tag，此时只需要在调用subscribe接口时明确标明Tag即可。

```java
consumer.subscribe("TagFilterTest", "TagA");
Expand Down
8 changes: 4 additions & 4 deletions docs/04-deployment/02admintool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" }}>
Expand Down Expand Up @@ -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" }}>
Expand Down Expand Up @@ -3896,7 +3896,7 @@
width: "65pt"
}}
>
consumerConnec tion
consumerConnection
</td>
<td
rowSpan={3}
Expand Down Expand Up @@ -3952,7 +3952,7 @@
width: "65pt"
}}
>
producerConnec tion
producerConnection
</td>
<td
rowSpan={4}
Expand Down
32 changes: 16 additions & 16 deletions docs/05-bestPractice/01bestpractice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 则利用刷盘一组消息的模式，可以取得更好的性能。 |​

2 changes: 1 addition & 1 deletion docs/05-bestPractice/02dledger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 文件夹）。
Expand Down
14 changes: 7 additions & 7 deletions docs/05-bestPractice/06log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

## 默认配置

Expand Down
2 changes: 1 addition & 1 deletion docs/11-contributionGuide/01how-to-contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Apache RocketMQ 官网代表着 Apache RocketMQ 和 Apache RocketMQ 社区。其

Committers 是社区中修改项目仓库的成员，可修改代码，文档和网站或接纳其他成员的贡献。

成为 commiter 并没有严格的协议，候选人通常是社区中活跃的贡献者。
成为 committer 并没有严格的协议，候选人通常是社区中活跃的贡献者。

活跃的贡献者意味着：参加邮箱列表中的讨论，帮助他人解决问题，验证预发布版本，礼贤下士并持续优化社区管理，这部分关乎社区在 Apache 中的发展。

Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-plugin-content-docs/current/03-consumer/02push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
10 changes: 5 additions & 5 deletions i18n/en/docusaurus-plugin-content-docs/current/04-deployment/02admintool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" }}>
Expand Down Expand Up @@ -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" }}>
Expand Down Expand Up @@ -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" }}>
Expand Down Expand Up @@ -3894,7 +3894,7 @@ Consumer group consumption status, including specific client IP's message accumu
width: "65pt"
}}
>
consumerConnec tion
consumerConnection
</td>
<td
rowSpan={3}
Expand Down Expand Up @@ -3950,7 +3950,7 @@ Consumer group consumption status, including specific client IP's message accumu
width: "65pt"
}}
>
producerConnec tion
producerConnection
</td>
<td
rowSpan={4}
Expand Down
Loading