You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2023/06/12 05:24:32 UTC
[linkis-website] branch dev updated: fix: update steps to start remote debugging (#715)
This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 422a3f2053 fix: update steps to start remote debugging (#715)
422a3f2053 is described below
commit 422a3f2053f63c2518a2a5fdb6688e42d05b16c1
Author: tangliu <ta...@mail2.sysu.edu.cn>
AuthorDate: Mon Jun 12 13:24:25 2023 +0800
fix: update steps to start remote debugging (#715)
* fix: update steps to start remote debugging
* fix: update steps to start remote debugging for current version
---------
Co-authored-by: tangliu <ta...@26dudt.com>
---
docs/development/debug.md | 20 +++++++++-----------
.../current/development/debug.md | 21 +++++++++++----------
.../version-1.3.2/development/debug.md | 20 ++++++++++----------
versioned_docs/version-1.3.2/development/debug.md | 20 +++++++++-----------
4 files changed, 39 insertions(+), 42 deletions(-)
diff --git a/docs/development/debug.md b/docs/development/debug.md
index e27dc16a0a..bc28d39488 100755
--- a/docs/development/debug.md
+++ b/docs/development/debug.md
@@ -450,27 +450,25 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
## 4. Remote debugging service guide
-### 4.1 Open the remote debugging port
+Based on the code location that needs debugging, determine the corresponding service it belongs to. Use the startup script linkis-daemon.sh and configure the remote debugging port specifically for that service during startup.
-Identify the service where the package that needs to be debugged is located, and determine the service to which it belongs according to the location of the code to be debugged
+### 4.1 Identify the service where the package that needs to be debugged is located
-### 4.2 Enter ${LINKIS_HOME}/sbin/ext, modify the module configuration file to open the remote call port
-
+Identify the service where the package that needs to be debugged is located (If you are not sure about the service name, check in ${LINKIS_HOME}/sbin/linkis-start-all.sh)
-### 4.3 Restart the service that needs to be debugged
+### 4.2 Restart the service needs to be debugged
```shell
-sh linkis-daemon.sh restart ps-publicservice
-````
-
-(If you are not sure about the service name, check in ${LINKIS_HOME}/sbin/linkis-start-all.sh )
+sh linkis-daemon.sh restart ps-publicservice debug-5005
+```
+observe the outputting starting shell command，check if it contains `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005`, which means it starts remote debug port successfully.
-### 4.4 Compiler configuration remote debugging
+### 4.3 Compiler configuration remote debugging
Open the window as shown below and configure the remote debugging port, service, and module
-### 4.5 Start debugging
+### 4.4 Start debugging
Click the debug button, and the following information appears, indicating that you can start debugging
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/debug.md
index d96fc725b3..924b73a4b2 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/debug.md
@@ -454,27 +454,28 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
## 4. 远程调试服务指引
-### 4.1 打开远程调试端口
+根据需要调试的代码位置,确定其所属的服务，使用启动脚本`linkis-daemon.sh`，启动时针对该服务设置远程调试端口。
-明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
+### 4.1 确认要调试的包所在的服务
-### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+根据需要调试的代码位置,确定其所属的服务(如果不确定服务名称,在 ${LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
-### 4.3 重启需要调试的服务
+### 4.2 重启需要调试的服务
+
+进入{LINKIS_HOME}/sbin目录，在启动命令中添加debug参数，指定远程调试端口。
```shell
-sh linkis-daemon.sh restart ps-publicservice
+sh linkis-daemon.sh restart ps-publicservice debug-5005
```
+观察输出的启动命令，是否包含`-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005`,包含则说明添加远程调试端口成功。
-(如果不确定服务名称,在 ${LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
-
-### 4.4 编译器配置远程调试
+### 4.3 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-### 4.5 开始调试
+### 4.4 开始调试
点击调试按钮,出现如下信息代表可以开始调试
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/development/debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/development/debug.md
index d96fc725b3..258253a0ae 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/development/debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/development/debug.md
@@ -454,27 +454,27 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
## 4. 远程调试服务指引
-### 4.1 打开远程调试端口
+根据需要调试的代码位置,确定其所属的服务，使用启动脚本`linkis-daemon.sh`，启动时针对该服务设置远程调试端口。
-明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
+### 4.1 确认要调试的包所在的服务
-### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+根据需要调试的代码位置,确定其所属的服务(如果不确定服务名称,在 ${LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
-### 4.3 重启需要调试的服务
+### 4.2 重启需要调试的服务
+
+进入{LINKIS_HOME}/sbin目录，在启动命令中添加debug参数，指定远程调试端口。
```shell
-sh linkis-daemon.sh restart ps-publicservice
+sh linkis-daemon.sh restart ps-publicservice debug-5005
```
+观察输出的启动命令，是否包含`-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005`,包含则说明添加远程调试端口成功。
-(如果不确定服务名称,在 ${LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
-
-### 4.4 编译器配置远程调试
+### 4.3 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-### 4.5 开始调试
+### 4.4 开始调试
点击调试按钮,出现如下信息代表可以开始调试
diff --git a/versioned_docs/version-1.3.2/development/debug.md b/versioned_docs/version-1.3.2/development/debug.md
index e27dc16a0a..bc28d39488 100755
--- a/versioned_docs/version-1.3.2/development/debug.md
+++ b/versioned_docs/version-1.3.2/development/debug.md
@@ -450,27 +450,25 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
## 4. Remote debugging service guide
-### 4.1 Open the remote debugging port
+Based on the code location that needs debugging, determine the corresponding service it belongs to. Use the startup script linkis-daemon.sh and configure the remote debugging port specifically for that service during startup.
-Identify the service where the package that needs to be debugged is located, and determine the service to which it belongs according to the location of the code to be debugged
+### 4.1 Identify the service where the package that needs to be debugged is located
-### 4.2 Enter ${LINKIS_HOME}/sbin/ext, modify the module configuration file to open the remote call port
-
+Identify the service where the package that needs to be debugged is located (If you are not sure about the service name, check in ${LINKIS_HOME}/sbin/linkis-start-all.sh)
-### 4.3 Restart the service that needs to be debugged
+### 4.2 Restart the service needs to be debugged
```shell
-sh linkis-daemon.sh restart ps-publicservice
-````
-
-(If you are not sure about the service name, check in ${LINKIS_HOME}/sbin/linkis-start-all.sh )
+sh linkis-daemon.sh restart ps-publicservice debug-5005
+```
+observe the outputting starting shell command，check if it contains `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005`, which means it starts remote debug port successfully.
-### 4.4 Compiler configuration remote debugging
+### 4.3 Compiler configuration remote debugging
Open the window as shown below and configure the remote debugging port, service, and module
-### 4.5 Start debugging
+### 4.4 Start debugging
Click the debug button, and the following information appears, indicating that you can start debugging
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org