add sm command scenario #847 (#1371)

5 years ago · 1179fe16be
parent 2e979ff35f
commit 1179fe16be
14 changed files with 445 additions and 0 deletions
--- a/site/src/site/sphinx/en/sm.md
+++ b/site/src/site/sphinx/en/sm.md
@ -1,6 +1,8 @@
 sm
 ==

+[`sm` online tutorial](https://arthas.aliyun.com/doc/arthas-tutorials?language=en&id=command-sm)
+
 > Search method from the loaded classes.

 `sm` stands for search method. This command can search and show method information from all loaded classes. `sm` can only view the methods declared on the target class, that is, methods from its parent classes are invisible.
@ -14,6 +16,8 @@ sm
 |*method-pattern*|pattern for method name|
 |`[d]`|print the details of the method|
 |`[E]`|turn on regex matching while the default mode is wildcard matching|
+|`[c:]`|The hash code of the special class's classLoader|
+|`[n:]`|Maximum number of matching classes with details (100 by default)|

 ### Usage

--- a/site/src/site/sphinx/sm.md
+++ b/site/src/site/sphinx/sm.md
@ -1,6 +1,8 @@
 sm
 ===

+[`sm`在线教程](https://arthas.aliyun.com/doc/arthas-tutorials?language=cn&id=command-sm)
+
 > 查看已加载类的方法信息

 “Search-Method” 的简写，这个命令能搜索出所有已经加载了 Class 信息的方法信息。
@ -15,6 +17,8 @@ sm
 |*method-pattern*|方法名表达式匹配|
 |[d]|展示每个方法的详细信息|
 |[E]|开启正则表达式匹配，默认为通配符匹配|
+|`[c:]`|指定class的 ClassLoader 的 hashcode|
+|`[n:]`|具有详细信息的匹配类的最大数量（默认为100）|

 ### 使用参考

--- a/tutorials/katacoda/command-sm-cn/arthas-boot.md
+++ b/tutorials/katacoda/command-sm-cn/arthas-boot.md
@ -0,0 +1,16 @@
+
+
+
+
+在新的`Terminal 2`里，下载`arthas-boot.jar`，再用`java -jar`命令启动：
+
+`wget https://arthas.aliyun.com/doc/arthas-boot.jar
+java -jar arthas-boot.jar`{{execute T2}}
+
+`arthas-boot`是`Arthas`的启动程序，它启动后，会列出所有的Java进程，用户可以选择需要诊断的目标进程。
+
+选择第一个进程，输入 `1`{{execute T2}} ，再`Enter/回车`：
+
+Attach成功之后，会打印Arthas LOGO。输入 `help`{{execute T2}} 可以获取到更多的帮助信息。
+
+![Arthas Boot](/arthas/scenarios/common-resources/assets/arthas-boot.png)
--- a/tutorials/katacoda/command-sm-cn/arthas-demo.md
+++ b/tutorials/katacoda/command-sm-cn/arthas-demo.md
@ -0,0 +1,10 @@
+
+
+
+
+下载`arthas-demo.jar`，再用`java -jar`命令启动：
+
+`wget https://arthas.aliyun.com/doc/arthas-demo.jar
+java -jar arthas-demo.jar`{{execute T1}}
+
+`arthas-demo`是一个很简单的程序，它随机生成整数，再执行因式分解，把结果打印出来。如果生成的随机数是负数，则会打印提示信息。
--- a/tutorials/katacoda/command-sm-cn/finish.md
+++ b/tutorials/katacoda/command-sm-cn/finish.md
@ -0,0 +1,12 @@
+
+在“sc”中，我们演示了了Arthas的sc命令。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
+
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://arthas.aliyun.com/doc
+
+
+如果您在使用Arthas，请让我们知道，您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+
+![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
--- a/tutorials/katacoda/command-sm-cn/index.json
+++ b/tutorials/katacoda/command-sm-cn/index.json
@ -0,0 +1,35 @@
+{
+  "title": "Arthas sc命令",
+  "description": "Arthas sc命令",
+  "difficulty": "精通者",
+  "time": "10-20 分钟",
+  "details": {
+    "steps": [
+      {
+        "title": "启动arthas demo",
+        "text": "arthas-demo.md"
+      },
+      {
+        "title": "启动arthas-boot",
+        "text": "arthas-boot.md"
+      },
+      {
+        "title": "sc命令",
+        "text": "sc.md"
+      }
+    ],
+    "intro": {
+      "text": "intro.md"
+    },
+    "finish": {
+      "text": "finish.md"
+    }
+  },
+  "environment": {
+    "uilayout": "terminal"
+  },
+  "backend": {
+    "imageid": "java",
+    "environmentsprotocol": "http"
+  }
+}
--- a/tutorials/katacoda/command-sm-cn/intro.md
+++ b/tutorials/katacoda/command-sm-cn/intro.md
@ -0,0 +1,23 @@
+
+
+
+![Arthas](https://arthas.aliyun.com/doc/_images/arthas.png)
+
+`Arthas` 是Alibaba开源的Java诊断工具，深受开发者喜爱。在线排查问题，无需重启；动态跟踪Java代码；实时监控JVM状态。
+
+`Arthas` 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
+
+当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：
+
+- 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
+- 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
+- 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
+- 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
+- 是否有一个全局视角来查看系统的运行状况？
+- 有什么办法可以监控到JVM的实时运行状态？
+- 怎么快速定位应用的热点，生成火焰图？
+
+本教程会以一个简单的应用为例，演示sc命令。
+
+* Github: https://github.com/alibaba/arthas
+* 文档: https://arthas.aliyun.com/doc/
--- a/tutorials/katacoda/command-sm-cn/sm.md
+++ b/tutorials/katacoda/command-sm-cn/sm.md
@ -0,0 +1,116 @@
+
+> 查看已加载类的方法信息
+
+“Search-Method” 的简写，这个命令能搜索出所有已经加载了 Class 信息的方法信息。
+
+`sm` 命令只能看到由当前类所声明 (declaring) 的方法，父类则无法看到。
+
+### 参数说明
+
+|参数名称|参数说明|
+|---:|:---|
+|*class-pattern*|类名表达式匹配|
+|*method-pattern*|方法名表达式匹配|
+|[d]|展示每个方法的详细信息|
+|[E]|开启正则表达式匹配，默认为通配符匹配|
+|`[c:]`|指定class的 ClassLoader 的 hashcode|
+|`[n:]`|具有详细信息的匹配类的最大数量（默认为100）|
+
+### 使用参考
+
+* 查找`java.lang.String`类的具体方法
+
+`sm java.lang.String`{{execute T2}}
+
+```bash
+$ sm java.lang.String
+java.lang.String-><init>
+java.lang.String->equals
+java.lang.String->toString
+java.lang.String->hashCode
+java.lang.String->compareTo
+java.lang.String->indexOf
+java.lang.String->valueOf
+java.lang.String->checkBounds
+java.lang.String->length
+java.lang.String->isEmpty
+java.lang.String->charAt
+java.lang.String->codePointAt
+java.lang.String->codePointBefore
+java.lang.String->codePointCount
+java.lang.String->offsetByCodePoints
+java.lang.String->getChars
+java.lang.String->getBytes
+java.lang.String->contentEquals
+java.lang.String->nonSyncContentEquals
+java.lang.String->equalsIgnoreCase
+java.lang.String->compareToIgnoreCase
+java.lang.String->regionMatches
+java.lang.String->startsWith
+java.lang.String->endsWith
+java.lang.String->indexOfSupplementary
+java.lang.String->lastIndexOf
+java.lang.String->lastIndexOfSupplementary
+java.lang.String->substring
+java.lang.String->subSequence
+java.lang.String->concat
+java.lang.String->replace
+java.lang.String->matches
+java.lang.String->contains
+java.lang.String->replaceFirst
+java.lang.String->replaceAll
+java.lang.String->split
+java.lang.String->join
+java.lang.String->toLowerCase
+java.lang.String->toUpperCase
+java.lang.String->trim
+java.lang.String->toCharArray
+java.lang.String->format
+java.lang.String->copyValueOf
+java.lang.String->intern
+Affect(row-cnt:44) cost in 1342 ms.
+```
+
+* 指定ClassLoader
+
+查找ClassLoaderHash：
+
+`sc -d demo.MathGame | grep classLoaderHash`{{execute T2}}
+
+```bash
+$ sc -d demo.MathGame | grep classLoaderHash
+ classLoaderHash   70dea4e
+```
+
+记住这里的classLoaderHash：`70dea4e`，并用其替换`<classLoaderHash>`，手动执行下一条命令。
+
+查找classloader下的class的method
+
+`sc -c <classLoaderHash> -d demo.MathGame`
+
+```bash
+$ sm -c 70dea4e demo.MathGame
+demo.MathGame <init>()V
+demo.MathGame primeFactors(I)Ljava/util/List;
+demo.MathGame main([Ljava/lang/String;)V
+demo.MathGame run()V
+demo.MathGame print(ILjava/util/List;)V
+Affect(row-cnt:5) cost in 2 ms.
+```
+
+* 查找`java.lang.String#toString`函数并打印详细信息
+
+`sm -d java.lang.String toString`{{execute T2}}
+
+```bash
+$ sm -d java.lang.String toString
+ declaring-class  java.lang.String
+ method-name      toString
+ modifier         public
+ annotation
+ parameters
+ return           java.lang.String
+ exceptions
+
+Affect(row-cnt:1) cost in 3 ms.
+```
--- a/tutorials/katacoda/command-sm-en/arthas-boot.md
+++ b/tutorials/katacoda/command-sm-en/arthas-boot.md
@ -0,0 +1,16 @@
+
+
+
+
+In the new `Terminal 2`, download `arthas-boot.jar` and start with the `java -jar` command:
+
+`wget https://arthas.aliyun.com/doc/arthas-boot.jar
+java -jar arthas-boot.jar`{{execute T2}}
+
+`arthas-boot` is the launcher for `Arthas`. It lists all the Java processes, and the user can select the target process to be diagnosed.
+
+Select the first process, type `1`{{execute T2}} ，then type `Enter`：
+
+After the Attach is successful, Arthas LOGO is printed. Enter `help`{{execute T2}} for more help.
+
+![Arthas Boot](/arthas/scenarios/common-resources/assets/arthas-boot.png)
--- a/tutorials/katacoda/command-sm-en/arthas-demo.md
+++ b/tutorials/katacoda/command-sm-en/arthas-demo.md
@ -0,0 +1,11 @@
+
+
+
+
+Download `arthas-demo.jar` and start with the `java -jar` command:
+
+`wget https://arthas.aliyun.com/doc/arthas-demo.jar
+java -jar arthas-demo.jar`{{execute T1}}
+
+`arthas-demo` is a very simple program that randomly generates integers, performs factorization, and prints the results.
+If the generated random number is negative, a error message will be printed.
--- a/tutorials/katacoda/command-sm-en/finish.md
+++ b/tutorials/katacoda/command-sm-en/finish.md
@ -0,0 +1,8 @@
+
+The `sc Tutorial` demonstrates the usage of sc. If you have more tips or questions, please feel free to ask in Issue.
+
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://arthas.aliyun.com/doc/en
+
+
+If you are using Arthas, please let us know. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
--- a/tutorials/katacoda/command-sm-en/index.json
+++ b/tutorials/katacoda/command-sm-en/index.json
@ -0,0 +1,35 @@
+{
+  "title": "Arthas sc Command",
+  "description": "Arthas sc Command",
+  "difficulty": "master",
+  "time": "10-20 minutes",
+  "details": {
+    "steps": [
+      {
+        "title": "Arthas demo",
+        "text": "arthas-demo.md"
+      },
+      {
+        "title": "Start arthas-boot",
+        "text": "arthas-boot.md"
+      },
+      {
+        "title": "sc Command",
+        "text": "sc.md"
+      }
+    ],
+    "intro": {
+      "text": "intro.md"
+    },
+    "finish": {
+      "text": "finish.md"
+    }
+  },
+  "environment": {
+    "uilayout": "terminal"
+  },
+  "backend": {
+    "imageid": "java",
+    "environmentsprotocol": "http"
+  }
+}
--- a/tutorials/katacoda/command-sm-en/intro.md
+++ b/tutorials/katacoda/command-sm-en/intro.md
@ -0,0 +1,40 @@
+
+
+
+![Arthas](https://arthas.aliyun.com/doc/_images/arthas.png)
+
+`Arthas` is a Java diagnostic tool open-sourced by Alibaba middleware team. Arthas helps developers in trouble-shooting issues in production environment for Java based applications without modifying code or restarting servers.
+
+`Arthas` supports JDK 6+, supports Linux/Mac/Windows.
+
+## Background
+
+Oftentimes the production system network is inaccessible from local development environment. If issues are encountered in production systems, it is impossible to use IDE to debug the application remotely. What’s even worse, debugging in production environment is unacceptable, as it will suspend all the threads, leading to services downtime.
+
+Developers could always try to reproduce the same issue on the test/staging environment. However, this is tricky as some issues cannot be reproduced easily in a different environment, or even disappear once restarted.
+
+And if you’re thinking of adding some logs to your code to help trouble-shoot the issue, you will have to go through the following lifecycle: test, staging, and then to production. Time is money! This approach is inefficient! Worse still, the issue may not be fixed since it might be irreproducible once the JVM is restarted, as described above.
+
+Arthas is built to solve these issues. A developer can troubleshoot production issues on the fly. No JVM restart, no additional code changes. Arthas works as an observer, that is, it will never suspend your running threads.
+
+## Key features
+
+- Check whether a class is loaded? Or where the class is loaded from? (Useful for trouble-shooting jar file conflicts)
+- Decompile a class to ensure the code is running as expected.
+- Check classloader statistics, e.g. the number of classloaders, the number of classes loaded per classloader, the classloader hierarchy, possible classloader leaks, etc.
+- Check the method invocation details, e.g. method parameter, returned values, exceptions and etc.
+- Check the stack trace of specified method invocation. This is useful when a developer wants to know the caller of the method.
+- Trace the method invocation to find slow sub-invocations.
+- Monitor method invocation statistics, e.g. QPS (Query Per Second), RT (Return Time), success rate and etc.
+- Monitor system metrics, thread states and CPU usage, GC statistics and etc.
+- Supports command line interactive mode, with auto-complete feature enabled.
+- Supports telnet and WebSocket, which enables both local and remote diagnostics with command line and browsers.
+- Supports profiler/Flame Graph
+- Supports JDK 6+
+- Supports Linux/Mac/Windows
+
+This tutorial takes a simple application as an example to demonstrate the the usage of sc.
+
+* Github: https://github.com/alibaba/arthas
+* Docs: https://arthas.aliyun.com/doc/en
+
--- a/tutorials/katacoda/command-sm-en/sm.md
+++ b/tutorials/katacoda/command-sm-en/sm.md
@ -0,0 +1,115 @@
+
+> Search method from the loaded classes.
+
+`sm` stands for search method. This command can search and show method information from all loaded classes. `sm` can only view the methods declared on the target class, that is, methods from its parent classes are invisible.
+
+
+### Options
+
+|Name|Specification|
+|---:|:---|
+|*class-pattern*|pattern for class name|
+|*method-pattern*|pattern for method name|
+|`[d]`|print the details of the method|
+|`[E]`|turn on regex matching while the default mode is wildcard matching|
+|`[c:]`|The hash code of the special class's classLoader|
+|`[n:]`|Maximum number of matching classes with details (100 by default)|
+
+### Usage
+
+* View methods of `java.lang.String`:
+
+`sm java.lang.String`{{execute T2}}
+
+```bash
+$ sm java.lang.String
+java.lang.String-><init>
+java.lang.String->equals
+java.lang.String->toString
+java.lang.String->hashCode
+java.lang.String->compareTo
+java.lang.String->indexOf
+java.lang.String->valueOf
+java.lang.String->checkBounds
+java.lang.String->length
+java.lang.String->isEmpty
+java.lang.String->charAt
+java.lang.String->codePointAt
+java.lang.String->codePointBefore
+java.lang.String->codePointCount
+java.lang.String->offsetByCodePoints
+java.lang.String->getChars
+java.lang.String->getBytes
+java.lang.String->contentEquals
+java.lang.String->nonSyncContentEquals
+java.lang.String->equalsIgnoreCase
+java.lang.String->compareToIgnoreCase
+java.lang.String->regionMatches
+java.lang.String->startsWith
+java.lang.String->endsWith
+java.lang.String->indexOfSupplementary
+java.lang.String->lastIndexOf
+java.lang.String->lastIndexOfSupplementary
+java.lang.String->substring
+java.lang.String->subSequence
+java.lang.String->concat
+java.lang.String->replace
+java.lang.String->matches
+java.lang.String->contains
+java.lang.String->replaceFirst
+java.lang.String->replaceAll
+java.lang.String->split
+java.lang.String->join
+java.lang.String->toLowerCase
+java.lang.String->toUpperCase
+java.lang.String->trim
+java.lang.String->toCharArray
+java.lang.String->format
+java.lang.String->copyValueOf
+java.lang.String->intern
+Affect(row-cnt:44) cost in 1342 ms.
+```
+
+* Specify ClassLoader
+
+Find ClassLoaderHash：
+
+`sc -d demo.MathGame | grep classLoaderHash`{{execute T2}}
+
+```bash
+$ sc -d demo.MathGame | grep classLoaderHash
+ classLoaderHash   70dea4e
+```
+
+Take a note of the classLoaderHash here:`70dea4e`, and use it to replace `<classLoaderHash>` and execute the following command.
+
+Find classloader's class methods
+
+`sc -c <classLoaderHash> -d demo.MathGame`
+
+```bash
+$ sm -c 70dea4e demo.MathGame
+demo.MathGame <init>()V
+demo.MathGame primeFactors(I)Ljava/util/List;
+demo.MathGame main([Ljava/lang/String;)V
+demo.MathGame run()V
+demo.MathGame print(ILjava/util/List;)V
+Affect(row-cnt:5) cost in 2 ms.
+```
+
+* View method `java.lang.String#toString` details:
+
+`sm -d java.lang.String toString`{{execute T2}}
+
+```bash
+$ sm -d java.lang.String toString
+ declaring-class  java.lang.String
+ method-name      toString
+ modifier         public
+ annotation
+ parameters
+ return           java.lang.String
+ exceptions
+
+Affect(row-cnt:1) cost in 3 ms.
+```