update doc

This commit is contained in:
hengyunabc committed 2018-11-19 19:07:46 +08:00
1 parent 340bc74754
commit 3d9e066080
18 files changed
+34 -42

No files matched your search

+1 -2
View File
@@ -29,12 +29,11 @@ Arthas is built to solve these issues. A developer can troubleshoot production i
* 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 JDK 6+
Contents
--------
English version has just been finished. If you would like to make it better, please check [here](https://github.com/alibaba/arthas/issues/51) and submit your pull request.
* [Installation](install-detail.md)
* [Quick start](quick-start.md)
* [Advanced usage](advanced-use.md)
+5 -6
View File
@@ -15,9 +15,9 @@ You can enter its interactive interface by executing `as.sh`, or execute `as.sh
## Windows
Latest Version: [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22)
Latest Version, Click To Download: [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST)
Download the latest `bin.zip`, unzip the package, and find `as.bat` from 'bin' directory. For now this script will only take one argument `pid`, which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)
Download and unzip, then find `as.bat` from 'bin' directory. For now this script will only take one argument `pid`, which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)
```bash
as.bat <pid>
@@ -68,21 +68,20 @@ If you fail to boot Arthas with the provided batch file, you could try to assemb
3. Use telnet to connect once attaching to the target JVM (in step 2) succeeds
```bash
telnet localhost 3658
telnet 127.0.0.1 3658
```
## Offline Help Documentation
Latest Version:[![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22)
Latest Version, Click To Download:[![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=doc&v=LATEST)
Download the latest `doc.zip`.
## Uninstall
* On Linux/Unix/Mac, delete the files with the following command:
```bash
rm -rf ~/.arthas/ ~/.arthas_history
rm -rf ~/.arthas/
```
* On Windows, simply delete the zip file and unzipped files.
+1 -1
View File
@@ -3,7 +3,7 @@ Manually Install Arthas
1. Download the latest version
**Latest version**: [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22)
**Latest version, Click To Download**: [![Arthas](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST)
If the download speed is slow, try to use [Ali cloud mirror repository](https://maven.aliyun.com/), for example, to download version `3.x.x` (you can replace `3.x.x` in the example URL if you want to download other version), the download URL is: https://maven.aliyun.com/repository/public/com/taobao/arthas/arthas-packaging/3.x.x/arthas-packaging-3.x.x-bin.zip
+1 -1
View File
@@ -1,7 +1,7 @@
Web Console
===
Arthas supports the Web Console. After attach success, the user can access: [http://localhost:8563/](http://localhost:8563/).
Arthas supports the Web Console. After attach success, the user can access: [http://127.0.0.1:8563/](http://127.0.0.1:8563/).
The user can fill in the IP and connect the remote arthas on other machines.