update doc

pull/483/head
hengyunabc 6 years ago
parent da1a84a619
commit f8e71fd563

@ -10,7 +10,7 @@ Arthas 支持在 Linux/Unix/Mac 等平台上一键安装,请复制以下内容
curl -L https://alibaba.github.io/arthas/install.sh | sh curl -L https://alibaba.github.io/arthas/install.sh | sh
``` ```
上述命令将会下载的启动脚本文件 `as.sh` 到当前目录,你可以放在任何地方或将其加入到 $PATH 中。 上述命令将会下载的启动脚本文件 `as.sh` 到当前目录,你可以放在任何地方或将其加入到 `$PATH` 中。
直接在shell下面执行`./as.sh`,就会进入交互界面。 直接在shell下面执行`./as.sh`,就会进入交互界面。
@ -28,7 +28,7 @@ curl -L https://alibaba.github.io/arthas/install.sh | sh
as.bat pid as.bat pid
``` ```
如果需要更好的体验,可以在本地使用 `as.bat pid` 启动 Arthas Server 后,然后在另外的 Linux/Mac 上使用 as.bat pid@ip:port 来远程诊断。 如果需要更好的体验,可以在本地使用 `as.bat pid` 启动 Arthas Server 后,然后在另外的 Linux/Mac 上使用 `as.sh pid@ip:port` 来远程诊断。
> Windows用户如果在cmd里不能正常显示颜色可以使用[conemu](https://sourceforge.net/projects/conemu)。 > Windows用户如果在cmd里不能正常显示颜色可以使用[conemu](https://sourceforge.net/projects/conemu)。
@ -37,6 +37,42 @@ as.bat pid
[手动安装](manual-install.md) [手动安装](manual-install.md)
## 手动拼接命令行启动
如果启动遇到问题,可以尝试手动拼接出命令行参数来启动。
1. 查找目录jvm的java文件路径。
在linux/mac上执行`ps aux | grep java`在windows上可以通过进程管理器来查看。假设是`/opt/jdk1.8/bin/java`。
2. 拼接出命令行
```bash
/opt/jdk1.8/bin/java -Xbootclasspath/a:/opt/jdk1.8/lib/tools.jar \
-jar /tmp/arthas-packaging/arthas-core.jar \
-pid 15146 \
-target-ip 127.0.0.1 -telnet-port 3658 -http-port 8563 \
-core /tmp/arthas-packaging/arthas-core.jar \
-agent /tmp/arthas-packaging/arthas/arthas-agent.jar
```
命令行分几部分组成:
* `-Xbootclasspath` 增加tools.jar
* `-jar /tmp/arthas-packaging/arthas-core.jar` 指定main函数入口
* `-pid 15146` 指定目标java进程ID
* `-target-ip 127.0.0.1` 指定IP
* `-telnet-port 3658 -http-port 8563` 指定telnet和http端口
* `-core /tmp/arthas-packaging/arthas-core.jar -agent /tmp/arthas-packaging/arthas/arthas-agent.jar` 指定core/agent jar包
如果是`jdk > 9`即9/10/11以上的版本不需要指定`tools.jar`,直接去掉`-Xbootclasspath` 的配置即可。
启动目志输出在`~/logs/arthas/arthas.log`里。
3. attach成功之后使用telnet连接
```bash
telnet localhost 3658
```
## 离线帮助文档 ## 离线帮助文档

@ -93,6 +93,7 @@
<li class="toctree-l2"><a class="reference internal" href="#linux-unix-mac">Linux/Unix/Mac</a></li> <li class="toctree-l2"><a class="reference internal" href="#linux-unix-mac">Linux/Unix/Mac</a></li>
<li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a></li> <li class="toctree-l2"><a class="reference internal" href="#windows">Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="#">手动安装</a></li> <li class="toctree-l2"><a class="reference internal" href="#">手动安装</a></li>
<li class="toctree-l2"><a class="reference internal" href="#">手动拼接命令行启动</a></li>
<li class="toctree-l2"><a class="reference internal" href="#">离线帮助文档</a></li> <li class="toctree-l2"><a class="reference internal" href="#">离线帮助文档</a></li>
<li class="toctree-l2"><a class="reference internal" href="#">卸载</a></li> <li class="toctree-l2"><a class="reference internal" href="#">卸载</a></li>
</ul> </ul>
@ -179,7 +180,7 @@
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl -L https://alibaba.github.io/arthas/install.sh <span class="p">|</span> sh <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl -L https://alibaba.github.io/arthas/install.sh <span class="p">|</span> sh
</pre></div> </pre></div>
</div> </div>
<p>上述命令将会下载的启动脚本文件 <code class="docutils literal notranslate"><span class="pre">as.sh</span></code> 到当前目录,你可以放在任何地方或将其加入到 $PATH 中。</p> <p>上述命令将会下载的启动脚本文件 <code class="docutils literal notranslate"><span class="pre">as.sh</span></code> 到当前目录,你可以放在任何地方或将其加入到 <code class="docutils literal notranslate"><span class="pre">$PATH</span></code> 中。</p>
<p>直接在shell下面执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span></code>,就会进入交互界面。</p> <p>直接在shell下面执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span></code>,就会进入交互界面。</p>
<p>也可以执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span> <span class="pre">-h</span></code>来获取更多参数信息。</p> <p>也可以执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span> <span class="pre">-h</span></code>来获取更多参数信息。</p>
</div> </div>
@ -190,7 +191,7 @@
<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="n">pid</span> <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="n">pid</span>
</pre></div> </pre></div>
</div> </div>
<p>如果需要更好的体验,可以在本地使用 <code class="docutils literal notranslate"><span class="pre">as.bat</span> <span class="pre">pid</span></code> 启动 Arthas Server 后,然后在另外的 Linux/Mac 上使用 as.bat pid&#64;ip:port 来远程诊断。</p> <p>如果需要更好的体验,可以在本地使用 <code class="docutils literal notranslate"><span class="pre">as.bat</span> <span class="pre">pid</span></code> 启动 Arthas Server 后,然后在另外的 Linux/Mac 上使用 <code class="docutils literal notranslate"><span class="pre">as.sh</span> <span class="pre">pid&#64;ip:port</span></code> 来远程诊断。</p>
<blockquote> <blockquote>
<div>Windows用户如果在cmd里不能正常显示颜色可以使用<a class="reference external" href="https://sourceforge.net/projects/conemu">conemu</a></div></blockquote> <div>Windows用户如果在cmd里不能正常显示颜色可以使用<a class="reference external" href="https://sourceforge.net/projects/conemu">conemu</a></div></blockquote>
</div> </div>
@ -199,12 +200,47 @@
<p><a class="reference internal" href="manual-install.html"><span class="doc">手动安装</span></a></p> <p><a class="reference internal" href="manual-install.html"><span class="doc">手动安装</span></a></p>
</div> </div>
<div class="section" id=""> <div class="section" id="">
<span id="id2"></span><h2>离线帮助文档<a class="headerlink" href="#" title="永久链接至标题"></a></h2> <span id="id2"></span><h2>手动拼接命令行启动<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<p>如果启动遇到问题,可以尝试手动拼接出命令行参数来启动。</p>
<ol>
<li><p class="first">查找目录jvm的java文件路径。</p>
<p>在linux/mac上执行<code class="docutils literal notranslate"><span class="pre">ps</span> <span class="pre">aux</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">java</span></code>在windows上可以通过进程管理器来查看。假设是<code class="docutils literal notranslate"><span class="pre">/opt/jdk1.8/bin/java</span></code></p>
</li>
<li><p class="first">拼接出命令行</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>/opt/jdk1.8/bin/java -Xbootclasspath/a:/opt/jdk1.8/lib/tools.jar <span class="se">\</span>
-jar /tmp/arthas-packaging/arthas-core.jar <span class="se">\</span>
-pid <span class="m">15146</span> <span class="se">\</span>
-target-ip <span class="m">127</span>.0.0.1 -telnet-port <span class="m">3658</span> -http-port <span class="m">8563</span> <span class="se">\</span>
-core /tmp/arthas-packaging/arthas-core.jar <span class="se">\</span>
-agent /tmp/arthas-packaging/arthas/arthas-agent.jar
</pre></div>
</div>
<p>命令行分几部分组成:</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">-Xbootclasspath</span></code> 增加tools.jar</li>
<li><code class="docutils literal notranslate"><span class="pre">-jar</span> <span class="pre">/tmp/arthas-packaging/arthas-core.jar</span></code> 指定main函数入口</li>
<li><code class="docutils literal notranslate"><span class="pre">-pid</span> <span class="pre">15146</span></code> 指定目标java进程ID</li>
<li><code class="docutils literal notranslate"><span class="pre">-target-ip</span> <span class="pre">127.0.0.1</span></code> 指定IP</li>
<li><code class="docutils literal notranslate"><span class="pre">-telnet-port</span> <span class="pre">3658</span> <span class="pre">-http-port</span> <span class="pre">8563</span></code> 指定telnet和http端口</li>
<li><code class="docutils literal notranslate"><span class="pre">-core</span> <span class="pre">/tmp/arthas-packaging/arthas-core.jar</span> <span class="pre">-agent</span> <span class="pre">/tmp/arthas-packaging/arthas/arthas-agent.jar</span></code> 指定core/agent jar包</li>
</ul>
<p>如果是<code class="docutils literal notranslate"><span class="pre">jdk</span> <span class="pre">&gt;</span> <span class="pre">9</span></code>即9/10/11以上的版本不需要指定<code class="docutils literal notranslate"><span class="pre">tools.jar</span></code>,直接去掉<code class="docutils literal notranslate"><span class="pre">-Xbootclasspath</span></code> 的配置即可。</p>
<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>
</pre></div>
</div>
</li>
</ol>
</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>最新版本:<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><code class="docutils literal notranslate"><span class="pre">Download</span></code>栏下载最新的 <code class="docutils literal notranslate"><span class="pre">doc.zip</span></code> 包,</p>
</div> </div>
<div class="section" id=""> <div class="section" id="">
<span id="id3"></span><h2>卸载<a class="headerlink" href="#" title="永久链接至标题"></a></h2> <span id="id4"></span><h2>卸载<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<ul> <ul>
<li><p class="first">在 Linux/Unix/Mac 平台</p> <li><p class="first">在 Linux/Unix/Mac 平台</p>
<p>删除下面文件:</p> <p>删除下面文件:</p>

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save