This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new d58ddb9 Add debug doc for agent module (#459)
d58ddb9 is described below
commit d58ddb9674926194a84ce98ae249fc73d11f62e9
Author: Kunshuai Zhu <[email protected]>
AuthorDate: Thu Feb 24 18:49:39 2022 +0800
Add debug doc for agent module (#459)
---
docs/developer/debug-agent.md | 29 ++++++++++++++++++++++
docs/user-guide/observability/observability.md | 2 +-
.../current/developer/debug-agent.md | 28 +++++++++++++++++++++
.../user-guide/observability/observability.md | 2 +-
.../version-2.4.2/developer/debug-agent.md | 28 +++++++++++++++++++++
.../user-guide/observability/observability.md | 2 +-
.../version-2.4.2/developer/debug-agent.md | 29 ++++++++++++++++++++++
.../user-guide/observability/observability.md | 2 +-
8 files changed, 118 insertions(+), 4 deletions(-)
diff --git a/docs/developer/debug-agent.md b/docs/developer/debug-agent.md
new file mode 100644
index 0000000..81eb92d
--- /dev/null
+++ b/docs/developer/debug-agent.md
@@ -0,0 +1,29 @@
+---
+title: Debug and run agent module locally
+keywords: ["Agent"]
+description: Debug and run the agent module locally
+---
+
+## Description
+
+* This article will introduce how to debug and run the `shenyu-agent` module
locally
+
+## Prepare
+
+1. Pull the Apache ShenYu code
+2. Install IDEA
+3. Refer to [local deployment](../deployment/deployment-local.md) to download
and compile the code
+
+## Set JVM startup parameters
+
+In IDEA, set VM options in the startup parameters of
`ShenyuBootstrapApplication.java` as:
+
+```shell
+-javaagent:~/shenyu/shenyu-dist/shenyu-agent-dist/target/shenyu-agent/shenyu-agent.jar
+````
+
+Among them, the parameter followed by `-javaagent:` is the absolute path of
`shenyu-agent.jar`, which is packaged by `shenyu-dist`.
+
+## Run/Debug
+
+Then, start `ShenyuBootstrapApplication.java` for normal operation or
debugging, and the shenyu-agent module can be debugged with breakpoints
normally.
diff --git a/docs/user-guide/observability/observability.md
b/docs/user-guide/observability/observability.md
index 47e918f..0b839f5 100644
--- a/docs/user-guide/observability/observability.md
+++ b/docs/user-guide/observability/observability.md
@@ -88,4 +88,4 @@ plugins:
For deployment, please refer to [Binary Packages
Deployment](../../deployment/deployment-package.md#start-shenyu-bootstrap-with-shenyu-agent)
or [Docker
Deployment](../../deployment/deployment-docker.md#start-shenyu-bootstrap-with-shenyu-agent)
-> Developers can add the `-javaagent` parameter to the JVM parameter of the
IDE startup configuration
+> Developers can add the `-javaagent` parameter to the JVM parameter of the
IDE startup configuration, please refer to [Local debug and run agent
module](../../developer/debug-agent.md).
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/developer/debug-agent.md
b/i18n/zh/docusaurus-plugin-content-docs/current/developer/debug-agent.md
new file mode 100644
index 0000000..ea687f4
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/developer/debug-agent.md
@@ -0,0 +1,28 @@
+---
+title: 本地调试运行 agent 模块
+description: 本地调试运行 agent 模块
+---
+
+## 说明
+
+* 本文将介绍如何在本地调试运行 `shenyu-agent` 模块
+
+## 准备
+
+1. 拉取 Apache ShenYu 代码
+2. 安装 IDEA
+3. 参考 [本地部署](../deployment/deployment-local.md) 完成代码的下载与编译
+
+## 设置JVM启动参数
+
+在 IDEA 中，将 `ShenyuBootstrapApplication.java` 的启动配置里的 VM options 设置为：
+
+```shell
+-javaagent:~/shenyu/shenyu-dist/shenyu-agent-dist/target/shenyu-agent/shenyu-agent.jar
+```
+
+其中，`-javaagent:` 后面跟着的参数为 `shenyu-agent.jar` 的绝对路径，由 `shenyu-dist` 打包。
+
+## 运行/调试
+
+接着，正常运行或调试启动 `ShenyuBootstrapApplication.java` 即可，shenyu-agent 模块可以正常断点调试。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/observability.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/observability.md
index 57da6f8..f771daa 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/observability.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/observability/observability.md
@@ -88,4 +88,4 @@ plugins:
部署请参考
[二进制包部署](../../deployment/deployment-package.md#启动-shenyu-bootstrap-的同时启动-shenyu-agent)
或
[Docker部署](../../deployment/deployment-docker.md#启动-shenyu-bootstrap-的同时启动-shenyu-agent)
-> 开发者可将-javaagent参数添加到IDE启动配置的JVM参数中
+> 开发者可将-javaagent参数添加到IDE启动配置的JVM参数中，请参考
[本地调试运行agent模块](../../developer/debug-agent.md)
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/debug-agent.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/debug-agent.md
new file mode 100644
index 0000000..ea687f4
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/developer/debug-agent.md
@@ -0,0 +1,28 @@
+---
+title: 本地调试运行 agent 模块
+description: 本地调试运行 agent 模块
+---
+
+## 说明
+
+* 本文将介绍如何在本地调试运行 `shenyu-agent` 模块
+
+## 准备
+
+1. 拉取 Apache ShenYu 代码
+2. 安装 IDEA
+3. 参考 [本地部署](../deployment/deployment-local.md) 完成代码的下载与编译
+
+## 设置JVM启动参数
+
+在 IDEA 中，将 `ShenyuBootstrapApplication.java` 的启动配置里的 VM options 设置为：
+
+```shell
+-javaagent:~/shenyu/shenyu-dist/shenyu-agent-dist/target/shenyu-agent/shenyu-agent.jar
+```
+
+其中，`-javaagent:` 后面跟着的参数为 `shenyu-agent.jar` 的绝对路径，由 `shenyu-dist` 打包。
+
+## 运行/调试
+
+接着，正常运行或调试启动 `ShenyuBootstrapApplication.java` 即可，shenyu-agent 模块可以正常断点调试。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/observability/observability.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/observability/observability.md
index 57da6f8..f771daa 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/observability/observability.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/observability/observability.md
@@ -88,4 +88,4 @@ plugins:
部署请参考
[二进制包部署](../../deployment/deployment-package.md#启动-shenyu-bootstrap-的同时启动-shenyu-agent)
或
[Docker部署](../../deployment/deployment-docker.md#启动-shenyu-bootstrap-的同时启动-shenyu-agent)
-> 开发者可将-javaagent参数添加到IDE启动配置的JVM参数中
+> 开发者可将-javaagent参数添加到IDE启动配置的JVM参数中，请参考
[本地调试运行agent模块](../../developer/debug-agent.md)
diff --git a/versioned_docs/version-2.4.2/developer/debug-agent.md
b/versioned_docs/version-2.4.2/developer/debug-agent.md
new file mode 100644
index 0000000..81eb92d
--- /dev/null
+++ b/versioned_docs/version-2.4.2/developer/debug-agent.md
@@ -0,0 +1,29 @@
+---
+title: Debug and run agent module locally
+keywords: ["Agent"]
+description: Debug and run the agent module locally
+---
+
+## Description
+
+* This article will introduce how to debug and run the `shenyu-agent` module
locally
+
+## Prepare
+
+1. Pull the Apache ShenYu code
+2. Install IDEA
+3. Refer to [local deployment](../deployment/deployment-local.md) to download
and compile the code
+
+## Set JVM startup parameters
+
+In IDEA, set VM options in the startup parameters of
`ShenyuBootstrapApplication.java` as:
+
+```shell
+-javaagent:~/shenyu/shenyu-dist/shenyu-agent-dist/target/shenyu-agent/shenyu-agent.jar
+````
+
+Among them, the parameter followed by `-javaagent:` is the absolute path of
`shenyu-agent.jar`, which is packaged by `shenyu-dist`.
+
+## Run/Debug
+
+Then, start `ShenyuBootstrapApplication.java` for normal operation or
debugging, and the shenyu-agent module can be debugged with breakpoints
normally.
diff --git
a/versioned_docs/version-2.4.2/user-guide/observability/observability.md
b/versioned_docs/version-2.4.2/user-guide/observability/observability.md
index 47e918f..0b839f5 100644
--- a/versioned_docs/version-2.4.2/user-guide/observability/observability.md
+++ b/versioned_docs/version-2.4.2/user-guide/observability/observability.md
@@ -88,4 +88,4 @@ plugins:
For deployment, please refer to [Binary Packages
Deployment](../../deployment/deployment-package.md#start-shenyu-bootstrap-with-shenyu-agent)
or [Docker
Deployment](../../deployment/deployment-docker.md#start-shenyu-bootstrap-with-shenyu-agent)
-> Developers can add the `-javaagent` parameter to the JVM parameter of the
IDE startup configuration
+> Developers can add the `-javaagent` parameter to the JVM parameter of the
IDE startup configuration, please refer to [Local debug and run agent
module](../../developer/debug-agent.md).
