github/arthas
4
0
Fork 0
mirror of https://github.com/alibaba/arthas.git synced 2024-04-21 10:21:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
hengyunabc
2018-12-15 00:13:53 +08:00
parent 20f2d54678
commit 1704abcace
10 changed files with 64 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_sources/install-detail.md.txt
+14 -11
View File
@@ -8,24 +8,26 @@ Arthas Install
下载`arthas-boot.jar`，然后用`java -jar`的方式启动：
```bash
$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
```
打印帮助信息：
```bash
$ java -jar arthas-boot.jar -h
java -jar arthas-boot.jar -h
```
* 如果下载速度比较慢，可以使用aliyun的镜像：
`java -jar arthas-boot.jar --repo-mirror aliyun --use-http`
```bash
java -jar arthas-boot.jar --repo-mirror aliyun --use-http
```
* 如果从github下载有问题，可以使用gitee镜像
```bash
$ wget https://arthas.gitee.io/arthas-boot.jar
wget https://arthas.gitee.io/arthas-boot.jar
```
@@ -34,7 +36,7 @@ $ java -jar arthas-boot.jar -h
Arthas 支持在 Linux/Unix/Mac 等平台上一键安装，请复制以下内容，并粘贴到命令行中，敲 `回车` 执行即可：
```bash
$ curl -L https://alibaba.github.io/arthas/install.sh | sh
curl -L https://alibaba.github.io/arthas/install.sh | sh
```
上述命令会下载启动脚本文件 `as.sh` 到当前目录，你可以放在任何地方或将其加入到 `$PATH` 中。
@@ -46,7 +48,7 @@ $ curl -L https://alibaba.github.io/arthas/install.sh | sh
* 如果从github下载有问题，可以使用gitee镜像
```bash
$ curl -L https://arthas.gitee.io/install.sh | sh
curl -L https://arthas.gitee.io/install.sh | sh
```
## 全量安装
@@ -56,13 +58,13 @@ $ curl -L https://alibaba.github.io/arthas/install.sh | sh
解压后，在文件夹里有`arthas-boot.jar`，直接用`java -jar`的方式启动：
```bash
$ java -jar arthas-boot.jar
java -jar arthas-boot.jar
```
打印帮助信息：
```bash
$ java -jar arthas-boot.jar -h
java -jar arthas-boot.jar -h
```
@@ -80,7 +82,8 @@ $ java -jar arthas-boot.jar -h
删除下面文件：
```bash
$ rm -rf ~/.arthas/
rm -rf ~/.arthas/
rm -rf ~/logs/arthas
```
* Windows平台直接删除user home下面的`.arthas`目录
* Windows平台直接删除user home下面的`.arthas`和`logs/arthas`目录
_sources/quick-start.md.txt
+4 -4
View File
@@ -4,8 +4,8 @@
## 1. 启动Demo
```bash
$ wget https://alibaba.github.io/arthas/arthas-demo.jar
$ java -jar arthas-demo.jar
wget https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar
```
`arthas-demo`是一个简单的程序，每隔一秒生成一个随机数，再执行质因式分解，并打印出分解结果。
@@ -18,8 +18,8 @@ $ java -jar arthas-demo.jar
在命令行下面执行：
```bash
$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
```
* 执行该程序的用户需要和目标进程具有相同的权限。比如以`admin`用户来执行：`sudo su admin && java -jar arthas-boot.jar` 或 `sudo -u admin -EH java -jar arthas-boot.jar`。
en/_sources/install-detail.md.txt
+9 -8
View File
@@ -9,14 +9,14 @@ Install Arthas
Download`arthas-boot.jar`，Start with `java` command:
```bash
$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
```
Print usage:
```bash
$ java -jar arthas-boot.jar -h
java -jar arthas-boot.jar -h
```
@@ -25,7 +25,7 @@ $ java -jar arthas-boot.jar -h
You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press *Enter* to run:
```bash
$ curl -L https://alibaba.github.io/arthas/install.sh | sh
curl -L https://alibaba.github.io/arthas/install.sh | sh
```
The command above will download the bootstrap script `as.sh` to the current directory. You can move it the any other place you want, or put its location in `$PATH`.
@@ -40,13 +40,13 @@ Latest Version, Click To Download: [![Arthas](https://img.shields.io/maven-centr
Download and unzip, find `arthas-boot.jar` in the directory. Start with `java` command:
```bash
$ java -jar arthas-boot.jar
java -jar arthas-boot.jar
```
Print usage:
```bash
$ java -jar arthas-boot.jar -h
java -jar arthas-boot.jar -h
```
## Manual Installation
@@ -64,7 +64,8 @@ Latest Version, Click To Download:[![Arthas](https://img.shields.io/maven-centra
* On Linux/Unix/Mac, delete the files with the following command:
```bash
$ rm -rf ~/.arthas/
rm -rf ~/.arthas/
rm -rf ~/logs/arthas/
```
* On Windows, delete `.arthas` directory under user home.
* On Windows, delete `.arthas` and `logs/arthas` directory under user home.
en/_sources/quick-start.md.txt
+4 -4
View File
@@ -4,8 +4,8 @@ Quick Start
## 1. Start Demo Application
```bash
$ wget https://alibaba.github.io/arthas/arthas-demo.jar
$ java -jar arthas-demo.jar
wget https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar
```
`arthas-demo` is a simple program that generates a random number every second, then find all prime factors of the number.
@@ -19,8 +19,8 @@ The source code of `arthas-demo`: [View](https://github.com/alibaba/arthas/blob/
Execute the following command in the command line:
```bash
$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
```
* The user to run this command *MUST* have the same privilege as the owner of the target process, as a simple example you can try the following command if the target process is managed by user `admin`: `sudo su admin && java -jar arthas-boot.jar` or `sudo -u admin -EH java -jar arthas-boot.jar`
en/install-detail.html
+9 -8
View File
@@ -183,19 +183,19 @@
<div class="section" id="use-arthas-boot-recommend">
<span id="use-arthas-boot-recommend"></span><h3>Use <tt class="docutils literal">arthas-boot</tt>(Recommend)<a class="headerlink" href="#use-arthas-boot-recommend" title="Permalink to this headline"></a></h3>
<p>Download<tt class="docutils literal">arthas-boot.jar</tt>，Start with <tt class="docutils literal">java</tt> command:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
</pre></div>
</div>
<p>Print usage:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar -h
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar -h
</pre></div>
</div>
</div>
<div class="section" id="use-as-sh">
<span id="use-as-sh"></span><h3>Use <tt class="docutils literal">as.sh</tt><a class="headerlink" href="#use-as-sh" title="Permalink to this headline"></a></h3>
<p>You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press <em>Enter</em> to run:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ curl -L https://alibaba.github.io/arthas/install.sh | sh
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">curl -L https://alibaba.github.io/arthas/install.sh | sh
</pre></div>
</div>
<p>The command above will download the bootstrap script <tt class="docutils literal">as.sh</tt> to the current directory. You can move it the any other place you want, or put its location in <tt class="docutils literal">$PATH</tt>.</p>
@@ -206,11 +206,11 @@ $ java -jar arthas-boot.jar
<span id="full-installation"></span><h2>Full installation<a class="headerlink" href="#full-installation" title="Permalink to this headline"></a></h2>
<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, find <tt class="docutils literal">arthas-boot.jar</tt> in the directory. Start with <tt class="docutils literal">java</tt> command:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar
</pre></div>
</div>
<p>Print usage:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar -h
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar -h
</pre></div>
</div>
</div>
@@ -226,11 +226,12 @@ $ java -jar arthas-boot.jar
<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 hljs"><pre class="bash">$ rm -rf ~/.arthas/
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">rm -rf ~/.arthas/
rm -rf ~/logs/arthas/
</pre></div>
</div>
</li>
<li><p class="first">On Windows, delete <tt class="docutils literal">.arthas</tt> directory under user home.</p>
<li><p class="first">On Windows, delete <tt class="docutils literal">.arthas</tt> and <tt class="docutils literal">logs/arthas</tt> directory under user home.</p>
</li>
</ul>
</div>
en/quick-start.html
+4 -4
View File
@@ -181,8 +181,8 @@
<span id="quick-start"></span><h1>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline"></a></h1>
<div class="section" id="start-demo-application">
<span id="start-demo-application"></span><h2>1. Start Demo Application<a class="headerlink" href="#start-demo-application" title="Permalink to this headline"></a></h2>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-demo.jar
$ java -jar arthas-demo.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar
</pre></div>
</div>
<p><tt class="docutils literal">arthas-demo</tt> is a simple program that generates a random number every second, then find all prime factors of the number.</p>
@@ -193,8 +193,8 @@ $ java -jar arthas-demo.jar
<div class="section" id="linux-unix-mac">
<span id="linux-unix-mac"></span><h3>Linux/Unix/Mac<a class="headerlink" href="#linux-unix-mac" title="Permalink to this headline"></a></h3>
<p>Execute the following command in the command line:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
</pre></div>
</div>
<ul class="simple">
en/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
install-detail.html
+14 -11
View File
@@ -185,20 +185,22 @@
<div class="section" id="arthas-boot">
<span id="arthas-boot"></span><h3>使用<tt class="docutils literal">arthas-boot</tt>（推荐）<a class="headerlink" href="#arthas-boot" title="永久链接至标题"></a></h3>
<p>下载<tt class="docutils literal">arthas-boot.jar</tt>，然后用<tt class="docutils literal">java -jar</tt>的方式启动：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
</pre></div>
</div>
<p>打印帮助信息：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar -h
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar -h
</pre></div>
</div>
<ul>
<li><p class="first">如果下载速度比较慢，可以使用aliyun的镜像：</p>
<p><tt class="docutils literal">java -jar arthas-boot.jar --repo-mirror aliyun --use-http</tt></p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar --repo-mirror aliyun --use-http
</pre></div>
</div>
</li>
<li><p class="first">如果从github下载有问题，可以使用gitee镜像</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://arthas.gitee.io/arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://arthas.gitee.io/arthas-boot.jar
</pre></div>
</div>
</li>
@@ -207,7 +209,7 @@ $ java -jar arthas-boot.jar
<div class="section" id="as-sh">
<span id="as-sh"></span><h3>使用<tt class="docutils literal">as.sh</tt><a class="headerlink" href="#as-sh" title="永久链接至标题"></a></h3>
<p>Arthas 支持在 Linux/Unix/Mac 等平台上一键安装，请复制以下内容，并粘贴到命令行中，敲 <tt class="docutils literal">回车</tt> 执行即可：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ curl -L https://alibaba.github.io/arthas/install.sh | sh
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">curl -L https://alibaba.github.io/arthas/install.sh | sh
</pre></div>
</div>
<p>上述命令会下载启动脚本文件 <tt class="docutils literal">as.sh</tt> 到当前目录，你可以放在任何地方或将其加入到 <tt class="docutils literal">$PATH</tt> 中。</p>
@@ -215,7 +217,7 @@ $ java -jar arthas-boot.jar
<p>也可以执行<tt class="docutils literal">./as.sh -h</tt>来获取更多参数信息。</p>
<ul>
<li><p class="first">如果从github下载有问题，可以使用gitee镜像</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ curl -L https://arthas.gitee.io/install.sh | sh
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">curl -L https://arthas.gitee.io/install.sh | sh
</pre></div>
</div>
</li>
@@ -226,11 +228,11 @@ $ java -jar arthas-boot.jar
<span id="id2"></span><h2>全量安装<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<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>解压后，在文件夹里有<tt class="docutils literal">arthas-boot.jar</tt>，直接用<tt class="docutils literal">java -jar</tt>的方式启动：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar
</pre></div>
</div>
<p>打印帮助信息：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ java -jar arthas-boot.jar -h
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">java -jar arthas-boot.jar -h
</pre></div>
</div>
</div>
@@ -247,11 +249,12 @@ $ java -jar arthas-boot.jar
<ul>
<li><p class="first">在 Linux/Unix/Mac 平台</p>
<p>删除下面文件：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ rm -rf ~/.arthas/
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">rm -rf ~/.arthas/
rm -rf ~/logs/arthas
</pre></div>
</div>
</li>
<li><p class="first">Windows平台直接删除user home下面的<tt class="docutils literal">.arthas</tt>目录</p>
<li><p class="first">Windows平台直接删除user home下面的<tt class="docutils literal">.arthas</tt>和<tt class="docutils literal">logs/arthas</tt>目录</p>
</li>
</ul>
</div>
quick-start.html
+4 -4
View File
@@ -180,8 +180,8 @@
<span id="id1"></span><h1>快速入门<a class="headerlink" href="#" title="永久链接至标题"></a></h1>
<div class="section" id="demo">
<span id="demo"></span><h2>1. 启动Demo<a class="headerlink" href="#demo" title="永久链接至标题"></a></h2>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-demo.jar
$ java -jar arthas-demo.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar
</pre></div>
</div>
<p><tt class="docutils literal">arthas-demo</tt>是一个简单的程序，每隔一秒生成一个随机数，再执行质因式分解，并打印出分解结果。</p>
@@ -190,8 +190,8 @@ $ java -jar arthas-demo.jar
<div class="section" id="arthas">
<span id="arthas"></span><h2>2. 启动arthas<a class="headerlink" href="#arthas" title="永久链接至标题"></a></h2>
<p>在命令行下面执行：</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ wget https://alibaba.github.io/arthas/arthas-boot.jar
$ java -jar arthas-boot.jar
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
</pre></div>
</div>
<ul class="simple">
searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long