<!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 — Arthas 3.2.0 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 = "Docker" href = "docker.html" / >
< link rel = "prev" title = "pwd" href = "pwd.html" / >
< script src = "_static/center_page.js" > < / script >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/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.2.0
< / 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://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 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 = "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 = "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 = "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 = "tee.html" > tee< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "pwd.html" > pwd< / 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 >
< / 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 = "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#" > 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 >
< / 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 > < a href = "commands.html" > All Commands< / a > » < / 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 >
< 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 > debug-for-asm< / td >
< td > false< / td >
< td > whether to enable ASM debugging log< / 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 >
< / 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 bool unsafe false Option to support This option enables to proxy function
ean system-level class ality of JVM classes. Due to serious
security risk a JVM crash is possibly
be introduced. Do not activate it un
less you are able to manage.
1 bool dump false Option to dump the This option enables the enhanced clas
ean enhanced classes ses to be dumped to external file for
further de-compilation and analysis.
1 bool batch-re-tr true Option to support This options enables to reTransform c
ean ansform batch reTransform lasses with batch mode.
Class
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.
1 bool disable-sub false Option to control This option disable to include sub cl
ean -class include sub class ass when matching class.
when class matchin
g
1 bool debug-for-a false Option to print DE This option enables to print DEBUG me
ean sm BUG message if ASM ssage of ASM for each method invocati
is involved on.
1 bool save-result false Option to print co This option enables to save each comm
ean mmand' s result to and' s result to log file, which path
log file is ${user.home}/logs/arthas-cache/res
ult.log.
2 Stri job-timeout 1d Option to job time This option setting job timeout,The u
ng out nit can be d, h, m, s for day, hour,
minute, second. 1d is one day in defa
ult
1 bool print-paren true Option to print al This option enables print files in pa
ean t-fields l fileds in parent rent class, default value true.
class< / 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 >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "docker.html" class = "btn btn-neutral float-right" title = "Docker" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "pwd.html" class = "btn btn-neutral float-left" title = "pwd" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
< 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://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/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 >
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
if (window.location.hostname == "arthas.gitee.io") {
hm.src = "https://hm.baidu.com/hm.js?ecc1b0d9aeb73da1671876133211d4d3";
} else { // https://alibaba.github.io/arthas/
hm.src = "https://hm.baidu.com/hm.js?d5c5e25b100f0eb51a4c35c8a86ea9b4";
}
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
< / script >
< / body >
< / html >
