Files
arthas/en/options.html
T
2022-04-26 11:41:11 +08:00

480 lines
24 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>options &mdash; Arthas 3.6.1 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" />
<link rel="next" title="Arthas Tunnel" href="tunnel.html" />
<link rel="prev" title="auth" href="auth.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.6.1
</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 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 current"><a class="reference internal" href="commands.html">Commands</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="dashboard.html">dashboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="thread.html">thread</a></li>
<li class="toctree-l2"><a class="reference internal" href="jvm.html">jvm</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html">memory</a></li>
<li class="toctree-l2"><a class="reference internal" href="sysprop.html">sysprop</a></li>
<li class="toctree-l2"><a class="reference internal" href="sysenv.html">sysenv</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmoption.html">vmoption</a></li>
<li class="toctree-l2"><a class="reference internal" href="perfcounter.html">perfcounter</a></li>
<li class="toctree-l2"><a class="reference internal" href="logger.html">logger</a></li>
<li class="toctree-l2"><a class="reference internal" href="mbean.html">mbean</a></li>
<li class="toctree-l2"><a class="reference internal" href="getstatic.html">getstatic</a></li>
<li class="toctree-l2"><a class="reference internal" href="ognl.html">ognl</a></li>
<li class="toctree-l2"><a class="reference internal" href="sc.html">sc</a></li>
<li class="toctree-l2"><a class="reference internal" href="sm.html">sm</a></li>
<li class="toctree-l2"><a class="reference internal" href="dump.html">dump</a></li>
<li class="toctree-l2"><a class="reference internal" href="heapdump.html">heapdump</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmtool.html">vmtool</a></li>
<li class="toctree-l2"><a class="reference internal" href="jad.html">jad</a></li>
<li class="toctree-l2"><a class="reference internal" href="classloader.html">classloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="mc.html">mc</a></li>
<li class="toctree-l2"><a class="reference internal" href="retransform.html">retransform</a></li>
<li class="toctree-l2"><a class="reference internal" href="redefine.html">redefine</a></li>
<li class="toctree-l2"><a class="reference internal" href="monitor.html">monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="watch.html">watch</a></li>
<li class="toctree-l2"><a class="reference internal" href="trace.html">trace</a></li>
<li class="toctree-l2"><a class="reference internal" href="stack.html">stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="tt.html">tt</a></li>
<li class="toctree-l2"><a class="reference internal" href="profiler.html">profiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="cat.html">cat</a></li>
<li class="toctree-l2"><a class="reference internal" href="echo.html">echo</a></li>
<li class="toctree-l2"><a class="reference internal" href="grep.html">grep</a></li>
<li class="toctree-l2"><a class="reference internal" href="base64.html">base64</a></li>
<li class="toctree-l2"><a class="reference internal" href="tee.html">tee</a></li>
<li class="toctree-l2"><a class="reference internal" href="pwd.html">pwd</a></li>
<li class="toctree-l2"><a class="reference internal" href="auth.html">auth</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#view-all-options">View all options</a></li>
<li class="toctree-l3"><a class="reference internal" href="#get-special-option-value">Get special option value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#set-special-option-value">Set special option value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#set-unsafe-to-true-to-enhance-the-classes-under-the-java-package">Set <code class="docutils literal notranslate"><span class="pre">unsafe</span></code> to true to enhance the classes under the <code class="docutils literal notranslate"><span class="pre">java.*</span></code> package</a></li>
<li class="toctree-l3"><a class="reference internal" href="#turn-off-strict-mode-allow-setting-object-properties-in-ognl-expressions">Turn off strict mode, allow setting object properties in ognl expressions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#basic-arthas-commands">Basic Arthas Commands</a></li>
</ul>
</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> &raquo;</li>
<li><a href="commands.html">All Commands</a> &raquo;</li>
<li>options</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/en/options.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="options">
<h1>options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en&amp;id=command-options"><code class="docutils literal notranslate"><span class="pre">options</span></code> online tutorial</a></p>
<blockquote>
<div><p>Global options</p>
</div></blockquote>
<table border="1" class="docutils">
<thead>
<tr>
<th>Name</th>
<th>Default Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>unsafe</td>
<td>false</td>
<td>whether to enhance to system-level class. Use it with caution since JVM may hang</td>
</tr>
<tr>
<td>dump</td>
<td>false</td>
<td>whether to dump enhanced class to the external files. If it's on, enhanced class will be dumped into <code>/${application dir}/arthas-class-dump/</code>, the specific output path will be output in the console</td>
</tr>
<tr>
<td>batch-re-transform</td>
<td>true</td>
<td>whether to re-transform matched classes in batch</td>
</tr>
<tr>
<td>json-format</td>
<td>false</td>
<td>whether to output in JSON format</td>
</tr>
<tr>
<td>disable-sub-class</td>
<td>false</td>
<td>whether to enable matching child classes. The default value is <code>true</code>. If exact match is desire, turn off this flag</td>
</tr>
<tr>
<td>support-default-method</td>
<td>true</td>
<td>whether to enable matching default method in interface. The default value is <code>true</code>. Refer to <a href="https://github.com/alibaba/arthas/issues/1105">#1105</a></td>
</tr>
<tr>
<td>save-result</td>
<td>false</td>
<td>whether to save execution result. All execution results will be saved to <code>~/logs/arthas-cache/result.log</code> when it's turned on</td>
</tr>
<tr>
<td>job-timeout</td>
<td>1d</td>
<td>default timeout for background jobs. Background job will be terminated once it's timed out (i.e. 1d, 2h, 3m, 25s)</td>
</tr>
<tr>
<td>verbose</td>
<td>false</td>
<td>This option enables print verbose information</td>
</tr>
<tr>
<td>strict</td>
<td>true</td>
<td>whether to enable strict mode</td>
</tr>
</tbody>
</table><div class="section" id="view-all-options">
<h2>View all options<a class="headerlink" href="#view-all-options" title="Permalink to this headline"></a></h2>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ options
LEVEL TYPE NAME VALUE SUMMARY DESCRIPTION
-------------------------------------------------------------------------------------------------------
0 boolea unsafe false Option to support sy This option enables to proxy functionality
n stem-level class of JVM classes. Due to serious security r
isk a JVM crash is possibly be introduced.
Do not activate it unless you are able to
manage.
1 boolea dump false Option to dump the e This option enables the enhanced classes t
n nhanced classes o be dumped to external file for further d
e-compilation and analysis.
1 boolea batch-re-tra true Option to support ba This options enables to reTransform classe
n nsform tch reTransform Clas s with batch mode.
s
2 boolea json-format false Option to support JS This option enables to format object outpu
n ON format of object t with JSON when -x option selected.
output
1 boolea disable-sub- false Option to control in This option disable to include sub class w
n class clude sub class when hen matching class.
class matching
1 boolea support-defa true Option to control in This option disable to include default met
n ult-method clude default method hod in interface when matching class.
in interface when c
lass matching
1 boolea save-result false Option to print comm This option enables to save each command&#x27;s
n and&#x27;s result to log result to log file, which path is ${user.
file home}/logs/arthas-cache/result.log.
2 String job-timeout 1d Option to job timeou This option setting job timeout,The unit c
t an be d, h, m, s for day, hour, minute, se
cond. 1d is one day in default
1 boolea print-parent true Option to print all This option enables print files in parent
n -fields fileds in parent cla class, default value true.
ss
1 boolea verbose false Option to print verb This option enables print verbose informat
n ose information ion, default value false.
1 boolea strict true Option to strict mod By default, strict mode is true, not allow
n e ed to set object properties. Want to set o
bject properties, execute `options strict
false`</pre></div>
</div>
</div>
<div class="section" id="get-special-option-value">
<h2>Get special option value<a class="headerlink" href="#get-special-option-value" title="Permalink to this headline"></a></h2>
<div class="highlight-default notranslate"><pre class="literal-block">$ options json-format
LEVEL TYPE NAME VALUE SUMMARY DESCRIPTION
--------------------------------------------------------------------------------------------
2 bool json-format false Option to support This option enables to format object
ean JSON format of obj output with JSON when -x option selec
ect output ted.</pre>
</div>
<blockquote>
<div><p>By default, <code class="docutils literal notranslate"><span class="pre">json-format</span></code> is false. When set <code class="docutils literal notranslate"><span class="pre">json-format</span></code> to true, commands like <code class="docutils literal notranslate"><span class="pre">wathc</span></code>/<code class="docutils literal notranslate"><span class="pre">tt</span></code> will print result with <code class="docutils literal notranslate"><span class="pre">json</span></code> format.</p>
</div></blockquote>
</div>
<div class="section" id="set-special-option-value">
<h2>Set special option value<a class="headerlink" href="#set-special-option-value" title="Permalink to this headline"></a></h2>
<p>For example, to enable saving command execution result, input the command below:</p>
<div class="highlight-default notranslate"><pre class="literal-block">$ options save-result true
NAME BEFORE-VALUE AFTER-VALUE
----------------------------------------
save-result false true</pre>
</div>
</div>
<div class="section" id="set-unsafe-to-true-to-enhance-the-classes-under-the-java-package">
<h2>Set <code class="docutils literal notranslate"><span class="pre">unsafe</span></code> to true to enhance the classes under the <code class="docutils literal notranslate"><span class="pre">java.*</span></code> package<a class="headerlink" href="#set-unsafe-to-true-to-enhance-the-classes-under-the-java-package" title="Permalink to this headline"></a></h2>
<p>By default, <code class="docutils literal notranslate"><span class="pre">watch</span></code>/<code class="docutils literal notranslate"><span class="pre">trace</span></code>/<code class="docutils literal notranslate"><span class="pre">tt</span></code>/<code class="docutils literal notranslate"><span class="pre">trace</span></code>/<code class="docutils literal notranslate"><span class="pre">monitor</span></code> command do not support classes under <code class="docutils literal notranslate"><span class="pre">java.*</span></code> package. You can set <code class="docutils literal notranslate"><span class="pre">unsafe</span></code> to true to enhance the classes under the <code class="docutils literal notranslate"><span class="pre">java.*</span></code> package.</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ options unsafe true
NAME BEFORE-VALUE AFTER-VALUE
-----------------------------------
unsafe false true</pre></div>
</div>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ watch java.lang.invoke.Invokers callSiteForm
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 61 ms, listenerId: 1</pre></div>
</div>
</div>
<div class="section" id="turn-off-strict-mode-allow-setting-object-properties-in-ognl-expressions">
<h2>Turn off strict mode, allow setting object properties in ognl expressions<a class="headerlink" href="#turn-off-strict-mode-allow-setting-object-properties-in-ognl-expressions" title="Permalink to this headline"></a></h2>
<blockquote>
<div><p>since 3.6.0</p>
</div></blockquote>
<p>For new users, there may be misuses when writing ognl expressions.</p>
<p>For example, for <code class="docutils literal notranslate"><span class="pre">Student</span></code>, when judging the age is equal to 18, the conditional expression may be mistakenly written as <code class="docutils literal notranslate"><span class="pre">target.age=18</span></code>, which actually sets the <code class="docutils literal notranslate"><span class="pre">age</span></code> of the current object to 18. The correct spelling is <code class="docutils literal notranslate"><span class="pre">target.age==18</span></code>.</p>
<p>In order to prevent misuse like the above, Arthas enables <code class="docutils literal notranslate"><span class="pre">strict</span></code> mode by default, in <code class="docutils literal notranslate"><span class="pre">ognl</span></code> expressions, it is forbidden to update the property of the object or call the <code class="docutils literal notranslate"><span class="pre">setter</span></code> method.</p>
<p>Take <code class="docutils literal notranslate"><span class="pre">MathGame</span></code> as an example, the following error message will appear.</p>
<div class="highlight-default notranslate"><pre class="literal-block">$ watch demo.MathGame primeFactors &#x27;target&#x27; &#x27;target.illegalArgumentCount=1&#x27;
Press Q or Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 206 ms, listenerId: 1
watch failed, condition is: target.illegalArgumentCount=1, express is: target, By default, strict mode is true, not allowed to set object properties. Want to set object properties, execute `options strict false`, visit /Users/admin/logs/arthas/arthas.log for more details.</pre>
</div>
<p>If the user want to change the object properties in the <code class="docutils literal notranslate"><span class="pre">ognl</span></code> expression, you can execute <code class="docutils literal notranslate"><span class="pre">options</span> <span class="pre">strict</span> <span class="pre">false</span></code> to turn off the <code class="docutils literal notranslate"><span class="pre">strict</span></code> mode.</p>
<ul class="simple">
<li><p>For more information, please refer to: https://github.com/alibaba/arthas/issues/2128</p></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="tunnel.html" class="btn btn-neutral float-right" title="Arthas Tunnel" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="auth.html" class="btn btn-neutral float-left" title="auth" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>