add stack command scenario. #847 (#1380)

site/src/site/sphinx/en/stack.md

@@ -1,6 +1,8 @@
 stack
 =====
 
+[`stack` online tutorial](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=command-stack)
+
 > Print out the full call stack of the current method.
 
 Most often we know one method gets called, but we have no idea on which code path gets executed or when the method gets called since there are so many code paths to the target method. The command `stack` comes to rescue in this difficult situation.

site/src/site/sphinx/stack.md

@@ -1,6 +1,8 @@
 stack
 ===
 
+[`stack`在线教程](https://alibaba.github.io/arthas/arthas-tutorials?language=cn&id=command-stack)
+
 > 输出当前方法被调用的调用路径
 
 很多时候我们都知道一个方法被执行，但这个方法被执行的路径非常多，或者你根本就不知道这个方法是从那里被执行了，此时你需要的是 stack 命令。

tutorials/katacoda/command-stack-cn/arthas-boot.md

@@ -0,0 +1,16 @@
+
+
+
+
+在新的`Terminal 2`里，下载`arthas-boot.jar`，再用`java -jar`命令启动：
+
+`wget https://alibaba.github.io/arthas/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)

tutorials/katacoda/command-stack-cn/arthas-demo.md

@@ -0,0 +1,10 @@
+
+
+
+
+下载`arthas-demo.jar`，再用`java -jar`命令启动：
+
+`wget https://alibaba.github.io/arthas/arthas-demo.jar
+java -jar arthas-demo.jar`{{execute T1}}
+
+`arthas-demo`是一个很简单的程序，它随机生成整数，再执行因式分解，把结果打印出来。如果生成的随机数是负数，则会打印提示信息。

tutorials/katacoda/command-stack-cn/finish.md

@@ -0,0 +1,12 @@
+
+在“stack”中，我们演示了了Arthas的stack命令。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
+
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://alibaba.github.io/arthas
+
+
+如果您在使用Arthas，请让我们知道，您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+
+![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)

tutorials/katacoda/command-stack-cn/index.json

@@ -0,0 +1,35 @@
+{
+  "title": "Arthas stack命令",
+  "description": "Arthas stack命令",
+  "difficulty": "精通者",
+  "time": "10-20 分钟",
+  "details": {
+    "steps": [
+      {
+        "title": "启动arthas demo",
+        "text": "arthas-demo.md"
+      },
+      {
+        "title": "启动arthas-boot",
+        "text": "arthas-boot.md"
+      },
+      {
+        "title": "stack命令",
+        "text": "stack.md"
+      }
+    ],
+    "intro": {
+      "text": "intro.md"
+    },
+    "finish": {
+      "text": "finish.md"
+    }
+  },
+  "environment": {
+    "uilayout": "terminal"
+  },
+  "backend": {
+    "imageid": "java",
+    "environmentsprotocol": "http"
+  }
+}

tutorials/katacoda/command-stack-cn/intro.md

@@ -0,0 +1,23 @@
+
+
+
+![Arthas](https://alibaba.github.io/arthas/_images/arthas.png)
+
+`Arthas` 是Alibaba开源的Java诊断工具，深受开发者喜爱。在线排查问题，无需重启；动态跟踪Java代码；实时监控JVM状态。
+
+`Arthas` 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
+
+当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：
+
+- 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
+- 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
+- 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
+- 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
+- 是否有一个全局视角来查看系统的运行状况？
+- 有什么办法可以监控到JVM的实时运行状态？
+- 怎么快速定位应用的热点，生成火焰图？
+
+本教程会以一个简单的应用为例，演示stack命令。
+
+* Github: https://github.com/alibaba/arthas
+* 文档: https://alibaba.github.io/arthas/

tutorials/katacoda/command-stack-cn/stack.md

@@ -0,0 +1,70 @@
+
+> 输出当前方法被调用的调用路径
+
+很多时候我们都知道一个方法被执行，但这个方法被执行的路径非常多，或者你根本就不知道这个方法是从那里被执行了，此时你需要的是 stack 命令。
+
+### 参数说明
+
+|参数名称|参数说明|
+|---:|:---|
+|*class-pattern*|类名表达式匹配|
+|*method-pattern*|方法名表达式匹配|
+|*condition-express*|条件表达式|
+|[E]|开启正则表达式匹配，默认为通配符匹配|
+|`[n:]`|执行次数限制|
+
+这里重点要说明的是观察表达式，观察表达式的构成主要由 ognl 表达式组成，所以你可以这样写`"{params,returnObj}"`，只要是一个合法的 ognl 表达式，都能被正常支持。
+
+观察的维度也比较多，主要体现在参数 `advice` 的数据结构上。`Advice` 参数最主要是封装了通知节点的所有信息。
+
+* 特殊用法请参考：[https://github.com/alibaba/arthas/issues/71](https://github.com/alibaba/arthas/issues/71)
+* OGNL表达式官网：[https://commons.apache.org/proper/commons-ognl/language-guide.html](https://commons.apache.org/proper/commons-ognl/language-guide.html)
+
+### 使用例子
+
+#### stack
+
+`stack demo.MathGame primeFactors`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 36 ms.
+ts=2018-12-04 01:32:19;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+```
+
+#### 据条件表达式来过滤
+
+`stack demo.MathGame primeFactors 'params[0]<0' -n 2`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors 'params[0]<0' -n 2
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 30 ms.
+ts=2018-12-04 01:34:27;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+
+ts=2018-12-04 01:34:30;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+
+Command execution times exceed limit: 2, so command will exit. You can set it with -n option.
+```
+
+
+#### 据执行时间来过滤
+
+`stack demo.MathGame primeFactors '#cost>5'`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors '#cost>5'
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 35 ms.
+ts=2018-12-04 01:35:58;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+```
+

tutorials/katacoda/command-stack-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://alibaba.github.io/arthas/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)

tutorials/katacoda/command-stack-en/arthas-demo.md

@@ -0,0 +1,11 @@
+
+
+
+
+Download `arthas-demo.jar` and start with the `java -jar` command:
+
+`wget https://alibaba.github.io/arthas/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.

tutorials/katacoda/command-stack-en/finish.md

@@ -0,0 +1,8 @@
+
+The `stack Tutorial` demonstrates the usage of stack. If you have more tips or questions, please feel free to ask in Issue.
+
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://alibaba.github.io/arthas
+
+
+If you are using Arthas, please let us know. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)

tutorials/katacoda/command-stack-en/index.json

@@ -0,0 +1,35 @@
+{
+  "title": "Arthas stack Command",
+  "description": "Arthas stack 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": "stack Command",
+        "text": "stack.md"
+      }
+    ],
+    "intro": {
+      "text": "intro.md"
+    },
+    "finish": {
+      "text": "finish.md"
+    }
+  },
+  "environment": {
+    "uilayout": "terminal"
+  },
+  "backend": {
+    "imageid": "java",
+    "environmentsprotocol": "http"
+  }
+}

tutorials/katacoda/command-stack-en/intro.md

@@ -0,0 +1,40 @@
+
+
+
+![Arthas](https://alibaba.github.io/arthas/_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 stack.
+
+* Github: https://github.com/alibaba/arthas
+* Docs: https://alibaba.github.io/arthas/
+

tutorials/katacoda/command-stack-en/stack.md

@@ -0,0 +1,71 @@
+
+> Print out the full call stack of the current method.
+
+Most often we know one method gets called, but we have no idea on which code path gets executed or when the method gets called since there are so many code paths to the target method. The command `stack` comes to rescue in this difficult situation.
+
+### Parameters
+
+|Name|Specification|
+|---:|:---|
+|*class-pattern*|pattern for the class name|
+|*method-pattern*|pattern for the method name|
+|*condition-expression*|condition expression|
+|`[E]`|turn on regex match, the default behavior is wildcard match|
+|`[n:]`|execution times|
+
+There's one thing worthy noting here is observation expression. The observation expression supports OGNL grammar, for example, you can come up a expression like this `"{params,returnObj}"`. All OGNL expressions are supported as long as they are legal to the grammar.
+
+Thanks for `advice`'s data structure, it is possible to observe from varieties of different angles. Inside `advice` parameter, all necessary information for notification can be found.
+
+* Pls. also refer to [https://github.com/alibaba/arthas/issues/71](https://github.com/alibaba/arthas/issues/71) for more advanced usage
+* OGNL official site: [https://commons.apache.org/proper/commons-ognl/language-guide.html](https://commons.apache.org/proper/commons-ognl/language-guide.html)
+
+### Usage
+
+#### stack
+
+`stack demo.MathGame primeFactors`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 36 ms.
+ts=2018-12-04 01:32:19;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+```
+
+#### Filtering by condition expression
+
+`stack demo.MathGame primeFactors 'params[0]<0' -n 2`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors 'params[0]<0' -n 2
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 30 ms.
+ts=2018-12-04 01:34:27;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+
+ts=2018-12-04 01:34:30;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+
+Command execution times exceed limit: 2, so command will exit. You can set it with -n option.
+```
+
+
+#### Filtering by cost
+
+`stack demo.MathGame primeFactors '#cost>5'`{{execute T2}}
+
+```bash
+$ stack demo.MathGame primeFactors '#cost>5'
+Press Ctrl+C to abort.
+Affect(class-cnt:1 , method-cnt:1) cost in 35 ms.
+ts=2018-12-04 01:35:58;thread_name=main;id=1;is_daemon=false;priority=5;TCCL=sun.misc.Launcher$AppClassLoader@3d4eac69
+    @demo.MathGame.run()
+        at demo.MathGame.main(MathGame.java:16)
+```
+
+