This is an automated email from the ASF dual-hosted git repository.
huajianlan 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 ac4a808c3b9 [doc](tool) add arthas document (#2567)
ac4a808c3b9 is described below
commit ac4a808c3b99e341f4be268cf0896d76d1a14ce9
Author: 924060929 <[email protected]>
AuthorDate: Tue Jul 8 15:14:57 2025 +0800
[doc](tool) add arthas document (#2567)
add arthas document
pr: https://github.com/apache/doris/pull/52359
---
community/developer-guide/arthas.md | 68 +++++++++++++++++++++
.../current/developer-guide/arthas.md | 69 ++++++++++++++++++++++
sidebarsCommunity.json | 1 +
3 files changed, 138 insertions(+)
diff --git a/community/developer-guide/arthas.md
b/community/developer-guide/arthas.md
new file mode 100644
index 00000000000..1e6b4fc3559
--- /dev/null
+++ b/community/developer-guide/arthas.md
@@ -0,0 +1,68 @@
+---
+{
+ "title": "Use arthas to profile fe",
+ "language": "en"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+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/)
+
+:::note
+Note: Currently, only Linux and macOS are supported. Windows is not supported
yet.
+:::
+
+Example: Generating a Flame Graph
+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
+ Found existing java process, please choose one and input the serial number
of the process, eg : 1. Then hit ENTER.
+ * [1]: 75123 com.intellij.idea.Main
+ [2]: 77285 org.apache.doris.DorisFE
+ [3]: 76901 DorisBE
+ [4]: 6776 org.jetbrains.jps.cmdline.Launcher
+ [5]: 76265 DorisBE
+ [6]: 80527 org.jetbrains.jps.cmdline.Launcher
+ 2
+ ```
+
+2. Start profiling:
+ ```shell
+ [arthas@77285]$ profiler start
+ Profiling started
+ ```
+
+3. Stop profiling and generate a flame graph file named 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
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
new file mode 100644
index 00000000000..cc7454b3738
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/developer-guide/arthas.md
@@ -0,0 +1,69 @@
+---
+{
+ "title": "使用 arthas 对 fe 进行 profile",
+ "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+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/)
+
+
+:::note
+注：目前仅支持 Linux 和 MacOS 系统，暂未支持 Windows 系统
+:::
+
+打印火焰图的案例如下：
+1. 运行`${DORIS_FE_HOME}/arthas/as.sh`脚本，选择`DorisFE`进程
+ ```shell
+ bash ./as.sh
+ Arthas script version: 4.0.5
+ Found existing java process, please choose one and input the serial number
of the process, eg : 1. Then hit ENTER.
+ * [1]: 75123 com.intellij.idea.Main
+ [2]: 77285 org.apache.doris.DorisFE
+ [3]: 76901 DorisBE
+ [4]: 6776 org.jetbrains.jps.cmdline.Launcher
+ [5]: 76265 DorisBE
+ [6]: 80527 org.jetbrains.jps.cmdline.Launcher
+ 2
+ ```
+
+2. 开始 profile
+ ```shell
+ [arthas@77285]$ profiler start
+ Profiling started
+ ```
+
+3. 结束 profile，生成火焰图文件为 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
+```
diff --git a/sidebarsCommunity.json b/sidebarsCommunity.json
index 6e1ed521454..10e6e75f8eb 100644
--- a/sidebarsCommunity.json
+++ b/sidebarsCommunity.json
@@ -66,6 +66,7 @@
"developer-guide/pipeline-tracing",
"developer-guide/fe-eclipse-dev",
"developer-guide/fe-profiler",
+ "developer-guide/arthas",
"developer-guide/fe-idea-dev",
"developer-guide/fe-vscode-dev",
"developer-guide/be-vscode-dev",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
