github-forks
/
arthas
mirror of https://github.com/alibaba/arthas.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc

Browse Source
pull/483/head
hengyunabc 6 years ago
parent cd613d1f3f
commit ed31d35e1f
5 changed files with 49 additions and 50 deletions
Show Stats Download Patch File Download Diff File

2
en/_sources/index.md.txt
Unescape Escape View File

@ -1,6 +1,8 @@
Arthas Documentation
===
**[中文文档/Chinese Docs](https://alibaba.github.io/arthas/)**
![arthas](arthas.png)
`Arthas` is an Java Diagnostic tool open sourced by Alibaba.

30
en/_sources/install-detail.md.txt
Unescape Escape View File

@ -40,21 +40,23 @@ If in Windows, the color is not working as expect. You can try [conemu](https://
If you cannot boot Arthas, try to pass in all the critical options manually as the following steps:
### 1. locate the java for JVM:
- Linux/Unix/Mac: `ps aux | grep java`
- Windows: open the Process Monitor to search java
1. locate the java for JVM:
### 2. Concatenate the command
Let's suppose we are using `/opt/jdk1.8/bin/java`, then the command should be:
- Linux/Unix/Mac: `ps aux | grep java`
- Windows: open the Process Monitor to search java
```bash
2. Concatenate the command
Let's suppose we are using `/opt/jdk1.8/bin/java`, then the command should be:
```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` add tools.jar
* `-jar /tmp/arthas-packaging/arthas-core.jar` specify main entry
@ -64,17 +66,17 @@ Let's suppose we are using `/opt/jdk1.8/bin/java`, then the command should be:
* `-core /tmp/arthas-packaging/arthas-core.jar -agent /tmp/arthas-packaging/arthas/arthas-agent.jar` specify core/agent jar package
But if you are using JDK 1.9 or above，then you do not need to add `tools.jar` in option `-Xbootclasspath`.
But if you are using JDK 1.9 or above，then you do not need to add `tools.jar` in option `-Xbootclasspath`.
F.Y.I the booting log will be printed to `~/logs/arthas/arthas.log`.
F.Y.I the booting log will be printed to `~/logs/arthas/arthas.log`.
### 3. Connect via telnet
3. Connect via telnet
When attached successfully, you can connect it with
When attached successfully, you can connect it with
```bash
telnet localhost 3658
```
```bash
telnet localhost 3658
```
## Offline Help Documentation

1
en/index.html
Unescape Escape View File

@ -165,6 +165,7 @@
<div class="section" id="arthas-documentation">
<span id="arthas-documentation"></span><h1>Arthas Documentation<a class="headerlink" href="#arthas-documentation" title="Permalink to this headline"></a></h1>
<p><strong><a class="reference external" href="https://alibaba.github.io/arthas/">中文文档/Chinese Docs</a></strong></p>
<p><img alt="arthas" src="_images/arthas.png" /></p>
<p><code class="docutils literal notranslate"><span class="pre">Arthas</span></code> is an Java Diagnostic tool open sourced by Alibaba.</p>
<p>Arthas can help developer trouble-shooting production issues for Java applications without modifying your code or restating your server.</p>

42
en/install-detail.html
Unescape Escape View File

@ -93,12 +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="#windows">Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="#manual-installation">Manual Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#advanced-manual-boot">Advanced Manual Boot</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#locate-the-java-for-jvm">1. locate the java for JVM:</a></li>
<li class="toctree-l3"><a class="reference internal" href="#concatenate-the-command">2. Concatenate the command</a></li>
<li class="toctree-l3"><a class="reference internal" href="#connect-via-telnet">3. Connect via telnet</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#advanced-manual-boot">Advanced Manual Boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="#offline-help-documentation">Offline Help Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#uninstall">Uninstall</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#linux-unix-mac">Linux/Unix/Mac</a></li>
@ -211,17 +206,16 @@
<div class="section" id="advanced-manual-boot">
<span id="advanced-manual-boot"></span><h2>Advanced Manual Boot<a class="headerlink" href="#advanced-manual-boot" title="Permalink to this headline"></a></h2>
<p>If you cannot boot Arthas, try to pass in all the critical options manually as the following steps:</p>
<div class="section" id="locate-the-java-for-jvm">
<span id="locate-the-java-for-jvm"></span><h3>1. locate the java for JVM:<a class="headerlink" href="#locate-the-java-for-jvm" title="Permalink to this headline"></a></h3>
<ol>
<li><p class="first">locate the java for JVM:</p>
<ul class="simple">
<li>Linux/Unix/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></li>
<li>Windows: open the Process Monitor to search java</li>
</ul>
</div>
<div class="section" id="concatenate-the-command">
<span id="concatenate-the-command"></span><h3>2. Concatenate the command<a class="headerlink" href="#concatenate-the-command" title="Permalink to this headline"></a></h3>
</li>
<li><p class="first">Concatenate the command</p>
<p>Let’s suppose we are using <code class="docutils literal notranslate"><span class="pre">/opt/jdk1.8/bin/java</span></code>, then the command should be:</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>
<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>
@ -229,24 +223,24 @@
-agent /tmp/arthas-packaging/arthas/arthas-agent.jar
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>* `-Xbootclasspath` add tools.jar
* `-jar /tmp/arthas-packaging/arthas-core.jar` specify main entry
* `-pid 15146` specify the target java process pid
* `-target-ip 127.0.0.1` specify the IP
* `-telnet-port 3658 -http-port 8563` specify telnet and http ports
* `-core /tmp/arthas-packaging/arthas-core.jar -agent /tmp/arthas-packaging/arthas/arthas-agent.jar` specify core/agent jar package
</pre></div>
</div>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">-Xbootclasspath</span></code> add 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> specify main entry</li>
<li><code class="docutils literal notranslate"><span class="pre">-pid</span> <span class="pre">15146</span></code> specify the target java process pid</li>
<li><code class="docutils literal notranslate"><span class="pre">-target-ip</span> <span class="pre">127.0.0.1</span></code> specify the 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> specify telnet and http ports</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> specify core/agent jar package</li>
</ul>
<p>But if you are using JDK 1.9 or above，then you do not need to add <code class="docutils literal notranslate"><span class="pre">tools.jar</span></code> in option <code class="docutils literal notranslate"><span class="pre">-Xbootclasspath</span></code>.</p>
<p>F.Y.I the booting log will be printed to <code class="docutils literal notranslate"><span class="pre">~/logs/arthas/arthas.log</span></code>.</p>
</div>
<div class="section" id="connect-via-telnet">
<span id="connect-via-telnet"></span><h3>3. Connect via telnet<a class="headerlink" href="#connect-via-telnet" title="Permalink to this headline"></a></h3>
</li>
<li><p class="first">Connect via telnet</p>
<p>When attached successfully, you can connect it with</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>telnet localhost <span class="m">3658</span>
</pre></div>
</div>
</div>
</li>
</ol>
</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>

2
en/searchindex.js
View File

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