update doc

pull/483/head
hengyunabc 6 years ago
parent 340bc74754
commit 3d9e066080

@ -20,7 +20,7 @@ Arthas 用户文档
0. 是否有一个全局视角来查看系统的运行状况?
0. 有什么办法可以监控到JVM的实时运行状态
`Arthas`采用命令行交互模式,同时提供丰富的 `Tab` 自动补全功能,进一步方便进行问题的定位和诊断。
`Arthas`支持JDK 6+采用命令行交互模式,同时提供丰富的 `Tab` 自动补全功能,进一步方便进行问题的定位和诊断。
Contents

@ -19,10 +19,10 @@ curl -L https://alibaba.github.io/arthas/install.sh | sh
## Windows
最新版本:[![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)
最新版本,点击下载[![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`栏下载最新的 `bin.zip` 包,解压后在bin目录有 `as.bat`。此脚本暂时只接受一个参数 pid即只能诊断本机上的 Java 进程。欢迎精通bat脚本的开发者改进
下载解压后在bin目录有 `as.bat`。此脚本暂时只接受一个参数 pid即只能诊断本机上的 Java 进程。欢迎精通bat脚本的开发者改进
```
as.bat <pid>
@ -70,15 +70,13 @@ as.bat <pid>
3. attach成功之后使用telnet连接
```bash
telnet localhost 3658
telnet 127.0.0.1 3658
```
## 离线帮助文档
最新版本:[![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)
在`Download`栏下载最新的 `doc.zip` 包,
最新版本,点击下载:[![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)
## 卸载
@ -87,7 +85,7 @@ as.bat <pid>
删除下面文件:
```bash
rm -rf ~/.arthas/ ~/.arthas_history
rm -rf ~/.arthas/
```
* Windows平台直接删除zip包和解压的文件

@ -3,9 +3,8 @@
1. 下载最新版本
**最新版本**[![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)
**最新版本,点击下载**[![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`栏下载最新的 `bin.zip` 包。
如果下载速度比较慢,可以尝试用[阿里云的镜像仓库](https://maven.aliyun.com/),比如要下载`3.x.x`版本(替换`3.x.x`为最新版本下载的url是

@ -1,7 +1,7 @@
Web Console
===
Arthas目前支持Web Console用户在attach成功之后可以直接访问[http://localhost:8563/](http://localhost:8563/)。
Arthas目前支持Web Console用户在attach成功之后可以直接访问[http://127.0.0.1:8563/](http://127.0.0.1:8563/)。
可以填入IP远程连接其它机器上的arthas。

@ -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)

@ -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.

@ -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,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.

@ -188,11 +188,11 @@
<li>Monitor system metrics, thread states and CPU usage, GC statistics and etc.</li>
<li>Supports command line interactive mode, with auto-complete feature enabled.</li>
<li>Supports telnet and WebSocket, which enables both local and remote diagnostics with command line and browsers.</li>
<li>Supports JDK 6+</li>
</ul>
</div>
<div class="section" id="contents">
<span id="contents"></span><h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<p>English version has just been finished. If you would like to make it better, please check <a class="reference external" href="https://github.com/alibaba/arthas/issues/51">here</a> and submit your pull request.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</a></li>

@ -184,8 +184,8 @@
</div>
<div class="section" id="windows">
<span id="windows"></span><h2>Windows<a class="headerlink" href="#windows" title="Permalink to this headline"></a></h2>
<p>Latest Version: <a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>Download the latest <code class="docutils literal notranslate"><span class="pre">bin.zip</span></code>, unzip the package, and find <code class="docutils literal notranslate"><span class="pre">as.bat</span></code> from bin directory. For now this script will only take one argument <code class="docutils literal notranslate"><span class="pre">pid</span></code>, which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)</p>
<p>Latest Version, Click To Download: <a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=bin&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>Download and unzip, then find <code class="docutils literal notranslate"><span class="pre">as.bat</span></code> from bin directory. For now this script will only take one argument <code class="docutils literal notranslate"><span class="pre">pid</span></code>, which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>as.bat &lt;pid&gt;
</pre></div>
</div>
@ -227,7 +227,7 @@
<p>You can find the logs from <code class="docutils literal notranslate"><span class="pre">~/logs/arthas/arthas.log</span></code>.</p>
</li>
<li><p class="first">Use telnet to connect once attaching to the target JVM (in step 2) succeeds</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>telnet localhost <span class="m">3658</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>telnet <span class="m">127</span>.0.0.1 <span class="m">3658</span>
</pre></div>
</div>
</li>
@ -235,14 +235,13 @@
</div>
<div class="section" id="offline-help-documentation">
<span id="offline-help-documentation"></span><h2>Offline Help Documentation<a class="headerlink" href="#offline-help-documentation" title="Permalink to this headline"></a></h2>
<p>Latest Version:<a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>Download the latest <code class="docutils literal notranslate"><span class="pre">doc.zip</span></code>.</p>
<p>Latest Version, Click To Download:<a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=doc&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
</div>
<div class="section" id="uninstall">
<span id="uninstall"></span><h2>Uninstall<a class="headerlink" href="#uninstall" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">On Linux/Unix/Mac, delete the files with the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm -rf ~/.arthas/ ~/.arthas_history
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm -rf ~/.arthas/
</pre></div>
</div>
</li>

@ -166,7 +166,7 @@
<span id="manually-install-arthas"></span><h1>Manually Install Arthas<a class="headerlink" href="#manually-install-arthas" title="Permalink to this headline"></a></h1>
<ol>
<li><p class="first">Download the latest version</p>
<p><strong>Latest version</strong>: <a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p><strong>Latest version, Click To Download</strong>: <a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=bin&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>If the download speed is slow, try to use <a class="reference external" href="https://maven.aliyun.com/">Ali cloud mirror repository</a>, for example, to download version <code class="docutils literal notranslate"><span class="pre">3.x.x</span></code> (you can replace <code class="docutils literal notranslate"><span class="pre">3.x.x</span></code> 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</p>
</li>
<li><p class="first">Unzip zip file</p>

File diff suppressed because one or more lines are too long

@ -182,7 +182,7 @@
<div class="section" id="web-console">
<span id="web-console"></span><h1>Web Console<a class="headerlink" href="#web-console" title="Permalink to this headline"></a></h1>
<p>Arthas supports the Web Console. After attach success, the user can access: <a class="reference external" href="http://localhost:8563/">http://localhost:8563/</a>.</p>
<p>Arthas supports the Web Console. After attach success, the user can access: <a class="reference external" href="http://127.0.0.1:8563/">http://127.0.0.1:8563/</a>.</p>
<p>The user can fill in the IP and connect the remote arthas on other machines.</p>
<p><img alt="web console" src="_images/web-console-local.png" /></p>
<p>If you have suggestions for the Web Console, please leave a message here: <a class="reference external" href="https://github.com/alibaba/arthas/issues/15">https://github.com/alibaba/arthas/issues/15</a></p>

@ -181,7 +181,7 @@
<li>是否有一个全局视角来查看系统的运行状况?</li>
<li>有什么办法可以监控到JVM的实时运行状态</li>
</ol>
<p><code class="docutils literal notranslate"><span class="pre">Arthas</span></code>采用命令行交互模式,同时提供丰富的 <code class="docutils literal notranslate"><span class="pre">Tab</span></code> 自动补全功能,进一步方便进行问题的定位和诊断。</p>
<p><code class="docutils literal notranslate"><span class="pre">Arthas</span></code>支持JDK 6+采用命令行交互模式,同时提供丰富的 <code class="docutils literal notranslate"><span class="pre">Tab</span></code> 自动补全功能,进一步方便进行问题的定位和诊断。</p>
</div>
<div class="section" id="contents">
<span id="contents"></span><h2>Contents<a class="headerlink" href="#contents" title="永久链接至标题"></a></h2>

@ -187,8 +187,8 @@
</div>
<div class="section" id="windows">
<span id="windows"></span><h2>Windows<a class="headerlink" href="#windows" title="永久链接至标题"></a></h2>
<p>最新版本:<a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p><code class="docutils literal notranslate"><span class="pre">Download</span></code>下载最新的 <code class="docutils literal notranslate"><span class="pre">bin.zip</span></code> 包,解压后在bin目录有 <code class="docutils literal notranslate"><span class="pre">as.bat</span></code>。此脚本暂时只接受一个参数 pid即只能诊断本机上的 Java 进程。欢迎精通bat脚本的开发者改进</p>
<p>最新版本,点击下载<a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=bin&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>下载解压后在bin目录有 <code class="docutils literal notranslate"><span class="pre">as.bat</span></code>。此脚本暂时只接受一个参数 pid即只能诊断本机上的 Java 进程。欢迎精通bat脚本的开发者改进</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">as</span><span class="o">.</span><span class="n">bat</span> <span class="o">&lt;</span><span class="n">pid</span><span class="o">&gt;</span>
</pre></div>
</div>
@ -229,7 +229,7 @@
<p>启动目志输出在<code class="docutils literal notranslate"><span class="pre">~/logs/arthas/arthas.log</span></code>里。</p>
</li>
<li><p class="first">attach成功之后使用telnet连接</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>telnet localhost <span class="m">3658</span>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>telnet <span class="m">127</span>.0.0.1 <span class="m">3658</span>
</pre></div>
</div>
</li>
@ -237,15 +237,14 @@
</div>
<div class="section" id="">
<span id="id3"></span><h2>离线帮助文档<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<p>最新版本:<a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p><code class="docutils literal notranslate"><span class="pre">Download</span></code>栏下载最新的 <code class="docutils literal notranslate"><span class="pre">doc.zip</span></code> 包,</p>
<p>最新版本,点击下载:<a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=doc&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
</div>
<div class="section" id="">
<span id="id4"></span><h2>卸载<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<ul>
<li><p class="first">在 Linux/Unix/Mac 平台</p>
<p>删除下面文件:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm -rf ~/.arthas/ ~/.arthas_history
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm -rf ~/.arthas/
</pre></div>
</div>
</li>

@ -167,8 +167,7 @@
<span id="arthas"></span><h1>手动安装Arthas<a class="headerlink" href="#arthas" title="永久链接至标题"></a></h1>
<ol>
<li><p class="first">下载最新版本</p>
<p><strong>最新版本</strong><a class="reference external" href="http://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22com.taobao.arthas%22%20AND%20a%3A%22arthas-packaging%22"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p><code class="docutils literal notranslate"><span class="pre">Download</span></code>栏下载最新的 <code class="docutils literal notranslate"><span class="pre">bin.zip</span></code> 包。</p>
<p><strong>最新版本,点击下载</strong><a class="reference external" href="http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&amp;g=com.taobao.arthas&amp;a=arthas-packaging&amp;e=zip&amp;c=bin&amp;v=LATEST"><img alt="Arthas" src="https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" /></a></p>
<p>如果下载速度比较慢,可以尝试用<a class="reference external" href="https://maven.aliyun.com/">阿里云的镜像仓库</a>,比如要下载<code class="docutils literal notranslate"><span class="pre">3.x.x</span></code>版本(替换<code class="docutils literal notranslate"><span class="pre">3.x.x</span></code>为最新版本下载的url是</p>
<p>https://maven.aliyun.com/repository/public/com/taobao/arthas/arthas-packaging/3.x.x/arthas-packaging-3.x.x-bin.zip</p>
</li>

File diff suppressed because one or more lines are too long

@ -183,7 +183,7 @@
<div class="section" id="web-console">
<span id="web-console"></span><h1>Web Console<a class="headerlink" href="#web-console" title="永久链接至标题"></a></h1>
<p>Arthas目前支持Web Console用户在attach成功之后可以直接访问<a class="reference external" href="http://localhost:8563/">http://localhost:8563/</a></p>
<p>Arthas目前支持Web Console用户在attach成功之后可以直接访问<a class="reference external" href="http://127.0.0.1:8563/">http://127.0.0.1:8563/</a></p>
<p>可以填入IP远程连接其它机器上的arthas。</p>
<p><img alt="web console" src="_images/web-console-local.png" /></p>
<p>后续更多Web Console功能支持请到issue下留言<a class="reference external" href="https://github.com/alibaba/arthas/issues/15">https://github.com/alibaba/arthas/issues/15</a></p>

Loading…
Cancel
Save