mirror of
https://github.com/alibaba/arthas.git
synced 2024-04-21 10:21:39 +00:00
409 lines
20 KiB
HTML
409 lines
20 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Quick Start — Arthas 3.0.5-SNAPSHOT documentation</title>
|
||
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<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="Advanced Usage" href="advanced-use.html" />
|
||
<link rel="prev" title="Install Arthas" href="install-detail.html" />
|
||
<script src="_static/center_page.js"></script>
|
||
|
||
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> Arthas
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
3.0.5-SNAPSHOT
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick start</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#start-demo-application">1. Start Demo Application</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#start-arthas">2. Start Arthas</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#linux-unix-mac">Linux/Unix/Mac</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#windows">Windows</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#check-the-dashboard">3. Check the Dashboard</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#watch">4. watch</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#exit-arthas">5. Exit Arthas</a></li>
|
||
</ul>
|
||
</li>
|
||
<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 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>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Arthas</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li>Quick Start</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/en/quick-start.md" class="fa fa-github"> Edit on GitHub</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="quick-start">
|
||
<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>
|
||
<p>Save the following code to a <code class="docutils literal notranslate"><span class="pre">Demo.java</span></code> and run the commands in shell as</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>javac Demo.java <span class="o">&&</span> java Demo
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">java.util.concurrent.TimeUnit</span><span class="o">;</span>
|
||
<span class="kn">import</span> <span class="nn">java.util.concurrent.atomic.AtomicInteger</span><span class="o">;</span>
|
||
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Demo</span> <span class="o">{</span>
|
||
<span class="kd">static</span> <span class="kd">class</span> <span class="nc">Counter</span> <span class="o">{</span>
|
||
<span class="kd">private</span> <span class="kd">static</span> <span class="n">AtomicInteger</span> <span class="n">count</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AtomicInteger</span><span class="o">(</span><span class="mi">0</span><span class="o">);</span>
|
||
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">increment</span><span class="o">()</span> <span class="o">{</span>
|
||
<span class="n">count</span><span class="o">.</span><span class="na">incrementAndGet</span><span class="o">();</span>
|
||
|
||
<span class="o">}</span>
|
||
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">int</span> <span class="nf">value</span><span class="o">()</span> <span class="o">{</span>
|
||
<span class="k">return</span> <span class="n">count</span><span class="o">.</span><span class="na">get</span><span class="o">();</span>
|
||
|
||
<span class="o">}</span>
|
||
|
||
<span class="o">}</span>
|
||
|
||
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">InterruptedException</span> <span class="o">{</span>
|
||
<span class="k">while</span> <span class="o">(</span><span class="kc">true</span><span class="o">)</span> <span class="o">{</span>
|
||
<span class="n">Counter</span><span class="o">.</span><span class="na">increment</span><span class="o">();</span>
|
||
<span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"counter: "</span> <span class="o">+</span> <span class="n">Counter</span><span class="o">.</span><span class="na">value</span><span class="o">());</span>
|
||
<span class="n">TimeUnit</span><span class="o">.</span><span class="na">SECONDS</span><span class="o">.</span><span class="na">sleep</span><span class="o">(</span><span class="mi">1</span><span class="o">);</span>
|
||
|
||
<span class="o">}</span>
|
||
|
||
<span class="o">}</span>
|
||
|
||
<span class="o">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Save the contents above into <code class="docutils literal notranslate"><span class="pre">Demo.java</span></code>, then compile it under the command line:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>javac Demo.java
|
||
java Demo
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also save and start the code in IDE.</p>
|
||
</div>
|
||
<div class="section" id="start-arthas">
|
||
<span id="start-arthas"></span><h2>2. Start Arthas<a class="headerlink" href="#start-arthas" title="Permalink to this headline">¶</a></h2>
|
||
<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"><pre><span></span>./as.sh
|
||
</pre></div>
|
||
</div>
|
||
<blockquote>
|
||
<div>The user to run this script <em>MUST</em> 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 <code class="docutils literal notranslate"><span class="pre">admin</span></code>: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">su</span> <span class="pre">admin</span> <span class="pre">&&</span> <span class="pre">./as.sh</span></code> or <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">admin</span> <span class="pre">-EH</span> <span class="pre">./as.sh</span></code>. For more details on the bootstrap script, please refer to <a class="reference internal" href="start-arthas.html"><span class="doc">Start Arthas</span></a>. If you cannot be able to attach to the target process, please check the logs under <code class="docutils literal notranslate"><span class="pre">~/logs/arthas</span></code> for troubleshooting.</div></blockquote>
|
||
<p>Select the target Java process to attach:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./as.sh
|
||
Arthas script version: <span class="m">3</span>.0.2
|
||
Found existing java process, please choose one and hit RETURN.
|
||
* <span class="o">[</span><span class="m">1</span><span class="o">]</span>: <span class="m">95428</span>
|
||
<span class="o">[</span><span class="m">2</span><span class="o">]</span>: <span class="m">22647</span> org.jetbrains.jps.cmdline.Launcher
|
||
<span class="o">[</span><span class="m">3</span><span class="o">]</span>: <span class="m">21736</span>
|
||
<span class="o">[</span><span class="m">4</span><span class="o">]</span>: <span class="m">13560</span> Demo
|
||
</pre></div>
|
||
</div>
|
||
<p>The ‘Demo’ process is the fourth as shown above, press ‘4’ then ‘Enter’. Arthas will attach to the target process, and start to output:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>Connecting to arthas server... current timestamp is <span class="m">1536656867</span>
|
||
Trying <span class="m">127</span>.0.0.1...
|
||
Connected to <span class="m">127</span>.0.0.1.
|
||
Escape character is <span class="s1">'^]'</span>.
|
||
,---. ,------. ,--------.,--. ,--. ,---. ,---.
|
||
/ O <span class="se">\ </span><span class="p">|</span> .--. <span class="s1">''</span>--. .--<span class="s1">'| '</span>--<span class="s1">' | / O \ '</span> .-<span class="s1">'</span>
|
||
<span class="s1">| .-. || '</span>--<span class="s1">'.'</span> <span class="p">|</span> <span class="p">|</span> <span class="p">|</span> .--. <span class="o">||</span> .-. <span class="p">|</span><span class="sb">`</span>. <span class="sb">`</span>-.
|
||
<span class="p">|</span> <span class="p">|</span> <span class="p">|</span> <span class="o">||</span> <span class="p">|</span><span class="se">\ </span> <span class="se">\ </span> <span class="p">|</span> <span class="p">|</span> <span class="p">|</span> <span class="p">|</span> <span class="p">|</span> <span class="o">||</span> <span class="p">|</span> <span class="p">|</span> <span class="p">|</span>.-<span class="s1">' |</span>
|
||
<span class="s1">`--'</span> <span class="sb">`</span>--<span class="s1">'`--'</span> <span class="s1">'--'</span> <span class="sb">`</span>--<span class="s1">' `--'</span> <span class="sb">`</span>--<span class="s1">'`--'</span> <span class="sb">`</span>--<span class="s1">'`-----'</span>
|
||
|
||
wiki: https://alibaba.github.io/arthas
|
||
version: <span class="m">3</span>.0.1-RC-SNAPSHOT
|
||
pid: <span class="m">13560</span>
|
||
timestamp: <span class="m">1536656867894</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="windows">
|
||
<span id="windows"></span><h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
|
||
<p>Open ‘Command’ window, execute <code class="docutils literal notranslate"><span class="pre">as.bat</span> <span class="pre"><pid></span></code> from where the Arthas package file is unzipped.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="check-the-dashboard">
|
||
<span id="check-the-dashboard"></span><h2>3. Check the Dashboard<a class="headerlink" href="#check-the-dashboard" title="Permalink to this headline">¶</a></h2>
|
||
<p>Type ‘<a class="reference internal" href="dashboard.html"><span class="doc">dashboard</span></a>’ and hit ‘ENTER’, a brief report on the current process will be shown as below, pls. <code class="docutils literal notranslate"><span class="pre">Ctrl+C</span></code> to stop:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ dashboard
|
||
ID NAME GROUP PRIORI STATE %CPU TIME INTERRU DAEMON
|
||
17 pool-2-thread-1 system 5 WAITIN 67 0:0 false false
|
||
27 Timer-for-arthas-dashb system 10 RUNNAB 32 0:0 false true
|
||
11 AsyncAppender-Worker-a system 9 WAITIN 0 0:0 false true
|
||
9 Attach Listener system 9 RUNNAB 0 0:0 false true
|
||
3 Finalizer system 8 WAITIN 0 0:0 false true
|
||
2 Reference Handler system 10 WAITIN 0 0:0 false true
|
||
4 Signal Dispatcher system 9 RUNNAB 0 0:0 false true
|
||
26 as-command-execute-dae system 10 TIMED_ 0 0:0 false true
|
||
13 job-timeout system 9 TIMED_ 0 0:0 false true
|
||
1 main main 5 TIMED_ 0 0:0 false false
|
||
14 nioEventLoopGroup-2-1 system 10 RUNNAB 0 0:0 false false
|
||
18 nioEventLoopGroup-2-2 system 10 RUNNAB 0 0:0 false false
|
||
23 nioEventLoopGroup-2-3 system 10 RUNNAB 0 0:0 false false
|
||
15 nioEventLoopGroup-3-1 system 10 RUNNAB 0 0:0 false false
|
||
Memory used total max usage GC
|
||
heap 32M 155M 1820M 1.77% gc.ps_scavenge.count 4
|
||
ps_eden_space 14M 65M 672M 2.21% gc.ps_scavenge.time(m 166
|
||
ps_survivor_space 4M 5M 5M s)
|
||
ps_old_gen 12M 85M 1365M 0.91% gc.ps_marksweep.count 0
|
||
nonheap 20M 23M -1 gc.ps_marksweep.time( 0
|
||
code_cache 3M 5M 240M 1.32% ms )
|
||
Runtime
|
||
os.name Mac OS X
|
||
os.version 10.13.4
|
||
java.version 1.8.0_162
|
||
java.home /Library/Java/JavaVir
|
||
tualMachines/jdk1.8.0
|
||
_162.jdk/Contents/Hom
|
||
e/jre
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="watch">
|
||
<span id="watch"></span><h2>4. watch<a class="headerlink" href="#watch" title="Permalink to this headline">¶</a></h2>
|
||
<p>Use ‘<a class="reference internal" href="watch.html"><span class="doc">watch</span></a>’ to check the returned value of <code class="docutils literal notranslate"><span class="pre">Counter.value()</span></code>:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ watch Demo$Counter value returnObj
|
||
Press Ctrl+C to abort.
|
||
Affect(class-cnt:1 , method-cnt:1) cost in 29 ms.
|
||
ts=2018-09-10 17:53:11;result=@Integer[621]
|
||
ts=2018-09-10 17:53:12;result=@Integer[622]
|
||
ts=2018-09-10 17:53:13;result=@Integer[623]
|
||
ts=2018-09-10 17:53:14;result=@Integer[624]
|
||
ts=2018-09-10 17:53:15;result=@Integer[625]
|
||
</pre></div>
|
||
</div>
|
||
<p>Pls. refer to <a class="reference internal" href="advanced-use.html"><span class="doc">advanced usages</span></a> for more information.</p>
|
||
</div>
|
||
<div class="section" id="exit-arthas">
|
||
<span id="exit-arthas"></span><h2>5. Exit Arthas<a class="headerlink" href="#exit-arthas" title="Permalink to this headline">¶</a></h2>
|
||
<p>Use <code class="docutils literal notranslate"><span class="pre">quit</span></code> or <code class="docutils literal notranslate"><span class="pre">exit</span></code> to disconnect from the current process. The Arthas instance attached to the target process continues to live inside the process, and its port is standby for further connection.</p>
|
||
<p>Use <code class="docutils literal notranslate"><span class="pre">shutdown</span></code> to have Arthas completely quit from the target process.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="advanced-use.html" class="btn btn-neutral float-right" title="Advanced Usage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="install-detail.html" class="btn btn-neutral" title="Install Arthas" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2018, Alibaba Middleware Group, and contributors.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'3.0.5-SNAPSHOT',
|
||
LANGUAGE:'en',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
<div class="github-fork-ribbon-wrapper right">
|
||
<div class="github-fork-ribbon">
|
||
<a href="https://github.com/alibaba/arthas">Fork me at GitHub</a>
|
||
</div>
|
||
</div>
|
||
|
||
<script type="text/javascript" src="_static/add_badges.js"></script>
|
||
|
||
<script>
|
||
var _hmt = _hmt || [];
|
||
(function() {
|
||
var hm = document.createElement("script");
|
||
hm.src = "https://hm.baidu.com/hm.js?d5c5e25b100f0eb51a4c35c8a86ea9b4";
|
||
var s = document.getElementsByTagName("script")[0];
|
||
s.parentNode.insertBefore(hm, s);
|
||
})();
|
||
</script>
|
||
|
||
|
||
|
||
</body>
|
||
</html> |