mirror of
https://github.com/alibaba/arthas.git
synced 2026-11-12 22:41:26 +00:00
update doc 3.1.2
This commit is contained in:
hengyunabc committed
1 parent
1afcb5035d
commit
39091052c1
206 files changed
+8994
-6117
No files matched your search
+44
-63
@@ -8,7 +8,7 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Start Arthas — Arthas 3.1.1 documentation</title>
|
||||
<title>Start Arthas — Arthas 3.1.2 documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -19,13 +19,20 @@
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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" />
|
||||
@@ -35,21 +42,16 @@
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/github.min.css">
|
||||
|
||||
|
||||
|
||||
|
||||
<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">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
@@ -63,7 +65,7 @@
|
||||
|
||||
|
||||
<div class="version">
|
||||
3.1.1
|
||||
3.1.2
|
||||
</div>
|
||||
|
||||
|
||||
@@ -90,15 +92,17 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://alibaba.github.io/arthas/arthas-tutorials?language=en">Online tutorials(Recommend)</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="download.html">Download</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quick start</a></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 internal" href="web-console.html">WebConsole</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</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>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING">Compile and debug/CONTRIBUTING</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/releases">Release Notes</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -166,11 +170,10 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="start-arthas">
|
||||
<span id="start-arthas"></span><h1>Start Arthas<a class="headerlink" href="#start-arthas" title="Permalink to this headline">¶</a></h1>
|
||||
<h1>Start Arthas<a class="headerlink" href="#start-arthas" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="interactive-mode">
|
||||
<span id="interactive-mode"></span><h2>Interactive Mode<a class="headerlink" href="#interactive-mode" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">./as.sh
|
||||
</pre></div>
|
||||
<h2>Interactive Mode<a class="headerlink" href="#interactive-mode" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">./as.sh</pre></div>
|
||||
</div>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">➜ bin git:(develop) ✗ ./as.sh
|
||||
Found existing java process, please choose one and hit RETURN.
|
||||
@@ -183,28 +186,26 @@ Attaching to 12872...
|
||||
| .-. || '--'.' | | | .--. || .-. |`. `-.
|
||||
| | | || |\ \ | | | | | || | | |.-' |
|
||||
`--' `--'`--' '--' `--' `--' `--'`--' `--'`-----'
|
||||
$
|
||||
</pre></div>
|
||||
$</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="non-interactive-mode">
|
||||
<span id="non-interactive-mode"></span><h2>Non-Interactive Mode<a class="headerlink" href="#non-interactive-mode" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Non-Interactive Mode<a class="headerlink" href="#non-interactive-mode" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Startup script is as follows:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">./as.sh <PID>[@IP:PORT]
|
||||
</pre></div>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">./as.sh <PID>[@IP:PORT]</pre></div>
|
||||
</div>
|
||||
<div class="section" id="parameter-description">
|
||||
<span id="parameter-description"></span><h3>Parameter Description<a class="headerlink" href="#parameter-description" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Parameter Description<a class="headerlink" href="#parameter-description" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><em>PID</em>: Target Java process ID (Make sure that the user executing the command has sufficient permissions to operate the target Java process.)</li>
|
||||
<li><em>IP</em>: The address that Arthas Server listens on, the default value is <tt class="docutils literal">127.0.0.1</tt>. Arthas allows multiple users to access simultaneously without interfering with each other.</li>
|
||||
<li><em>PORT</em>: Arthas Server port，the default value is 3658</li>
|
||||
<li><p><em>PID</em>: Target Java process ID (Make sure that the user executing the command has sufficient permissions to operate the target Java process.)</p></li>
|
||||
<li><p><em>IP</em>: The address that Arthas Server listens on, the default value is <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code>. Arthas allows multiple users to access simultaneously without interfering with each other.</p></li>
|
||||
<li><p><em>PORT</em>: Arthas Server port，the default value is 3658</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="sample">
|
||||
<span id="sample"></span><h3>Sample<a class="headerlink" href="#sample" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Sample<a class="headerlink" href="#sample" title="Permalink to this headline">¶</a></h3>
|
||||
<ul>
|
||||
<li><p class="first">If IP and PORT are not specified, then the default values are 127.0.0.1 and 3658</p>
|
||||
<li><p>If IP and PORT are not specified, then the default values are 127.0.0.1 and 3658</p>
|
||||
<blockquote>
|
||||
<div><p>./as.sh 12345</p>
|
||||
</div></blockquote>
|
||||
@@ -216,24 +217,21 @@ $
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="remote-diagnosis">
|
||||
<span id="remote-diagnosis"></span><h3>Remote Diagnosis<a class="headerlink" href="#remote-diagnosis" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After starting Arthas Server on the target Java process, users can use <tt class="docutils literal">telnet</tt> connect to the remote Arthas Server, for example：</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">telnet 192.168.1.119 3658
|
||||
</pre></div>
|
||||
<h3>Remote Diagnosis<a class="headerlink" href="#remote-diagnosis" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After starting Arthas Server on the target Java process, users can use <code class="docutils literal notranslate"><span class="pre">telnet</span></code> connect to the remote Arthas Server, for example：</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">telnet 192.168.1.119 3658</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="sudo-support">
|
||||
<span id="sudo-support"></span><h3>sudo Support<a class="headerlink" href="#sudo-support" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Usually online environment will only grant users privilege as low as possible, instead, all advanced operations are through sudo-list. Since <tt class="docutils literal">as.sh</tt> script takes into account the current effective user, it is possible to run the script in the other rule, by specifying <tt class="docutils literal">-H</tt> option like this:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">sudo -u admin -H ./as.sh 12345
|
||||
</pre></div>
|
||||
<h3>sudo Support<a class="headerlink" href="#sudo-support" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Usually online environment will only grant users privilege as low as possible, instead, all advanced operations are through sudo-list. Since <code class="docutils literal notranslate"><span class="pre">as.sh</span></code> script takes into account the current effective user, it is possible to run the script in the other rule, by specifying <code class="docutils literal notranslate"><span class="pre">-H</span></code> option like this:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">sudo -u admin -H ./as.sh 12345</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="windows-support">
|
||||
<span id="windows-support"></span><h3>Windows Support<a class="headerlink" href="#windows-support" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Right now <tt class="docutils literal">as.bat</tt> script supports one parameter only, which is: pid</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">as.bat <pid>
|
||||
</pre></div>
|
||||
<h3>Windows Support<a class="headerlink" href="#windows-support" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Right now <code class="docutils literal notranslate"><span class="pre">as.bat</span></code> script supports one parameter only, which is: pid</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">as.bat <pid></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -250,7 +248,7 @@ $
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Alibaba Middleware Group, and contributors.
|
||||
© Copyright 2018-2019, Alibaba Middleware Group, and contributors
|
||||
|
||||
</p>
|
||||
</div>
|
||||
@@ -267,33 +265,16 @@ $
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT:'./',
|
||||
VERSION:'3.1.1',
|
||||
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" target="_blank">Fork me at GitHub</a>
|
||||
|
||||
Reference in new issue
Block a user