From 178e7b9e01d506a769861ff42890305b9eb7a986 Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Wed, 1 Jul 2020 11:29:59 +0800 Subject: [PATCH] update doc --- README.html | 5 +- _sources/index.md.txt | 1 + _sources/spring-boot-starter.md.txt | 70 ++++++ _static/documentation_options.js | 2 +- advanced-use.html | 5 +- advice-class.html | 5 +- agent.html | 5 +- arthas3.html | 5 +- arthas_3_0/new_feature.html | 5 +- async.html | 5 +- batch-support.html | 5 +- cat.html | 5 +- classloader.html | 5 +- commands.html | 5 +- contact-us.html | 9 +- dashboard.html | 5 +- docker.html | 9 +- download.html | 5 +- dump.html | 5 +- echo.html | 5 +- en/.buildinfo | 2 +- en/README.html | 5 +- en/_sources/index.md.txt | 1 + en/_sources/spring-boot-starter.md.txt | 70 ++++++ en/_static/documentation_options.js | 2 +- en/advanced-use.html | 5 +- en/advice-class.html | 5 +- en/agent.html | 5 +- en/async.html | 5 +- en/batch-support.html | 5 +- en/cat.html | 5 +- en/classloader.html | 5 +- en/commands.html | 5 +- en/contact-us.html | 9 +- en/dashboard.html | 5 +- en/docker.html | 9 +- en/download.html | 5 +- en/dump.html | 5 +- en/echo.html | 5 +- en/genindex.html | 5 +- en/getstatic.html | 5 +- en/grep.html | 5 +- en/groovy.html | 5 +- en/heapdump.html | 5 +- en/index.html | 6 +- en/install-detail.html | 5 +- en/jad.html | 5 +- en/jvm.html | 5 +- en/keymap.html | 5 +- en/logger.html | 5 +- en/manual-install.html | 5 +- en/mbean.html | 5 +- en/mc.html | 5 +- en/monitor.html | 5 +- en/objects.inv | Bin 822 -> 848 bytes en/ognl.html | 5 +- en/options.html | 5 +- en/perfcounter.html | 5 +- en/profiler.html | 5 +- en/pwd.html | 5 +- en/quick-start.html | 5 +- en/redefine.html | 5 +- en/release-notes.html | 5 +- en/reset.html | 5 +- en/save-log.html | 5 +- en/sc.html | 5 +- en/search.html | 5 +- en/searchindex.js | 2 +- en/sm.html | 5 +- en/spring-boot-starter.html | 319 ++++++++++++++++++++++++ en/stack.html | 5 +- en/start-arthas.html | 5 +- en/sysenv.html | 5 +- en/sysprop.html | 5 +- en/tee.html | 5 +- en/thread.html | 5 +- en/trace.html | 5 +- en/tt.html | 5 +- en/vmoption.html | 5 +- en/watch.html | 5 +- en/web-console.html | 5 +- genindex.html | 5 +- getstatic.html | 5 +- grep.html | 5 +- groovy.html | 5 +- heapdump.html | 5 +- index.html | 6 +- install-detail.html | 5 +- jad.html | 5 +- jvm.html | 5 +- keymap.html | 5 +- logger.html | 5 +- manual-install.html | 5 +- mbean.html | 5 +- mc.html | 5 +- monitor.html | 5 +- objects.inv | Bin 1020 -> 1035 bytes ognl.html | 5 +- options.html | 5 +- perfcounter.html | 5 +- profiler.html | 5 +- pwd.html | 5 +- quick-start.html | 5 +- redefine.html | 5 +- release-notes.html | 5 +- reset.html | 5 +- save-log.html | 5 +- sc.html | 5 +- search.html | 5 +- searchindex.js | 2 +- sm.html | 5 +- spring-boot-starter.html | 324 +++++++++++++++++++++++++ stack.html | 5 +- start-arthas.html | 5 +- sysenv.html | 5 +- sysprop.html | 5 +- tee.html | 5 +- thread.html | 5 +- trace.html | 5 +- tt.html | 5 +- vmoption.html | 5 +- watch.html | 5 +- web-console.html | 5 +- 123 files changed, 1130 insertions(+), 233 deletions(-) create mode 100644 _sources/spring-boot-starter.md.txt create mode 100644 en/_sources/spring-boot-starter.md.txt create mode 100644 en/spring-boot-starter.html create mode 100644 spring-boot-starter.html diff --git a/README.html b/README.html index 26a7974b1..49d8a7d6e 100644 --- a/README.html +++ b/README.html @@ -8,7 +8,7 @@ - <no title> — Arthas 3.3.4 文档 + <no title> — Arthas 3.3.6 文档 @@ -66,7 +66,7 @@
- 3.3.4 + 3.3.6
@@ -102,6 +102,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/_sources/index.md.txt b/_sources/index.md.txt index 094bbc93b..ca3086d26 100644 --- a/_sources/index.md.txt +++ b/_sources/index.md.txt @@ -37,6 +37,7 @@ Contents * [命令列表](commands.md) * [WebConsole](web-console.md) * [Docker](docker.md) +* [Arthas Spring Boot Starter](spring-boot-starter.md) * [用户案例](https://github.com/alibaba/arthas/issues?q=label%3Auser-case) * [常见问题](https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered) * [Fork me at GitHub](https://github.com/alibaba/arthas) diff --git a/_sources/spring-boot-starter.md.txt b/_sources/spring-boot-starter.md.txt new file mode 100644 index 000000000..96598bba6 --- /dev/null +++ b/_sources/spring-boot-starter.md.txt @@ -0,0 +1,70 @@ +Arthas Spring Boot Starter +===== + +> 只支持 spring boot 2 + +最新版本：[查看](https://search.maven.org/search?q=arthas-spring-boot-starter) + +配置maven依赖： + +```xml + + com.taobao.arthas + arthas-spring-boot-starter + ${arthas.version} + +``` + +应用启动后，spring会启动arthas，并且attach自身进程。 + + +### 配置属性 + +比如，通过配置tunnel server实现远程管理： + +``` +arthas.agentId=hsehdfsfghhwertyfad +arthas.tunnel-server=ws://47.75.156.201:7777/ws +``` + +全部支持的配置项：[参考](https://github.com/alibaba/arthas/blob/master/arthas-spring-boot-starter/src/main/java/com/alibaba/arthas/spring/ArthasProperties.java) + + +### 查看Endpoint信息 + +假定endpoint端口是 8080，则通过下面url可以查看： + +http://localhost:8080/actuator/arthas + +``` +{ + "arthasConfigMap": { + "agentId": "hsehdfsfghhwertyfad", + "tunnel-server": "ws://47.75.156.201:7777/ws", + } +} +``` + +### 非spring boot应用使用方式 + +非Spring Boot应用，可以通过下面的方式来使用： + +```xml + + com.taobao.arthas + arthas-agent-attach + ${arthas.version} + +``` + +```java +import com.taobao.arthas.agent.attach.ArthasAgent; + +public class ArthasAttachExample { + + public static void main(String[] args) { + ArthasAgent.attach(); + } + +} +``` \ No newline at end of file diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 6ed8671e3..b13f9ada9 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '3.3.4', + VERSION: '3.3.6', LANGUAGE: 'zh_CN', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', diff --git a/advanced-use.html b/advanced-use.html index 470d2a458..2c3b67f98 100644 --- a/advanced-use.html +++ b/advanced-use.html @@ -8,7 +8,7 @@ - 进阶使用 — Arthas 3.3.4 文档 + 进阶使用 — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -130,6 +130,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/advice-class.html b/advice-class.html index b61dbb2e7..fe8b9cd19 100644 --- a/advice-class.html +++ b/advice-class.html @@ -8,7 +8,7 @@ - 表达式核心变量 — Arthas 3.3.4 文档 + 表达式核心变量 — Arthas 3.3.6 文档 @@ -66,7 +66,7 @@
    - 3.3.4 + 3.3.6
    @@ -102,6 +102,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/agent.html b/agent.html index 04f8bb6b4..65a61b71f 100644 --- a/agent.html +++ b/agent.html @@ -8,7 +8,7 @@ - 以Java Agent的方式启动 — Arthas 3.3.4 文档 + 以Java Agent的方式启动 — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -121,6 +121,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/arthas3.html b/arthas3.html index ca721ee49..9fefc6687 100644 --- a/arthas3.html +++ b/arthas3.html @@ -8,7 +8,7 @@ - Arthas3.0的新特性 — Arthas 3.3.4 文档 + Arthas3.0的新特性 — Arthas 3.3.6 文档 @@ -66,7 +66,7 @@
    - 3.3.4 + 3.3.6
    @@ -102,6 +102,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/arthas_3_0/new_feature.html b/arthas_3_0/new_feature.html index 689546e59..6a2732edf 100644 --- a/arthas_3_0/new_feature.html +++ b/arthas_3_0/new_feature.html @@ -8,7 +8,7 @@ - Arthas 3.0新特性介绍 — Arthas 3.3.4 文档 + Arthas 3.0新特性介绍 — Arthas 3.3.6 文档 @@ -66,7 +66,7 @@
    - 3.3.4 + 3.3.6
    @@ -102,6 +102,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/async.html b/async.html index 0e1408263..f3df0ac16 100644 --- a/async.html +++ b/async.html @@ -8,7 +8,7 @@ - Arthas异步调用 — Arthas 3.3.4 文档 + Arthas异步调用 — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -133,6 +133,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/batch-support.html b/batch-support.html index d7fec06fe..d279bc7dd 100644 --- a/batch-support.html +++ b/batch-support.html @@ -8,7 +8,7 @@ - 批处理功能 — Arthas 3.3.4 文档 + 批处理功能 — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -127,6 +127,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/cat.html b/cat.html index a2e57be96..841daab8c 100644 --- a/cat.html +++ b/cat.html @@ -8,7 +8,7 @@ - cat — Arthas 3.3.4 文档 + cat — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -138,6 +138,7 @@
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/classloader.html b/classloader.html index aebde3aac..ccce4861f 100644 --- a/classloader.html +++ b/classloader.html @@ -8,7 +8,7 @@ - classloader — Arthas 3.3.4 文档 + classloader — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -150,6 +150,7 @@
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/commands.html b/commands.html index 5ee912b22..605b9013c 100644 --- a/commands.html +++ b/commands.html @@ -8,7 +8,7 @@ - 命令列表 — Arthas 3.3.4 文档 + 命令列表 — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -138,6 +138,7 @@
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/contact-us.html b/contact-us.html index 01bbadcb2..b184ef7ca 100644 --- a/contact-us.html +++ b/contact-us.html @@ -8,7 +8,7 @@ - 联系我们 — Arthas 3.3.4 文档 + 联系我们 — Arthas 3.3.6 文档 @@ -39,7 +39,7 @@ - + @@ -67,7 +67,7 @@
    - 3.3.4 + 3.3.6
    @@ -103,6 +103,7 @@
  • 命令列表
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • @@ -214,7 +215,7 @@ diff --git a/dashboard.html b/dashboard.html index 535495b36..b0d54979f 100644 --- a/dashboard.html +++ b/dashboard.html @@ -8,7 +8,7 @@ - dashboard — Arthas 3.3.4 文档 + dashboard — Arthas 3.3.6 文档 @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -143,6 +143,7 @@
  • WebConsole
  • Docker
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • diff --git a/docker.html b/docker.html index f9bd56105..c4b08f7e9 100644 --- a/docker.html +++ b/docker.html @@ -8,7 +8,7 @@ - Docker — Arthas 3.3.4 文档 + Docker — Arthas 3.3.6 文档 @@ -39,7 +39,7 @@ - + @@ -68,7 +68,7 @@
    - 3.3.4 + 3.3.6
    @@ -110,6 +110,7 @@
  • 把Arthas安装到基础镜像里
    • +
  • Arthas Spring Boot Starter
  • 用户案例
  • 常见问题
  • Fork me at GitHub
    • @@ -249,7 +250,7 @@ COPY --from=hengyunabc/arthas:latest /opt/arthas /opt/arthas