mirror of
https://github.com/alibaba/arthas.git
synced 2024-04-21 10:21:39 +00:00
354 lines
12 KiB
HTML
354 lines
12 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>help — Arthas 3.5.6 documentation</title>
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
|
|
|
|
|
|
|
|
|
|
|
<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" />
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<script>
|
|
if (window.location.href.startsWith("https://alibaba.github.io/arthas/")) {
|
|
window.location.href = "https://arthas.aliyun.com/doc/" + window.location.href.substr("https://alibaba.github.io/arthas/".length);
|
|
}
|
|
</script>
|
|
|
|
<script src="_static/center_page.js"></script>
|
|
<link rel="stylesheet" href="https://g.alicdn.com/code/lib/highlight.js/9.13.1/styles/github.min.css">
|
|
|
|
|
|
</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.5.6
|
|
</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>
|
|
<li class="toctree-l1"><a class="reference external" href="https://arthas.aliyun.com/">Home</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="https://arthas.aliyun.com/doc/arthas-tutorials.html?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="tunnel.html">Arthas Tunnel</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="http-api.html">Http API</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="spring-boot-starter.html">Arthas Spring Boot Starter</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="idea-plugin.html">IDEA Plugin</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="faq.html">FAQ</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Star me at GitHub</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md#">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>
|
|
<li class="toctree-l1"><a class="reference internal" href="contact-us.html">Contact us</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>help</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/en/help.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="help">
|
|
<h1>help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h1>
|
|
<p>show help message, the command can show all the commands that current Arthas server supports,or you can use the command to show the detail usage of another command.</p>
|
|
<blockquote>
|
|
<div><p>[help command] equals [command -help],both is to show the detail usage of one command.</p>
|
|
</div></blockquote>
|
|
<div class="section" id="options">
|
|
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
|
<table border="1" class="docutils">
|
|
<thead>
|
|
<tr>
|
|
<th align="right">Name</th>
|
|
<th align="left">Specification</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="right"></td>
|
|
<td align="left">show all the commands that current Arthas server supports</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="right">[name:]</td>
|
|
<td align="left">show the detail usage of one command</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<div class="section" id="usage">
|
|
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
|
|
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ help
|
|
NAME DESCRIPTION
|
|
help Display Arthas Help
|
|
auth Authenticates the current session
|
|
keymap Display all the available keymap for the specified connection.
|
|
sc Search all the classes loaded by JVM
|
|
sm Search the method of classes loaded by JVM
|
|
classloader Show classloader info
|
|
jad Decompile class
|
|
getstatic Show the static field of a class
|
|
monitor Monitor method execution statistics, e.g. total/success/failure count, average rt, fail rate, etc.
|
|
stack Display the stack trace for the specified class and method
|
|
thread Display thread info, thread stack
|
|
trace Trace the execution time of specified method invocation.
|
|
watch Display the input/output parameter, return object, and thrown exception of specified method invocation
|
|
tt Time Tunnel
|
|
jvm Display the target JVM information
|
|
perfcounter Display the perf counter information.
|
|
ognl Execute ognl expression.
|
|
mc Memory compiler, compiles java files into bytecode and class files in memory.
|
|
redefine Redefine classes. @see Instrumentation#redefineClasses(ClassDefinition...)
|
|
retransform Retransform classes. @see Instrumentation#retransformClasses(Class...)
|
|
dashboard Overview of target jvm's thread, memory, gc, vm, tomcat info.
|
|
dump Dump class byte array from JVM
|
|
heapdump Heap dump
|
|
options View and change various Arthas options
|
|
cls Clear the screen
|
|
reset Reset all the enhanced classes
|
|
version Display Arthas version
|
|
session Display current session information
|
|
sysprop Display, and change the system properties.
|
|
sysenv Display the system env.
|
|
vmoption Display, and update the vm diagnostic options.
|
|
logger Print logger info, and update the logger level
|
|
history Display command history
|
|
cat Concatenate and print files
|
|
base64 Encode and decode using Base64 representation
|
|
echo write arguments to the standard output
|
|
pwd Return working directory name
|
|
mbean Display the mbean information
|
|
grep grep command for pipes.
|
|
tee tee command for pipes.
|
|
profiler Async Profiler. https://github.com/jvm-profiling-tools/async-profiler
|
|
stop Stop/Shutdown Arthas server and exit the console.
|
|
|
|
</pre></div>
|
|
</div>
|
|
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash"> $ help dashboard
|
|
USAGE:
|
|
dashboard [-h] [-i <value>] [-n <value>]
|
|
|
|
SUMMARY:
|
|
Overview of target jvm's thread, memory, gc, vm, tomcat info.
|
|
|
|
EXAMPLES:
|
|
dashboard
|
|
dashboard -n 10
|
|
dashboard -i 2000
|
|
|
|
WIKI:
|
|
https://arthas.aliyun.com/doc/dashboard
|
|
|
|
OPTIONS:
|
|
-h, --help this help
|
|
-i, --interval <value> The interval (in ms) between two executions, default is 5000 ms.
|
|
-n, --number-of-execution <value> The number of times this command will be executed.</pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2018-2020, 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">
|
|
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>
|
|
</div>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="_static/add_badges.js"></script>
|
|
|
|
<script src="https://g.alicdn.com/code/lib/highlight.js/9.13.1/highlight.min.js"></script>
|
|
<script src="https://g.alicdn.com/code/lib/highlightjs-line-numbers.js/2.5.0/highlightjs-line-numbers.min.js"></script>
|
|
<script>
|
|
document.querySelectorAll('div.hljs > pre').forEach(function(block) {
|
|
hljs.highlightBlock(block);
|
|
hljs.lineNumbersBlock(block);
|
|
});
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript">document.write(unescape("%3Cspan style='display:none;' id='cnzz_stat_icon_1279151497'%3E%3C/span%3E%3Cscript src='https://s4.cnzz.com/z_stat.php%3Fid%3D1279151497' type='text/javascript'%3E%3C/script%3E"));</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> |