You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by lt...@apache.org on 2025/05/09 09:22:48 UTC

(rocketmq-site) branch new-official-website updated: Add a section on Broker log management in the Best Practices chapter (#726)

This is an automated email from the ASF dual-hosted git repository.

ltamber 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 a67acc3bdb Add a section on Broker log management in the Best Practices chapter (#726)
a67acc3bdb is described below

commit a67acc3bdb745ffdbe9eb5551bcb0497a39d98ca
Author: rongtong <ji...@163.com>
AuthorDate: Fri May 9 17:22:43 2025 +0800

    Add a section on Broker log management in the Best Practices chapter (#726)
---
 docs/05-bestPractice/01bestpractice.md                             | 5 +++++
 .../current/05-bestPractice/01bestpractice.md                      | 7 ++++++-
 .../version-5.0/06-bestPractice/01bestpractice.md                  | 6 ++++++
 versioned_docs/version-5.0/06-bestPractice/01bestpractice.md       | 5 +++++
 4 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/docs/05-bestPractice/01bestpractice.md b/docs/05-bestPractice/01bestpractice.md
index 0b3f119600..97141eb15b 100644
--- a/docs/05-bestPractice/01bestpractice.md
+++ b/docs/05-bestPractice/01bestpractice.md
@@ -230,3 +230,8 @@ msgId一定是全局唯一标识符,但是实际使用中,可能会存在相
 | brokerRole     | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE                                                                                  |​ 
 | flushDiskType     | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 |​
 
+### Broker 日志管理
+
+Broker 的默认日志路径在 ${user.home}/logs/rocketmqlogs/ 下,可以通过修改二进制包中 conf 文件夹下的 xx.logback.xml 文件来进行日志级别和路径的修改
+
+> 注意请保管好您的日志,以免敏感信息发生泄漏。
\ No newline at end of file
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 7b1ddf33fe..a086cb7c48 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
@@ -245,4 +245,9 @@ CONSUME_FROM_FIRST_OFFSET will consume every information that exists in the Brok
 | 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
+| 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. |​
+
+### Broker Log Management
+The default log path for the Broker is located at ${user.home}/logs/rocketmqlogs/. You can change the log level and path by editing the xx.logback.xml file in the conf directory of the binary package.
+
+> Note: Please ensure your logs are properly secured to prevent sensitive information leaks.
\ No newline at end of file
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 ff1373380d..5a2eb34752 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
@@ -116,3 +116,9 @@ Compared with ASYNC_FLUSH, SYNC_FLUSH suffers from performance loss but is more
 | 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. |​
+
+### Broker Log Management
+
+The default log path for the Broker is located at ${user.home}/logs/rocketmqlogs/. You can change the log level and path by editing the xx.logback.xml file in the conf directory of the binary package.
+
+> Note: Please ensure your logs are properly secured to prevent sensitive information leaks.
\ No newline at end of file
diff --git a/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md b/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md
index 3e35c5aa88..30c7bacf93 100644
--- a/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md
+++ b/versioned_docs/version-5.0/06-bestPractice/01bestpractice.md
@@ -102,3 +102,8 @@ msgId一定是全局唯一标识符,但是实际使用中,可能会存在相
 | brokerRole     | ASYNC_MASTER | SYNC_MASTER/ASYNC_MASTER/SLAVE                                                                                  |​ 
 | flushDiskType     | ASYNC_FLUSH | SYNC_FLUSH/ASYNC_FLUSH SYNC_FLUSH 模式下的 broker 保证在收到确认生产者之前将消息刷盘。ASYNC_FLUSH 模式下的 broker 则利用刷盘一组消息的模式,可以取得更好的性能。 |​
 
+### Broker 日志管理
+
+Broker 的默认日志路径在 ${user.home}/logs/rocketmqlogs/ 下,可以通过修改二进制包中 conf 文件夹下的 xx.logback.xml 文件来进行日志级别和路径的修改
+
+> 注意请保管好您的日志,以免敏感信息发生泄漏。
\ No newline at end of file