update doc

This commit is contained in:
hengyunabc committed 2018-11-29 16:18:38 +08:00
1 parent 5030277ccc
commit a2b65725d9
14 files changed
+411 -254

No files matched your search

+37 -60
View File
@@ -91,11 +91,13 @@
<ul class="current">
<li class="toctree-l1"><a class="reference external" href="https://alibaba.github.io/arthas/en/">English Docs</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">安装</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#">全平台通用(推荐)</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="#">快速安装</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#arthas-boot">使用<code class="docutils literal notranslate"><span class="pre">arthas-boot</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#as-sh">使用<code class="docutils literal notranslate"><span class="pre">as.sh</span></code></a></li>
</ul>
</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>
@@ -178,7 +180,35 @@
<div class="section" id="arthas-install">
<span id="arthas-install"></span><h1>Arthas Install<a class="headerlink" href="#arthas-install" title="永久链接至标题"></a></h1>
<div class="section" id="">
<span id="id1"></span><h2>全平台通用(推荐)<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<span id="id1"></span><h2>快速安装<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<div class="section" id="arthas-boot">
<span id="arthas-boot"></span><h3>使用<code class="docutils literal notranslate"><span class="pre">arthas-boot</span></code><a class="headerlink" href="#arthas-boot" title="永久链接至标题"></a></h3>
<p>下载<code class="docutils literal notranslate"><span class="pre">arthas-boot.jar</span></code>,然后用<code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span></code>的方式启动:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>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"><pre><span></span>java -jar arthas-boot.jar -h
</pre></div>
</div>
<ul class="simple">
<li>如果下载速度比较慢,可以使用aliyun的镜像:<code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span> <span class="pre">arthas-boot.jar</span> <span class="pre">--repo-mirror</span> <span class="pre">aliyun</span> <span class="pre">--use-http</span></code></li>
</ul>
</div>
<div class="section" id="as-sh">
<span id="as-sh"></span><h3>使用<code class="docutils literal notranslate"><span class="pre">as.sh</span></code><a class="headerlink" href="#as-sh" title="永久链接至标题"></a></h3>
<p>Arthas 支持在 Linux/Unix/Mac 等平台上一键安装,请复制以下内容,并粘贴到命令行中,敲 <code class="docutils literal notranslate"><span class="pre">回车</span></code> 执行即可:</p>
<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>
</div>
<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>也可以执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span> <span class="pre">-h</span></code>来获取更多参数信息。</p>
</div>
</div>
<div class="section" id="">
<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>解压后,在文件夹里有<code class="docutils literal notranslate"><span class="pre">arthas-boot.jar</span></code>,直接用<code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span></code>的方式启动:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>java -jar arthas-boot.jar
@@ -189,64 +219,11 @@
</pre></div>
</div>
</div>
<div class="section" id="linux-unix-mac">
<span id="linux-unix-mac"></span><h2>Linux/Unix/Mac<a class="headerlink" href="#linux-unix-mac" title="永久链接至标题"></a></h2>
<p>Arthas 支持在 Linux/Unix/Mac 等平台上一键安装,请复制以下内容,并粘贴到命令行中,敲 <code class="docutils literal notranslate"><span class="pre">回车</span></code> 执行即可:</p>
<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>
</div>
<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>也可以执行<code class="docutils literal notranslate"><span class="pre">./as.sh</span> <span class="pre">-h</span></code>来获取更多参数信息。</p>
</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://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>
</div>
<div class="section" id="">
<span id="id2"></span><h2>手动安装<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<span id="id3"></span><h2>手动安装<a class="headerlink" href="#" title="永久链接至标题"></a></h2>
<p><a class="reference internal" href="manual-install.html"><span class="doc">手动安装</span></a></p>
</div>
<div class="section" id="">
<span id="id3"></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 <span class="m">127</span>.0.0.1 <span class="m">3658</span>
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="">
<span id="id4"></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=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>
@@ -259,7 +236,7 @@
</pre></div>
</div>
</li>
<li><p class="first">Windows平台直接删除zip包和解压的文件</p>
<li><p class="first">Windows平台直接删除user home下面的<code class="docutils literal notranslate"><span class="pre">.arthas</span></code>目录</p>
</li>
</ul>
</div>