github/arthas
4
0 Fork 0
mirror of https://github.com/alibaba/arthas.git synced 2026-11-08 00:36:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

update en doc

Browse Source
This commit is contained in:
hengyunabc committed 2018-11-12 17:40:01 +08:00
1 parent e1aec34af0
commit 5124cca8eb
64 files changed
+1439 -923
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

en/index.html
+17 -18
View File
@@ -31,7 +31,7 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Arthas Install" href="install-detail.html" />
<link rel="next" title="Install Arthas" href="install-detail.html" />
<script src="_static/center_page.js"></script>
@@ -93,10 +93,10 @@
<li class="toctree-l1"><a class="reference internal" href="advanced-use.html">Advanced usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Auser-case">User cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered">Questions and answers</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Fork me at GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md">CONTRIBUTING</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
</ul>
@@ -165,35 +165,34 @@
<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><strong><a class="reference external" href="https://alibaba.github.io/arthas/">中文文档</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 a Java Diagnostic tool open sourced by Alibaba.</p>
<p>Arthas help developers in trouble-shooting production issues for Java applications without modifying code or restarting servers.</p>
<p>Arthas is a Java diagnostic tool open-sourced by Alibaba middleware team. It is widely adopted and popular among the developers inside Alibaba. Arthas helps developers in trouble-shooting issues in production environment for Java based applications without modifying code or restarting servers.</p>
<div class="section" id="background">
<span id="background"></span><h2>Background<a class="headerlink" href="#background" title="Permalink to this headline"></a></h2>
<p>Often times, the production system network is inaccessible from local development environment. If issues are encountered in production systems, it is impossible to use IDE to debug the application remotely. More importantly, debugging in production environment is unacceptable, as it will suspend all the threads, which leads to blocking of business services.</p>
<p>Developers could always try to reproduce the same issue on the test/staging environment. However, this is tricky as some issues cannot be be reproduced easily on a different environment, or even disappear once restarted.</p>
<p>And if you’re thinking of adding some logs to your code to help trouble-shoot the issue, you will have to go through the following lifecycle; test, staging, and then to production. Time is money! This approach is inefficient! Besides, the issue may not be reproducible once the JVM is restarted, as described above.</p>
<p>Arthas was built to solve these issues. A developer can trouble-shoot your production issues on-the-fly. No JVM restart, no additional code changes. Arthas works as an observer, which will never suspend your existing threads.</p>
<p>Oftentimes the production system network is inaccessible from local development environment. If issues are encountered in production systems, it is impossible to use IDE to debug the application remotely. What’s even worse, debugging in production environment is unacceptable, as it will suspend all the threads, leading to services downtime.</p>
<p>Developers could always try to reproduce the same issue on the test/staging environment. However, this is tricky as some issues cannot be reproduced easily in a different environment, or even disappear once restarted.</p>
<p>And if you’re thinking of adding some logs to your code to help trouble-shoot the issue, you will have to go through the following lifecycle: test, staging, and then to production. Time is money! This approach is inefficient! Worse still, the issue may not be fixed since it might be irreproducible once the JVM is restarted, as described above.</p>
<p>Arthas is built to solve these issues. A developer can troubleshoot production issues on the fly. No JVM restart, no additional code changes. Arthas works as an observer, that is, it will never suspend your running threads.</p>
</div>
<div class="section" id="key-features">
<span id="key-features"></span><h2>Key features<a class="headerlink" href="#key-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Check whether a class is loaded? Or where the class is loaded from? (Useful for trouble-shooting jar file conflicts)</li>
<li>Decompile a class to ensure the code is running as expected.</li>
<li>View classloader statistics, e.g. the number of classloaders, the number of classes loaded per classloader, the classloader hierarchy, possible classloader leaks, etc.</li>
<li>View the method invocation details, e.g. method parameter, return object, thrown exception, and etc.</li>
<li>Check the stack trace of specified method invocation. This is useful when a developers wants to know the caller of the said method.</li>
<li>Check classloader statistics, e.g. the number of classloaders, the number of classes loaded per classloader, the classloader hierarchy, possible classloader leaks, etc.</li>
<li>Check the method invocation details, e.g. method parameter, returned values, exceptions and etc.</li>
<li>Check the stack trace of specified method invocation. This is useful when a developer wants to know the caller of the method.</li>
<li>Trace the method invocation to find slow sub-invocations.</li>
<li>Monitor method invocation statistics, e.g. qps, rt, success rate and etc.</li>
<li>Monitor system metrics, thread states and cpu usage, gc statistics, and etc.</li>
<li>Monitor method invocation statistics, e.g. QPS (Query Per Second), RT (Return Time), success rate and etc.</li>
<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 telnet and WebSocket, which enables both local and remote diagnostics with command line and browsers.</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 PM.</p>
<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>
@@ -201,10 +200,10 @@
<li class="toctree-l1"><a class="reference internal" href="advanced-use.html">Advanced usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Auser-case">User cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered">Questions and answers</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Fork me at GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md">CONTRIBUTING</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
</ul>
</div>
</div>
@@ -218,7 +217,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="install-detail.html" class="btn btn-neutral float-right" title="Arthas Install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="install-detail.html" class="btn btn-neutral float-right" title="Install Arthas" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>