You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by GitBox <gi...@apache.org> on 2022/12/22 06:43:43 UTC
[GitHub] [rocketmq-site] tsunghanjacktsai commented on a diff in pull request #402: [ISSUE #371]Translation for "Best Practice-消息轨迹" Section in the v4.x Document (CN -> EN)
tsunghanjacktsai commented on code in PR #402:
URL: https://github.com/apache/rocketmq-site/pull/402#discussion_r1055136157
##########
i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/17messagetra.md:
##########
@@ -1,17 +1,17 @@
-# 消息轨迹
+# Message trace
-## 1. 消息轨迹数据关键属性
-| Producer端| Consumer端 | Broker端 |
+## 1. Key attributes of message trace data
+| Producer | Consumer | Broker |
| --- | --- | --- |
-| 生产实例信息 | 消费实例信息 | 消息的Topic |
-| 发送消息时间 | 投递时间,投递轮次 | 消息存储位置 |
-| 消息是否发送成功 | 消息是否消费成功 | 消息的Key值 |
-| 发送耗时 | 消费耗时 | 消息的Tag值 |
+| Production instance information | Consumer instance information | Message Topic |
+| Time of message sending | Delivery time and delivery round | Message store location |
+| Success of message sending | Success of message consumption | Message key value |
+| Time taken to send | Time taken to consume | Message tag value |
-## 2. 支持消息轨迹集群部署
+## 2. Support for message trace cluster deployment
Review Comment:
How about "Cluster Deployment for Supporting Message Trace"?
##########
i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/17messagetra.md:
##########
@@ -88,30 +88,36 @@ RocketMQ的消息轨迹特性支持两种存储轨迹数据的方式：
System.out.printf("Consumer Started.%n");
```
-### 4.3 支持自定义存储消息轨迹Topic
-在上面的发送和订阅消息时候分别将DefaultMQProducer和DefaultMQPushConsumer实例的初始化修改为如下即可支持自定义存储消息轨迹Topic。
-```
- ##其中Topic_test11111需要用户自己预先创建，来保存消息轨迹；
+### 4.3 Support custom storage message trace Topic
+To support custom storage message trace Topic, modify the initialization of the DefaultMQProducer and DefaultMQPushConsumer instances as follows when sending and subscribing to messages.
+
+```java
+ ##Topic_test11111 needs to be created by the user in advance to store message traces:
DefaultMQProducer producer = new DefaultMQProducer("ProducerGroupName",true,"Topic_test11111");
......
DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("CID_JODIE_1",true,"Topic_test11111");
......
```
-### 4.4 使用mqadmin命令发送和查看轨迹
-- 发送消息
-```shell
-./mqadmin sendMessage -m true --topic some-topic-name -n 127.0.0.1:9876 -p "your meesgae content"
-```
-- 查询轨迹
-```shell
-./mqadmin QueryMsgTraceById -n 127.0.0.1:9876 -i "some-message-id"
-```
-- 查询轨迹结果
-```
-RocketMQLog:WARN No appenders could be found for logger (io.netty.util.internal.PlatformDependent0).
-RocketMQLog:WARN Please initialize the logger system properly.
-#Type #ProducerGroup #ClientHost #SendTime #CostTimes #Status
-Pub 1623305799667 xxx.xxx.xxx.xxx 2021-06-10 14:16:40 131ms success
-```
+### 4.4 Use the mqadmin command to send and view traces
+- Send message
+
+ ```shell
+ ./mqadmin sendMessage -m true --topic some-topic-name -n 127.0.0.1:9876 -p "your meesgae content"
+ ```
+- Search trace
Review Comment:
Better change "Search" to "Query" here.
##########
i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/17messagetra.md:
##########
@@ -88,30 +88,36 @@ RocketMQ的消息轨迹特性支持两种存储轨迹数据的方式：
System.out.printf("Consumer Started.%n");
```
-### 4.3 支持自定义存储消息轨迹Topic
-在上面的发送和订阅消息时候分别将DefaultMQProducer和DefaultMQPushConsumer实例的初始化修改为如下即可支持自定义存储消息轨迹Topic。
-```
- ##其中Topic_test11111需要用户自己预先创建，来保存消息轨迹；
+### 4.3 Support custom storage message trace Topic
+To support custom storage message trace Topic, modify the initialization of the DefaultMQProducer and DefaultMQPushConsumer instances as follows when sending and subscribing to messages.
+
+```java
+ ##Topic_test11111 needs to be created by the user in advance to store message traces:
DefaultMQProducer producer = new DefaultMQProducer("ProducerGroupName",true,"Topic_test11111");
......
DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("CID_JODIE_1",true,"Topic_test11111");
......
```
-### 4.4 使用mqadmin命令发送和查看轨迹
-- 发送消息
-```shell
-./mqadmin sendMessage -m true --topic some-topic-name -n 127.0.0.1:9876 -p "your meesgae content"
-```
-- 查询轨迹
-```shell
-./mqadmin QueryMsgTraceById -n 127.0.0.1:9876 -i "some-message-id"
-```
-- 查询轨迹结果
-```
-RocketMQLog:WARN No appenders could be found for logger (io.netty.util.internal.PlatformDependent0).
-RocketMQLog:WARN Please initialize the logger system properly.
-#Type #ProducerGroup #ClientHost #SendTime #CostTimes #Status
-Pub 1623305799667 xxx.xxx.xxx.xxx 2021-06-10 14:16:40 131ms success
-```
+### 4.4 Use the mqadmin command to send and view traces
+- Send message
+
+ ```shell
+ ./mqadmin sendMessage -m true --topic some-topic-name -n 127.0.0.1:9876 -p "your meesgae content"
+ ```
+- Search trace
+
+ ```shell
+ ./mqadmin QueryMsgTraceById -n 127.0.0.1:9876 -i "some-message-id"
+ ```
+- Search trace result
Review Comment:
Change "Search" to "Query" as well.
##########
i18n/en/docusaurus-plugin-content-docs/current/05-bestPractice/17messagetra.md:
##########
@@ -30,29 +30,29 @@ brokerIP1=XX.XX.XX.XX1
namesrvAddr=XX.XX.XX.XX:9876
```
-### 2.2 普通模式
-RocketMQ集群中每一个Broker节点均用于存储Client端收集并发送过来的消息轨迹数据。因此，对于RocketMQ集群中的Broker节点数量并无要求和限制。
+### 2.2 Normal mode
+In RocketMQ cluster, each Broker node is used to store message trace data collected and sent by the Client. Therefore, there is no requirement or limit on the number of Broker nodes in the RocketMQ cluster.
-### 2.3 物理IO隔离模式
-对于消息轨迹数据量较大的场景，可以在RocketMQ集群中选择其中一个Broker节点专用于存储消息轨迹，使得用户普通的消息数据与消息轨迹数据的物理IO完全隔离，互不影响。在该模式下，RockeMQ集群中至少有两个Broker节点，其中一个Broker节点定义为存储消息轨迹数据的服务端。
+### 2.3 Physical IO isolation mode
+For scenarios with a large amount of message trace data, you can choose one of the Broker nodes in the RocketMQ cluster to be dedicated to storing message traces, so that the physical IO of the user's ordinary message data is completely isolated from the message trace data and does not affect each other. In this mode, there are at least two Broker nodes in the RocketMQ cluster, and one of them is defined as the server that stores the message trace data.
-### 2.4 启动开启消息轨迹的Broker
+### 2.4 Start the Broker with message trace enabled
`nohup sh mqbroker -c ../conf/2m-noslave/broker-a.properties &`
-## 3. 保存消息轨迹的Topic定义
-RocketMQ的消息轨迹特性支持两种存储轨迹数据的方式：
+## 3. Save the topic definition for message trace
+RocketMQ's message trace feature supports two ways of storing trace data：
-### 3.1 系统级的TraceTopic
-在默认情况下，消息轨迹数据是存储于系统级的TraceTopic中(其名称为：**RMQ_SYS_TRACE_TOPIC**)。该Topic在Broker节点启动时，会自动创建出来（如上所叙，需要在Broker端的配置文件中将**traceTopicEnable**的开关变量设置为**true**）。
+### 3.1 System-level TraceTopic
+By default, the message trace data is stored in the system-level TraceTopic (whose name is: **RMQ_SYS_TRACE_TOPIC**). This Topic is automatically created when the Broker node is started (as mentioned above, the **traceTopicEnable** switch variable must be set to **true** in the Broker side configuration file).
-### 3.2 用户自定义的TraceTopic
-如果用户不准备将消息轨迹的数据存储于系统级的默认TraceTopic，也可以自己定义并创建用户级的Topic来保存轨迹（即为创建普通的Topic用于保存消息轨迹数据）。下面一节会介绍Client客户端的接口如何支持用户自定义的TraceTopic。
+### 3.2 User-defined TraceTopic
+If the user does not want to store the message trace data in the default system-level TraceTopic, they can also define and create a user-level Topic to save the trace (that is, create a regular Topic to store the message trace data). The next section will introduce how the Client interface supports user-defined TraceTopic.
-## 4. 支持消息轨迹的Client客户端实践
-为了尽可能地减少用户业务系统使用RocketMQ消息轨迹特性的改造工作量，作者在设计时候采用对原来接口增加一个开关参数(**enableMsgTrace**)来实现消息轨迹是否开启；并新增一个自定义参数(**customizedTraceTopic**)来实现用户存储消息轨迹数据至自己创建的用户级Topic。
+## 4. Supporting message trace Client practice
Review Comment:
Better change it to: The Client with Message Trace Practice
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org