This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 0b838a65b60 [opt](arths) opt arths (#2693)
0b838a65b60 is described below
commit 0b838a65b60edf01f90b2ae9d7b6e1f3a49baea2
Author: Mingyu Chen (Rayner) <[email protected]>
AuthorDate: Fri Aug 1 22:24:37 2025 -0700
[opt](arths) opt arths (#2693)
## Versions
- [x] dev
- [ ] 3.0
- [ ] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
community/developer-guide/arthas.md | 40 +++++++++++++---------
.../current/developer-guide/arthas.md | 33 ++++++++++--------
2 files changed, 42 insertions(+), 31 deletions(-)
diff --git a/community/developer-guide/arthas.md
b/community/developer-guide/arthas.md
index 1e6b4fc3559..085404fd33e 100644
--- a/community/developer-guide/arthas.md
+++ b/community/developer-guide/arthas.md
@@ -1,6 +1,6 @@
---
{
- "title": "Use arthas to profile fe",
+ "title": "Using Arthas to Profile FE",
"language": "en"
}
---
@@ -24,16 +24,27 @@ specific language governing permissions and limitations
under the License.
-->
-## Introduce
-Starting from Doris version 3.1.0, the Arthas tool (version 4.0.5) is included
in the FE deployment directory `${DORIS_FE_HOME}/arthas`. Arthas can be used to
generate flame graphs, trace method call paths, output method execution times,
observe method parameters and return values, and more. This makes it easier to
diagnose various runtime issues in the FE process.
-For detailed usage instructions, please refer to the [official Arthas
documentation](https://arthas.aliyun.com/en/doc/)
+## Introduction
+
+In Doris 3.1.0 and later versions, the Arthas tool (version 4.0.5) is included
in the FE deployment directory `${DORIS_FE_HOME}/arthas`. You can use Arthas to
print flame graphs, trace function call paths, output function execution times,
observe function parameters and return values, and more, making it convenient
to locate various runtime issues in FE.
+
+For specific Arthas usage methods, please refer to: [Arthas Official
Documentation](https://arthas.aliyun.com/en/doc/).
+
+For versions prior to 3.1, you need to manually download Arthas:
+
+```shell
+wget
https://github.com/alibaba/arthas/releases/download/arthas-all-4.0.5/arthas-bin.zip
+unzip arthas-bin.zip -o ${DORIS_FE_HOME}/arthas
+```
:::note
-Note: Currently, only Linux and macOS are supported. Windows is not supported
yet.
+Note: Currently only Linux and MacOS systems are supported, Windows system is
not yet supported
:::
-Example: Generating a Flame Graph
-1. Run the `${DORIS_FE_HOME}/arthas/as.sh` script and select the DorisFE
process:
+## Generating FlameGraph
+
+1. Run the `${DORIS_FE_HOME}/arthas/as.sh` script and select the `DorisFE`
process
+
```shell
bash ./as.sh
Arthas script version: 4.0.5
@@ -47,22 +58,17 @@ Example: Generating a Flame Graph
2
```
-2. Start profiling:
+2. Start Profiling
+
```shell
[arthas@77285]$ profiler start
Profiling started
```
-3. Stop profiling and generate a flame graph file named 20250627-115104.html:
+3. Stop Profiling and generate flame graph file as `20250627-115104.html`
+
```shell
[arthas@77285]$ profiler stop --format html
OK
profiler output file: <DORIS_FE_HOME>/arthas-output/20250627-115104.html
- ```
-
-## Using Arthas in Older FE Versions
-For versions prior to 3.1, you need to manually download Arthas:
-```shell
-wget
https://github.com/alibaba/arthas/releases/download/arthas-all-4.0.5/arthas-bin.zip
-unzip arthas-bin.zip -o ${DORIS_FE_HOME}/arthas
-```
\ No newline at end of file
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/arthas.md
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/arthas.md
index cc7454b3738..0bb5f7805fc 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/arthas.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/arthas.md
@@ -1,6 +1,6 @@
---
{
- "title": "使用 arthas 对 fe 进行 profile",
+ "title": "使用 Arthas 分析 FE 性能",
"language": "zh-CN"
}
---
@@ -25,16 +25,26 @@ under the License.
-->
## 介绍
-在 doris 3.1.0及以上版本中,在fe部署目录`${DORIS_FE_HOME}/arthas`中存放了 Arthas
工具(4.0.5版本),可以使用 Arthas 来打印火焰图、跟踪函数调用路径、输出函数调用时间、观察函数的入参和返回值等等,方便我们定位 fe
的各种运行时问题。
-具体 Arthas 的使用方法可以参考:[Arthas官方文档](https://arthas.aliyun.com/en/doc/)
+在 Doris 3.1.0 及以上版本中,在 FE 部署目录 `${DORIS_FE_HOME}/arthas` 中存放了 Arthas 工具(4.0.5
版本),可以使用 Arthas 来打印火焰图、跟踪函数调用路径、输出函数调用时间、观察函数的入参和返回值等等,方便我们定位 fe 的各种运行时问题。
+
+具体 Arthas 的使用方法可以参考:[Arthas 官方文档](https://arthas.aliyun.com/en/doc/)。
+
+对于 3.1 之前的版本,需要手动下载 Arthas:
+
+```shell
+wget
https://github.com/alibaba/arthas/releases/download/arthas-all-4.0.5/arthas-bin.zip
+unzip arthas-bin.zip -o ${DORIS_FE_HOME}/arthas
+```
:::note
注:目前仅支持 Linux 和 MacOS 系统,暂未支持 Windows 系统
:::
-打印火焰图的案例如下:
-1. 运行`${DORIS_FE_HOME}/arthas/as.sh`脚本,选择`DorisFE`进程
+## 生成火焰图
+
+1. 运行 `${DORIS_FE_HOME}/arthas/as.sh` 脚本,选择 `DorisFE` 进程
+
```shell
bash ./as.sh
Arthas script version: 4.0.5
@@ -48,22 +58,17 @@ under the License.
2
```
-2. 开始 profile
+2. 开始 Profiling
+
```shell
[arthas@77285]$ profiler start
Profiling started
```
-3. 结束 profile,生成火焰图文件为 20250627-115104.html
+3. 结束 Profiling,生成火焰图文件为 `20250627-115104.html`
+
```shell
[arthas@77285]$ profiler stop --format html
OK
profiler output file: <DORIS_FE_HOME>/arthas-output/20250627-115104.html
```
-
-## 在低版本 fe 中使用Arthas
-对于3.1之前的版本,需要手动下载 Arthas:
-```shell
-wget
https://github.com/alibaba/arthas/releases/download/arthas-all-4.0.5/arthas-bin.zip
-unzip arthas-bin.zip -o ${DORIS_FE_HOME}/arthas
-```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]