mirror of
https://github.com/alibaba/arthas.git
synced 2026-10-23 06:59:15 +00:00
add help commmand scenario. #847
This commit is contained in:
hengyunabc
@@ -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 --target-ip 0.0.0.0`{{execute T2}}
|
||||
|
||||
`arthas-boot`是`Arthas`的启动程序，它启动后，会列出所有的Java进程，用户可以选择需要诊断的目标进程。
|
||||
|
||||
选择第一个进程，输入 `1`{{execute T2}} ，再`Enter/回车`：
|
||||
|
||||
Attach成功之后，会打印Arthas LOGO。输入 `help`{{execute T2}} 可以获取到更多的帮助信息。
|
||||
|
||||
|
||||
@@ -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`是一个很简单的程序，它随机生成整数，再执行因式分解，把结果打印出来。如果生成的随机数是负数，则会打印提示信息。
|
||||
@@ -0,0 +1,10 @@
|
||||
|
||||
通过本教程基本掌握了Arthas的用法。更多高级特性，可以在下面的进阶指南里继续了解。
|
||||
|
||||
* [Arthas进阶](https://alibaba.github.io/arthas/arthas-tutorials?language=cn&id=arthas-advanced)
|
||||
* [Arthas Github](https://github.com/alibaba/arthas)
|
||||
* [Arthas 文档](https://alibaba.github.io/arthas/)
|
||||
|
||||
欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
|
||||
|
||||
比如查看`sysprop`命令的帮助信息：
|
||||
|
||||
`help sysprop`{{execute T2}}
|
||||
|
||||
```bash
|
||||
[arthas@50759]$ help sysprop
|
||||
USAGE:
|
||||
sysprop [-h] [property-name] [property-value]
|
||||
|
||||
SUMMARY:
|
||||
Display, and change the system properties.
|
||||
|
||||
EXAMPLES:
|
||||
sysprop
|
||||
sysprop file.encoding
|
||||
sysprop production.mode true
|
||||
|
||||
WIKI:
|
||||
https://alibaba.github.io/arthas/sysprop
|
||||
|
||||
OPTIONS:
|
||||
-h, --help this help
|
||||
<property-name> property name
|
||||
<property-value> property value
|
||||
```
|
||||
|
||||
可以看到具体的命令的参数，示例和WKI地址。
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
`help`{{execute T2}} 命令可以查看所有命令的帮助信息。
|
||||
|
||||
```bash
|
||||
[arthas@50759]$ help
|
||||
NAME DESCRIPTION
|
||||
help Display Arthas Help
|
||||
keymap Display all the available keymap for the specified connection.
|
||||
sc Search all the classes loaded by JVM
|
||||
sm Search the method of classes loaded by JVM
|
||||
classloader Show classloader info
|
||||
jad Decompile class
|
||||
getstatic Show the static field of a class
|
||||
monitor Monitor method execution statistics, e.g. total/success/failure count, average rt, fail rate, etc.
|
||||
stack Display the stack trace for the specified class and method
|
||||
thread Display thread info, thread stack
|
||||
trace Trace the execution time of specified method invocation.
|
||||
watch Display the input/output parameter, return object, and thrown exception of specified method invocation
|
||||
...
|
||||
```
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"title": "Arthas Help命令教程",
|
||||
"description": "Arthas Help命令教程",
|
||||
"details": {
|
||||
"steps": [
|
||||
{
|
||||
"title": "启动arthas-demo",
|
||||
"text": "arthas-demo.md"
|
||||
},
|
||||
{
|
||||
"title": "启动arthas-boot",
|
||||
"text": "arthas-boot.md"
|
||||
},
|
||||
{
|
||||
"title": "help 命令",
|
||||
"text": "help.md"
|
||||
},
|
||||
{
|
||||
"title": "查看具休命令的help信息",
|
||||
"text": "help-sysprop.md"
|
||||
}
|
||||
],
|
||||
"intro": {
|
||||
"text": "intro.md"
|
||||
},
|
||||
"finish": {
|
||||
"text": "finish.md"
|
||||
}
|
||||
},
|
||||
"environment": {
|
||||
"uilayout": "terminal"
|
||||
},
|
||||
"backend": {
|
||||
"imageid": "java",
|
||||
"environmentsprotocol": "http"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
`Arthas` 是Alibaba开源的Java诊断工具，深受开发者喜爱。在线排查问题，无需重启；动态跟踪Java代码；实时监控JVM状态。
|
||||
|
||||
`Arthas` 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
|
||||
|
||||
* Github: https://github.com/alibaba/arthas
|
||||
* 文档: https://alibaba.github.io/arthas/
|
||||
@@ -0,0 +1,15 @@
|
||||
|
||||
|
||||
|
||||
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 --target-ip 0.0.0.0`{{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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
@@ -0,0 +1,6 @@
|
||||
|
||||
Through this tutorial, you can know how to use Arthas. More advanced features can be found in the Advanced Guide below.
|
||||
|
||||
* [Arthas Advanced](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-advanced)
|
||||
* [Arthas Github](https://github.com/alibaba/arthas)
|
||||
* [Arthas Documentation](https://alibaba.github.io/arthas/en)
|
||||
@@ -0,0 +1,30 @@
|
||||
|
||||
|
||||
For example, to view the help information for the command `sysprop`:
|
||||
|
||||
`help sysprop`{{execute T2}}
|
||||
|
||||
```bash
|
||||
[arthas@50759]$ help sysprop
|
||||
USAGE:
|
||||
sysprop [-h] [property-name] [property-value]
|
||||
|
||||
SUMMARY:
|
||||
Display, and change the system properties.
|
||||
|
||||
EXAMPLES:
|
||||
sysprop
|
||||
sysprop file.encoding
|
||||
sysprop production.mode true
|
||||
|
||||
WIKI:
|
||||
https://alibaba.github.io/arthas/sysprop
|
||||
|
||||
OPTIONS:
|
||||
-h, --help this help
|
||||
<property-name> property name
|
||||
<property-value> property value
|
||||
```
|
||||
|
||||
You can see the arguments, examples and WKI of specific commands.
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
The `help`{{execute T2}} command allows you to view help information for all commands.
|
||||
|
||||
```bash
|
||||
[arthas@50759]$ help
|
||||
NAME DESCRIPTION
|
||||
help Display Arthas Help
|
||||
keymap Display all the available keymap for the specified connection.
|
||||
sc Search all the classes loaded by JVM
|
||||
sm Search the method of classes loaded by JVM
|
||||
classloader Show classloader info
|
||||
jad Decompile class
|
||||
getstatic Show the static field of a class
|
||||
monitor Monitor method execution statistics, e.g. total/success/failure count, average rt, fail rate, etc.
|
||||
stack Display the stack trace for the specified class and method
|
||||
thread Display thread info, thread stack
|
||||
trace Trace the execution time of specified method invocation.
|
||||
watch Display the input/output parameter, return object, and thrown exception of specified method invocation
|
||||
...
|
||||
```
|
||||
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"title": "Arthas Basics",
|
||||
"description": "Arthas Basics",
|
||||
"details": {
|
||||
"steps": [
|
||||
{
|
||||
"title": "Start arthas-demo",
|
||||
"text": "arthas-demo.md"
|
||||
},
|
||||
{
|
||||
"title": "Start arthas-boot",
|
||||
"text": "arthas-boot.md"
|
||||
},
|
||||
{
|
||||
"title": "Help command",
|
||||
"text": "help.md"
|
||||
},
|
||||
{
|
||||
"title": "View the help information of a command",
|
||||
"text": "help-sysprop.md"
|
||||
}
|
||||
],
|
||||
"intro": {
|
||||
"text": "intro.md"
|
||||
},
|
||||
"finish": {
|
||||
"text": "finish.md"
|
||||
}
|
||||
},
|
||||
"environment": {
|
||||
"uilayout": "terminal"
|
||||
},
|
||||
"backend": {
|
||||
"imageid": "java",
|
||||
"environmentsprotocol": "http"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
`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.
|
||||
|
||||
* Github: https://github.com/alibaba/arthas
|
||||
* Documentation: https://alibaba.github.io/arthas/en
|
||||
Reference in New Issue
Block a user