From 6e8b832093da1acfcf313a310c480391180c202a Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Mon, 4 Jan 2021 20:03:39 +0800 Subject: [PATCH] update doc --- README.html | 4 +- _sources/faq.md.txt | 28 ++++ _sources/index.md.txt | 4 +- _sources/trace.md.txt | 15 +- _sources/watch.md.txt | 17 ++ advanced-use.html | 4 +- advice-class.html | 4 +- agent.html | 4 +- arthas-properties.html | 4 +- arthas3.html | 4 +- arthas_3_0/new_feature.html | 4 +- async.html | 4 +- batch-support.html | 4 +- cat.html | 4 +- classloader.html | 4 +- commands.html | 4 +- contact-us.html | 8 +- dashboard.html | 4 +- docker.html | 4 +- download.html | 4 +- dump.html | 4 +- echo.html | 4 +- en/README.html | 4 +- en/_sources/faq.md.txt | 26 ++++ en/_sources/index.md.txt | 4 +- en/_sources/trace.md.txt | 15 +- en/_sources/watch.md.txt | 18 +++ en/advanced-use.html | 4 +- en/advice-class.html | 4 +- en/agent.html | 4 +- en/arthas-properties.html | 4 +- en/async.html | 4 +- en/batch-support.html | 4 +- en/cat.html | 4 +- en/classloader.html | 4 +- en/commands.html | 4 +- en/contact-us.html | 8 +- en/dashboard.html | 4 +- en/docker.html | 4 +- en/download.html | 4 +- en/dump.html | 4 +- en/echo.html | 4 +- en/faq.html | 298 +++++++++++++++++++++++++++++++++++ en/genindex.html | 4 +- en/getstatic.html | 4 +- en/grep.html | 4 +- en/groovy.html | 4 +- en/heapdump.html | 4 +- en/http-api.html | 4 +- en/idea-plugin.html | 8 +- en/index.html | 8 +- en/install-detail.html | 4 +- en/jad.html | 4 +- en/jvm.html | 4 +- en/keymap.html | 4 +- en/logger.html | 4 +- en/manual-install.html | 4 +- en/mbean.html | 4 +- en/mc.html | 4 +- en/monitor.html | 4 +- en/objects.inv | Bin 918 -> 929 bytes en/ognl.html | 4 +- en/options.html | 4 +- en/perfcounter.html | 4 +- en/profiler.html | 4 +- en/pwd.html | 4 +- en/quick-start.html | 4 +- en/redefine.html | 4 +- en/release-notes.html | 4 +- en/reset.html | 4 +- en/save-log.html | 4 +- en/sc.html | 4 +- en/search.html | 4 +- en/searchindex.js | 2 +- en/sm.html | 4 +- en/spring-boot-starter.html | 4 +- en/stack.html | 4 +- en/start-arthas.html | 4 +- en/sysenv.html | 4 +- en/sysprop.html | 4 +- en/tee.html | 4 +- en/thread.html | 4 +- en/trace.html | 21 ++- en/tt.html | 4 +- en/tunnel.html | 4 +- en/vmoption.html | 4 +- en/watch.html | 21 ++- en/web-console.html | 4 +- faq.html | 302 ++++++++++++++++++++++++++++++++++++ genindex.html | 4 +- getstatic.html | 4 +- grep.html | 4 +- groovy.html | 4 +- heapdump.html | 4 +- http-api.html | 4 +- idea-plugin.html | 8 +- index.html | 8 +- install-detail.html | 4 +- jad.html | 4 +- jvm.html | 4 +- keymap.html | 4 +- logger.html | 4 +- manual-install.html | 4 +- mbean.html | 4 +- mc.html | 4 +- monitor.html | 4 +- ognl.html | 4 +- options.html | 4 +- perfcounter.html | 4 +- profiler.html | 4 +- pwd.html | 4 +- quick-start.html | 4 +- redefine.html | 4 +- release-notes.html | 4 +- reset.html | 4 +- save-log.html | 4 +- sc.html | 4 +- search.html | 4 +- searchindex.js | 2 +- sm.html | 4 +- spring-boot-starter.html | 4 +- stack.html | 4 +- start-arthas.html | 4 +- sysenv.html | 4 +- sysprop.html | 4 +- tee.html | 4 +- thread.html | 4 +- trace.html | 25 ++- tt.html | 4 +- tunnel.html | 4 +- vmoption.html | 4 +- watch.html | 21 ++- web-console.html | 4 +- 133 files changed, 1037 insertions(+), 270 deletions(-) create mode 100644 _sources/faq.md.txt create mode 100644 en/_sources/faq.md.txt create mode 100644 en/faq.html create mode 100644 faq.html diff --git a/README.html b/README.html index 81c6c38d3..39954cb2a 100644 --- a/README.html +++ b/README.html @@ -114,8 +114,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/_sources/faq.md.txt b/_sources/faq.md.txt new file mode 100644 index 000000000..2a7d679c7 --- /dev/null +++ b/_sources/faq.md.txt @@ -0,0 +1,28 @@ + +## FAQ + + +> 不在本列表里的问题，请到issue里搜索。 [https://github.com/alibaba/arthas/issues](https://github.com/alibaba/arthas/issues) + +##### Arthas attach之后对原进程性能有多大的影响 + +[https://github.com/alibaba/arthas/issues/44](https://github.com/alibaba/arthas/issues/44) + + +##### 怎么以`json`格式查看结果 + +```bash +options json-format true +``` + +更多参考 [options](options.md) + + +##### Arthas能否跟踪 native 函数 + +不能。 + + +##### 能不能查看内存里某个变量的值 + +不能。但可以用一些技巧，用`tt`命令拦截到对象，或者从静态函数里取到对象。 \ No newline at end of file diff --git a/_sources/index.md.txt b/_sources/index.md.txt index 0aa18f38d..6bd8604b7 100644 --- a/_sources/index.md.txt +++ b/_sources/index.md.txt @@ -44,8 +44,8 @@ Contents * [Arthas Spring Boot Starter](spring-boot-starter.md) * [IDEA 插件](idea-plugin.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) +* [FAQ/常见问题](faq.md) +* [Star me at GitHub](https://github.com/alibaba/arthas) * [编译调试/参与贡献](https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md#) * [Release Notes](https://github.com/alibaba/arthas/releases) * [QQ群/钉钉群](contact-us.md) diff --git a/_sources/trace.md.txt b/_sources/trace.md.txt index ab3010e94..d72d447ba 100644 --- a/_sources/trace.md.txt +++ b/_sources/trace.md.txt @@ -34,12 +34,13 @@ trace ### 注意事项 -`trace` 能方便的帮助你定位和发现因 RT 高而导致的性能问题缺陷，但其每次只能跟踪一级方法的调用链路。 +* `trace` 能方便的帮助你定位和发现因 RT 高而导致的性能问题缺陷，但其每次只能跟踪一级方法的调用链路。 -参考：[Trace命令的实现原理](https://github.com/alibaba/arthas/issues/597) + 参考：[Trace命令的实现原理](https://github.com/alibaba/arthas/issues/597) -3.3.0 版本后，可以使用动态Trace功能，不断增加新的匹配类，参考下面的示例。 +* 3.3.0 版本后，可以使用动态Trace功能，不断增加新的匹配类，参考下面的示例。 +* 目前不支持 `trace java.lang.Thread getName`，参考issue: [#1610](https://github.com/alibaba/arthas/issues/1610) ，考虑到不是非常必要场景，且修复有一定难度，因此当前暂不修复 ### 使用参考 @@ -147,6 +148,14 @@ trace命令只会trace匹配到的函数里的子调用，并不会向下trace trace -E com.test.ClassA|org.test.ClassB method1|method2|method3 ``` +#### 排除掉指定的类 + +使用 `--exclude-class-pattern` 参数可以排除掉指定的类，比如： + +```bash +trace javax.servlet.Filter * --exclude-class-pattern com.demo.TestFilter +``` + ### 动态trace > 3.3.0 版本后支持。 diff --git a/_sources/watch.md.txt b/_sources/watch.md.txt index a413a7c74..e843dbc7f 100644 --- a/_sources/watch.md.txt +++ b/_sources/watch.md.txt @@ -235,6 +235,23 @@ ts=2018-12-03 20:04:34; [cost=131.303498ms] result=@Integer[8] ts=2018-12-03 20:04:35; [cost=0.961441ms] result=@Integer[8] ``` +#### 排除掉指定的类 + +> watch/trace/monitor/stack/tt 命令都支持 `--exclude-class-pattern` 参数 + +使用 `--exclude-class-pattern` 参数可以排除掉指定的类，比如： + +```bash +watch javax.servlet.Filter * --exclude-class-pattern com.demo.TestFilter +``` +#### 不匹配子类 + +默认情况下 watch/trace/monitor/stack/tt 命令都会匹配子类。如果想不匹配，可以通过全局参数关掉。 + +```bash +options disable-sub-class true +``` + #### 使用 -v 参数打印更多信息 > watch/trace/monitor/stack/tt 命令都支持 `-v` 参数 diff --git a/advanced-use.html b/advanced-use.html index bcb67e1b8..bb31ea4ba 100644 --- a/advanced-use.html +++ b/advanced-use.html @@ -147,8 +147,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/advice-class.html b/advice-class.html index 3575149ec..905e42df1 100644 --- a/advice-class.html +++ b/advice-class.html @@ -114,8 +114,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/agent.html b/agent.html index 2c79997e6..d1524052b 100644 --- a/agent.html +++ b/agent.html @@ -135,8 +135,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/arthas-properties.html b/arthas-properties.html index 9d0bb6945..6d86508e5 100644 --- a/arthas-properties.html +++ b/arthas-properties.html @@ -139,8 +139,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/arthas3.html b/arthas3.html index 4e492f96b..1d76b7444 100644 --- a/arthas3.html +++ b/arthas3.html @@ -114,8 +114,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/arthas_3_0/new_feature.html b/arthas_3_0/new_feature.html index 5ba639b18..d0d53eae2 100644 --- a/arthas_3_0/new_feature.html +++ b/arthas_3_0/new_feature.html @@ -114,8 +114,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/async.html b/async.html index 4060bed57..1c9d53689 100644 --- a/async.html +++ b/async.html @@ -147,8 +147,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/batch-support.html b/batch-support.html index bdd1e010e..d795160ac 100644 --- a/batch-support.html +++ b/batch-support.html @@ -141,8 +141,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/cat.html b/cat.html index e48a61891..01f79ae04 100644 --- a/cat.html +++ b/cat.html @@ -150,8 +150,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/classloader.html b/classloader.html index db4310450..f928e4384 100644 --- a/classloader.html +++ b/classloader.html @@ -162,8 +162,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/commands.html b/commands.html index 658281c3c..9fb07bad4 100644 --- a/commands.html +++ b/commands.html @@ -150,8 +150,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/contact-us.html b/contact-us.html index 66ed9e5b2..54d919acd 100644 --- a/contact-us.html +++ b/contact-us.html @@ -39,7 +39,7 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + + + +
    + +
    + + + + + + + + + + + + + + + + + +
    + + + + +
    +
    +
    +
    + +
    +

    FAQ

    +
    +

    For questions that are not in this list, please search in issues. https://github.com/alibaba/arthas/issues

    +
    +
    +

    How much impact does Arthas attach have on the performance of the original process?

    +

    https://github.com/alibaba/arthas/issues/44

    +
    +
    +

    How to view the result in json format

    +
    options json-format true
    +
    +

    See more at options

    +
    +
    +

    Can arthas trace native methods

    +

    No.

    +
    +
    +

    Can arthas view the value of a variable in memory?

    +

    No. But you can use some tricks to intercept the object with the tt command, or fetch it from a static method.

    +
    +
    + + +
    + +
    + + +
    +
    + +
    + +
    + + + + + + + + + +
    +
    + Fork me at GitHub +
    +
    + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/en/genindex.html b/en/genindex.html index 760dabfd7..cc4aa4eb9 100644 --- a/en/genindex.html +++ b/en/genindex.html @@ -111,8 +111,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/getstatic.html b/en/getstatic.html index c75cc7794..cd5b5cda3 100644 --- a/en/getstatic.html +++ b/en/getstatic.html @@ -150,8 +150,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/grep.html b/en/grep.html index 2a92b5282..a929a5569 100644 --- a/en/grep.html +++ b/en/grep.html @@ -146,8 +146,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/groovy.html b/en/groovy.html index 3cc5ce505..9a0270b73 100644 --- a/en/groovy.html +++ b/en/groovy.html @@ -110,8 +110,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/heapdump.html b/en/heapdump.html index e1e325ce9..1265f3be2 100644 --- a/en/heapdump.html +++ b/en/heapdump.html @@ -154,8 +154,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/http-api.html b/en/http-api.html index c9270048f..e36890a55 100644 --- a/en/http-api.html +++ b/en/http-api.html @@ -144,8 +144,8 @@
  • Arthas Spring Boot Starter
  • IDEA Plugin
  • User cases
    • -
  • Questions and answers
    • -
  • Fork me at GitHub
    • +
  • FAQ
    • +
  • Star me at GitHub
  • Compile and debug/CONTRIBUTING
  • Release Notes
  • Contact us
    • diff --git a/en/idea-plugin.html b/en/idea-plugin.html index 93bf963f8..1fc6483cd 100644 --- a/en/idea-plugin.html +++ b/en/idea-plugin.html @@ -38,7 +38,7 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + + + +
    + +
    + + + + + + + + + + + + + + + + + +
    + + + + +
    +
    +
    +
    + +
    +

    FAQ

    +
    +

    不在本列表里的问题，请到issue里搜索。 https://github.com/alibaba/arthas/issues

    +
    +
    +

    Arthas attach之后对原进程性能有多大的影响

    +

    https://github.com/alibaba/arthas/issues/44

    +
    +
    +

    怎么以json格式查看结果

    +
    options json-format true
    +
    +

    更多参考 options

    +
    +
    +

    Arthas能否跟踪 native 函数

    +

    不能。

    +
    +
    +

    能不能查看内存里某个变量的值

    +

    不能。但可以用一些技巧，用tt命令拦截到对象，或者从静态函数里取到对象。

    +
    +
    + + +
    + +
    + + +
    +
    + +
    + +
    + + + + + + + + + +
    +
    + Fork me at GitHub +
    +
    + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html index e8fcfc124..87333a2c4 100644 --- a/genindex.html +++ b/genindex.html @@ -115,8 +115,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/getstatic.html b/getstatic.html index 059911af2..2f850cd9d 100644 --- a/getstatic.html +++ b/getstatic.html @@ -150,8 +150,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/grep.html b/grep.html index cce63a264..f9353d9aa 100644 --- a/grep.html +++ b/grep.html @@ -150,8 +150,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/groovy.html b/groovy.html index e845772f3..94dc513ae 100644 --- a/groovy.html +++ b/groovy.html @@ -114,8 +114,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/heapdump.html b/heapdump.html index b63078975..8316cb4c2 100644 --- a/heapdump.html +++ b/heapdump.html @@ -158,8 +158,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/http-api.html b/http-api.html index 490fa543c..9eb455849 100644 --- a/http-api.html +++ b/http-api.html @@ -148,8 +148,8 @@
  • Arthas Spring Boot Starter
  • IDEA 插件
  • 用户案例
    • -
  • 常见问题
    • -
  • Fork me at GitHub
    • +
  • FAQ/常见问题
    • +
  • Star me at GitHub
  • 编译调试/参与贡献
  • Release Notes
  • QQ群/钉钉群
    • diff --git a/idea-plugin.html b/idea-plugin.html index 4b4631861..e5f98db57 100644 --- a/idea-plugin.html +++ b/idea-plugin.html @@ -39,7 +39,7 @@ - +