github-forks
/
arthas
mirror of https://github.com/alibaba/arthas.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc

Browse Source
pull/483/head
hengyunabc 6 years ago
parent 89fa8a4c84
commit 2610db8bbf
13 changed files with 252 additions and 96 deletions
Show Stats Download Patch File Download Diff File

77
en/_sources/advanced-use.md.txt
Unescape Escape View File

@ -3,71 +3,74 @@ Advanced Usage
## Basic ## Basic
* help - show help info * help - display Arthas help
* cls - clear out the current screen * cls - clear the screen
* session - check details of the current session * session - display current session information
* [reset](reset.md) - reset all injected/enhanced classes * [reset](reset.md) - reset all the enhanced classes. All enhanced classes will also be reset when Arthas server is closed by `shutdown`
* version - print the version of the Arthas attaching to the current target process * version - print the version for the Arthas attached to the current Java process
* quit/exit - exit the current Arthas client without affecting other clients * quit/exit - exit the current Arthas session, without effecting other sessions
* shutdown - terminate the Arthas server and all clients * shutdown - terminate the Arthas server, all Arthas sessions will be destroyed
* [keymap](keymap.md) - keymap for Arthas keyboard shortcut
## JVM ## JVM
* [dashboard](dashboard.md) - real-time dashboard for the current system * [dashboard](dashboard.md) - dashboard for the system's real-time data
* [thread](thread.md) - thread profile * [thread](thread.md) - show java thread information
* [jvm](jvm.md) - JVM profile * [jvm](jvm.md) - show JVM information
* [sysprop](sysprop.md) - check or modify JVM system properties * [sysprop](sysprop.md) - show/modify system properties
* **New!** [getstatic](getstatic.md) :clap: - check the static properties of classes * **New!** [getstatic](getstatic.md) :clap: - examine class's static properties
## class/classloader ## class/classloader
* [sc](sc.md) - check the info for the classes loaded by JVM
* [sc](sc.md) - check profiles of the classes loaded by JVM * [sm](sm.md) - check methods info for the loaded classes
* [sm](sm.md) - check methods' profile * [dump](dump.md) - dump the loaded classes in byte code to the specified location
* [dump](dump.md) - dump out the byte code of the loaded classes to specified location * [redefine](redefine.md) - load external `*.class` files and re-define it into JVM
* [redefine](redefine.md) - load external `*.class` files and re-define the JVM-loaded classes
* [jad](jad.md) - de-compile the specified loaded classes * [jad](jad.md) - de-compile the specified loaded classes
* [classloader](classloader.md) - check the inheritance structure, urls, class loading info of class cloader; using classloader to get the url of the resource e.g. `java/lang/String.class` * [classloader](classloader.md) - check the inheritance structure, urls, class loading info for the specified class; using classloader to get the url of the resource e.g. `java/lang/String.class`
## monitor/watch/trace - related ## monitor/watch/trace - related
> **Attention**: commands here are taking advantage of `byte code injection`, which means we are using [AOP](https://en.wikipedia.org/wiki/Aspect-oriented_programming) to monitor and analyze the classes. So when using it for online troubleshooting, you'd better *explicitly specifically* specify the classes and also remember to remove the injected code by `shutdown` or `reset`. > **Attention**: commands here are taking advantage of byte-code-injection, which means we are injecting some [aspects](https://en.wikipedia.org/wiki/Aspect-oriented_programming) into the current classes for monitoring and statistics purpose. Therefore when use it for online troubleshooting in your production environment, you'd better **explicitly specify** classes/methods/criteria, and remember to remove the injected code by `shutdown` or `reset`.
* [monitor](monitor.md) - monitor the `class-pattern` & `method-pattern` matched methods' invoking traces * [monitor](monitor.md) - monitor method execution statistics
* [watch](watch.md) - watch/monitor methods in data aspect including `return values`, `exceptions` and `parameters` * [watch](watch.md) - display the input/output parameter, return object, and thrown exception of specified method invocation
* [trace](trace.md) - track the method calling trace along with the time cost for each call * [trace](trace.md) - trace the execution time of specified method invocation
* [stack](stack.md) - print the call stack trace of the current method in a persistent way * [stack](stack.md) - display the stack trace for the specified class and method
* [tt](tt.md) - record the arguments and returned value for the methods, history included * [tt](tt.md) - time tunnel, record the arguments and returned value for the methods and replay
## options ## options
* [options](options.md) - check or set Arthas global options * [options](options.md) - check/set Arthas global options
## pipe ## pipe
`pipe` is supported in Arthas, e.g. `sm org.apache.log4j.Logger | grep <init>` Arthas provides `pipe` to process the result returned from commands further, e.g. `sm org.apache.log4j.Logger | grep <init>`. Commands supported in `pipe`:
Commands supported in `pipe`:
* grep - filtering * grep - filter the result with the given keyword
* plaintext - remove the color * plaintext - remove the color
* wc - line counting * wc - count lines
## async in background ## async in background
[async](async.md) will be a great help, when the `incident` seldom occurs and you are [`watch`](watch.md)ing it. [async](async.md) can be handy when a problem is hardly to reproduce in the production enviornment, e.g. one `watch` condition may happen only once in one single day.
* job control - use `>` to redirect result into the log file, use `&` to put the job to the background. Job keeps running even if the session is disconnected (the session lifecycle is 1 day by default)
* jobs - list all jobs * jobs - list all jobs
* kill - forcibly terminate the job * kill - forcibly terminate the job
* fg - bring the paused job back to the front * fg - bring the suspend job to the foreground
* bg - put the paused job to the background * bg - put the job to run in the background
* tips - a) use `>` to redirect the output; b) use `&` to put the job to the background; c) disconnecting the session will not influence the job (the default life is 1 day)
## Web Console
Arthas supports living inside a browser. The communication between arthas and browser is via websocket.
* [Web Console](web-console.md)
## Others ## Other features
* [Web Console](web-console.md) - using websocket to connect Arthas * [Async support](async.md)
* [log the output](save-log.md) * [log the output](save-log.md)
* [batch](batch-support.md) * [batch](batch-support.md)
* [how to use ognl](https://github.com/alibaba/arthas/issues/11) * [how to use ognl](https://github.com/alibaba/arthas/issues/11)

2
en/_sources/stack.md.txt
Unescape Escape View File

@ -1,7 +1,7 @@
stack stack
===== =====
Print out the full call stack trace containing the current method. Print out the full call stack trace *till* the current method.
Most of the time, we know the method being invoked but not always we know **HOW being invoked**; `stack` can be a great help to locate the *source* for you. Most of the time, we know the method being invoked but not always we know **HOW being invoked**; `stack` can be a great help to locate the *source* for you.

2
en/_sources/tt.md.txt
Unescape Escape View File

@ -112,7 +112,7 @@ Advanced:
### Check context of the call ### Check context of the call
Using `tt -i <index>` to check a specific record. Using `tt -i <index>` to check a specific calling details.
``` ```
$ $

2
en/_sources/web-console.md.txt
Unescape Escape View File

@ -1,7 +1,7 @@
Web Console Web Console
=== ===
Arthas supports the Web Console. After attach success, the user can access: [http://localhost:8563/] (http://localhost:8563/). Arthas supports the Web Console. After attach success, the user can access: [http://localhost:8563/](http://localhost:8563/).
The user can fill in the IP and connect the remote arthas on other machines. The user can fill in the IP and connect the remote arthas on other machines.

105
en/advanced-use.html
Unescape Escape View File

@ -31,7 +31,7 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" /> <link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="All Commands" href="commands.html" /> <link rel="next" title="Web Console" href="web-console.html" />
<link rel="prev" title="Quick Start" href="quick-start.html" /> <link rel="prev" title="Quick Start" href="quick-start.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -99,7 +99,17 @@
<li class="toctree-l2"><a class="reference internal" href="#options">options</a></li> <li class="toctree-l2"><a class="reference internal" href="#options">options</a></li>
<li class="toctree-l2"><a class="reference internal" href="#pipe">pipe</a></li> <li class="toctree-l2"><a class="reference internal" href="#pipe">pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="#async-in-background">async in background</a></li> <li class="toctree-l2"><a class="reference internal" href="#async-in-background">async in background</a></li>
<li class="toctree-l2"><a class="reference internal" href="#others">Others</a></li> <li class="toctree-l2"><a class="reference internal" href="#web-console">Web Console</a><ul>
<li class="toctree-l3"><a class="reference internal" href="web-console.html">Web Console</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#other-features">Other features</a><ul>
<li class="toctree-l3"><a class="reference internal" href="async.html">Async support</a></li>
<li class="toctree-l3"><a class="reference internal" href="save-log.html">log the output</a></li>
<li class="toctree-l3"><a class="reference internal" href="batch-support.html">batch</a></li>
<li class="toctree-l3"><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul>
</li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li> <li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
@ -179,84 +189,95 @@
<div class="section" id="basic"> <div class="section" id="basic">
<span id="basic"></span><h2>Basic<a class="headerlink" href="#basic" title="Permalink to this headline"></a></h2> <span id="basic"></span><h2>Basic<a class="headerlink" href="#basic" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li>help - show help info</li> <li>help - display Arthas help</li>
<li>cls - clear out the current screen</li> <li>cls - clear the screen</li>
<li>session - check details of the current session</li> <li>session - display current session information</li>
<li><a class="reference internal" href="reset.html"><span class="doc">reset</span></a> - reset all injected/enhanced classes</li> <li><a class="reference internal" href="reset.html"><span class="doc">reset</span></a> - reset all the enhanced classes. All enhanced classes will also be reset when Arthas server is closed by <code class="docutils literal notranslate"><span class="pre">shutdown</span></code></li>
<li>version - print the version of the Arthas attaching to the current target process</li> <li>version - print the version for the Arthas attached to the current Java process</li>
<li>quit/exit - exit the current Arthas client without affecting other clients</li> <li>quit/exit - exit the current Arthas session, without effecting other sessions</li>
<li>shutdown - terminate the Arthas server and all clients</li> <li>shutdown - terminate the Arthas server, all Arthas sessions will be destroyed</li>
<li><a class="reference internal" href="keymap.html"><span class="doc">keymap</span></a> - keymap for Arthas keyboard shortcut</li>
</ul> </ul>
</div> </div>
<div class="section" id="jvm"> <div class="section" id="jvm">
<span id="jvm"></span><h2>JVM<a class="headerlink" href="#jvm" title="Permalink to this headline"></a></h2> <span id="jvm"></span><h2>JVM<a class="headerlink" href="#jvm" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="dashboard.html"><span class="doc">dashboard</span></a> - real-time dashboard for the current system</li> <li><a class="reference internal" href="dashboard.html"><span class="doc">dashboard</span></a> - dashboard for the system’s real-time data</li>
<li><a class="reference internal" href="thread.html"><span class="doc">thread</span></a> - thread profile</li> <li><a class="reference internal" href="thread.html"><span class="doc">thread</span></a> - show java thread information</li>
<li><a class="reference internal" href="jvm.html"><span class="doc">jvm</span></a> - JVM profile</li> <li><a class="reference internal" href="jvm.html"><span class="doc">jvm</span></a> - show JVM information</li>
<li><a class="reference internal" href="sysprop.html"><span class="doc">sysprop</span></a> - check or modify JVM system properties</li> <li><a class="reference internal" href="sysprop.html"><span class="doc">sysprop</span></a> - show/modify system properties</li>
<li><strong>New!</strong> <a class="reference internal" href="getstatic.html"><span class="doc">getstatic</span></a> :clap: - check the static properties of classes</li> <li><strong>New!</strong> <a class="reference internal" href="getstatic.html"><span class="doc">getstatic</span></a> :clap: - examine class’s static properties</li>
</ul> </ul>
</div> </div>
<div class="section" id="class-classloader"> <div class="section" id="class-classloader">
<span id="class-classloader"></span><h2>class/classloader<a class="headerlink" href="#class-classloader" title="Permalink to this headline"></a></h2> <span id="class-classloader"></span><h2>class/classloader<a class="headerlink" href="#class-classloader" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="sc.html"><span class="doc">sc</span></a> - check profiles of the classes loaded by JVM</li> <li><a class="reference internal" href="sc.html"><span class="doc">sc</span></a> - check the info for the classes loaded by JVM</li>
<li><a class="reference internal" href="sm.html"><span class="doc">sm</span></a> - check methods’ profile</li> <li><a class="reference internal" href="sm.html"><span class="doc">sm</span></a> - check methods info for the loaded classes</li>
<li><a class="reference internal" href="dump.html"><span class="doc">dump</span></a> - dump out the byte code of the loaded classes to specified location</li> <li><a class="reference internal" href="dump.html"><span class="doc">dump</span></a> - dump the loaded classes in byte code to the specified location</li>
<li><a class="reference internal" href="redefine.html"><span class="doc">redefine</span></a> - load external <code class="docutils literal notranslate"><span class="pre">*.class</span></code> files and re-define the JVM-loaded classes</li> <li><a class="reference internal" href="redefine.html"><span class="doc">redefine</span></a> - load external <code class="docutils literal notranslate"><span class="pre">*.class</span></code> files and re-define it into JVM</li>
<li><a class="reference internal" href="jad.html"><span class="doc">jad</span></a> - de-compile the specified loaded classes</li> <li><a class="reference internal" href="jad.html"><span class="doc">jad</span></a> - de-compile the specified loaded classes</li>
<li><a class="reference internal" href="classloader.html"><span class="doc">classloader</span></a> - check the inheritance structure, urls, class loading info of class cloader; using classloader to get the url of the resource e.g. <code class="docutils literal notranslate"><span class="pre">java/lang/String.class</span></code></li> <li><a class="reference internal" href="classloader.html"><span class="doc">classloader</span></a> - check the inheritance structure, urls, class loading info for the specified class; using classloader to get the url of the resource e.g. <code class="docutils literal notranslate"><span class="pre">java/lang/String.class</span></code></li>
</ul> </ul>
</div> </div>
<div class="section" id="monitor-watch-trace-related"> <div class="section" id="monitor-watch-trace-related">
<span id="monitor-watch-trace-related"></span><h2>monitor/watch/trace - related<a class="headerlink" href="#monitor-watch-trace-related" title="Permalink to this headline"></a></h2> <span id="monitor-watch-trace-related"></span><h2>monitor/watch/trace - related<a class="headerlink" href="#monitor-watch-trace-related" title="Permalink to this headline"></a></h2>
<blockquote> <blockquote>
<div><strong>Attention</strong>: commands here are taking advantage of <code class="docutils literal notranslate"><span class="pre">byte</span> <span class="pre">code</span> <span class="pre">injection</span></code>, which means we are using <a class="reference external" href="https://en.wikipedia.org/wiki/Aspect-oriented_programming">AOP</a> to monitor and analyze the classes. So when using it for online troubleshooting, you’d better <em>explicitly specifically</em> specify the classes and also remember to remove the injected code by <code class="docutils literal notranslate"><span class="pre">shutdown</span></code> or <code class="docutils literal notranslate"><span class="pre">reset</span></code>.</div></blockquote> <div><strong>Attention</strong>: commands here are taking advantage of byte-code-injection, which means we are injecting some <a class="reference external" href="https://en.wikipedia.org/wiki/Aspect-oriented_programming">aspects</a> into the current classes for monitoring and statistics purpose. Therefore when use it for online troubleshooting in your production environment, you’d better <strong>explicitly specify</strong> classes/methods/criteria, and remember to remove the injected code by <code class="docutils literal notranslate"><span class="pre">shutdown</span></code> or <code class="docutils literal notranslate"><span class="pre">reset</span></code>.</div></blockquote>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="monitor.html"><span class="doc">monitor</span></a> - monitor the <code class="docutils literal notranslate"><span class="pre">class-pattern</span></code> &amp; <code class="docutils literal notranslate"><span class="pre">method-pattern</span></code> matched methods’ invoking traces</li> <li><a class="reference internal" href="monitor.html"><span class="doc">monitor</span></a> - monitor method execution statistics</li>
<li><a class="reference internal" href="watch.html"><span class="doc">watch</span></a> - watch/monitor methods in data aspect including <code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">values</span></code>, <code class="docutils literal notranslate"><span class="pre">exceptions</span></code> and <code class="docutils literal notranslate"><span class="pre">parameters</span></code></li> <li><a class="reference internal" href="watch.html"><span class="doc">watch</span></a> - display the input/output parameter, return object, and thrown exception of specified method invocation</li>
<li><a class="reference internal" href="trace.html"><span class="doc">trace</span></a> - track the method calling trace along with the time cost for each call</li> <li><a class="reference internal" href="trace.html"><span class="doc">trace</span></a> - trace the execution time of specified method invocation</li>
<li><a class="reference internal" href="stack.html"><span class="doc">stack</span></a> - print the call stack trace of the current method in a persistent way</li> <li><a class="reference internal" href="stack.html"><span class="doc">stack</span></a> - display the stack trace for the specified class and method</li>
<li><a class="reference internal" href="tt.html"><span class="doc">tt</span></a> - record the arguments and returned value for the methods, history included</li> <li><a class="reference internal" href="tt.html"><span class="doc">tt</span></a> - time tunnel, record the arguments and returned value for the methods and replay</li>
</ul> </ul>
</div> </div>
<div class="section" id="options"> <div class="section" id="options">
<span id="options"></span><h2>options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2> <span id="options"></span><h2>options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<ul class="simple"> <ul class="simple">
<li><a class="reference internal" href="options.html"><span class="doc">options</span></a> - check or set Arthas global options</li> <li><a class="reference internal" href="options.html"><span class="doc">options</span></a> - check/set Arthas global options</li>
</ul> </ul>
</div> </div>
<div class="section" id="pipe"> <div class="section" id="pipe">
<span id="pipe"></span><h2>pipe<a class="headerlink" href="#pipe" title="Permalink to this headline"></a></h2> <span id="pipe"></span><h2>pipe<a class="headerlink" href="#pipe" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pipe</span></code> is supported in Arthas, e.g. <code class="docutils literal notranslate"><span class="pre">sm</span> <span class="pre">org.apache.log4j.Logger</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">&lt;init&gt;</span></code></p> <p>Arthas provides <code class="docutils literal notranslate"><span class="pre">pipe</span></code> to process the result returned from commands further, e.g. <code class="docutils literal notranslate"><span class="pre">sm</span> <span class="pre">org.apache.log4j.Logger</span> <span class="pre">|</span> <span class="pre">grep</span> <span class="pre">&lt;init&gt;</span></code>. Commands supported in <code class="docutils literal notranslate"><span class="pre">pipe</span></code>:</p>
<p>Commands supported in <code class="docutils literal notranslate"><span class="pre">pipe</span></code>:</p>
<ul class="simple"> <ul class="simple">
<li>grep - filtering</li> <li>grep - filter the result with the given keyword</li>
<li>plaintext - remove the color</li> <li>plaintext - remove the color</li>
<li>wc - line counting</li> <li>wc - count lines</li>
</ul> </ul>
</div> </div>
<div class="section" id="async-in-background"> <div class="section" id="async-in-background">
<span id="async-in-background"></span><h2>async in background<a class="headerlink" href="#async-in-background" title="Permalink to this headline"></a></h2> <span id="async-in-background"></span><h2>async in background<a class="headerlink" href="#async-in-background" title="Permalink to this headline"></a></h2>
<p><a class="reference internal" href="async.html"><span class="doc">async</span></a> will be a great help, when the <code class="docutils literal notranslate"><span class="pre">incident</span></code> seldom occurs and you are <a class="reference external" href="watch.md"><code class="docutils literal notranslate"><span class="pre">watch</span></code></a>ing it.</p> <p><a class="reference internal" href="async.html"><span class="doc">async</span></a> can be handy when a problem is hardly to reproduce in the production enviornment, e.g. one <code class="docutils literal notranslate"><span class="pre">watch</span></code> condition may happen only once in one single day.</p>
<ul class="simple"> <ul class="simple">
<li>job control - use <code class="docutils literal notranslate"><span class="pre">&gt;</span></code> to redirect result into the log file, use <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> to put the job to the background. Job keeps running even if the session is disconnected (the session lifecycle is 1 day by default)</li>
<li>jobs - list all jobs</li> <li>jobs - list all jobs</li>
<li>kill - forcibly terminate the job</li> <li>kill - forcibly terminate the job</li>
<li>fg - bring the paused job back to the front</li> <li>fg - bring the suspend job to the foreground</li>
<li>bg - put the paused job to the background</li> <li>bg - put the job to run in the background</li>
<li>tips - a) use <code class="docutils literal notranslate"><span class="pre">&gt;</span></code> to redirect the output; b) use <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> to put the job to the background; c) disconnecting the session will not influence the job (the default life is 1 day)</li>
</ul> </ul>
</div> </div>
<div class="section" id="others"> <div class="section" id="web-console">
<span id="others"></span><h2>Others<a class="headerlink" href="#others" title="Permalink to this headline"></a></h2> <span id="web-console"></span><h2>Web Console<a class="headerlink" href="#web-console" title="Permalink to this headline"></a></h2>
<ul class="simple"> <p>Arthas supports living inside a browser. The communication between arthas and browser is via websocket.</p>
<li><a class="reference internal" href="web-console.html"><span class="doc">Web Console</span></a> - using websocket to connect Arthas</li> <div class="toctree-wrapper compound">
<li><a class="reference internal" href="save-log.html"><span class="doc">log the output</span></a></li> <ul>
<li><a class="reference internal" href="batch-support.html"><span class="doc">batch</span></a></li> <li class="toctree-l1"><a class="reference internal" href="web-console.html">Web Console</a></li>
<li><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul> </ul>
</div> </div>
</div>
<div class="section" id="other-features">
<span id="other-features"></span><h2>Other features<a class="headerlink" href="#other-features" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="async.html">Async support</a></li>
<li class="toctree-l1"><a class="reference internal" href="save-log.html">log the output</a></li>
<li class="toctree-l1"><a class="reference internal" href="batch-support.html">batch</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul>
</div>
</div>
</div> </div>
@ -267,7 +288,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="commands.html" class="btn btn-neutral float-right" title="All Commands" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="web-console.html" class="btn btn-neutral float-right" title="Web Console" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="quick-start.html" class="btn btn-neutral" title="Quick Start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="quick-start.html" class="btn btn-neutral" title="Quick Start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

43
en/async.html
Unescape Escape View File

@ -31,6 +31,8 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" /> <link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Log command outputs" href="save-log.html" />
<link rel="prev" title="Web Console" href="web-console.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -86,10 +88,36 @@
<ul> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</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="quick-start.html">Quick start</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="advanced-use.html">Advanced usage</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#jvm">JVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#class-classloader">class/classloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#monitor-watch-trace-related">monitor/watch/trace - related</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#options">options</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#pipe">pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#async-in-background">async in background</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#web-console">Web Console</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="advanced-use.html#other-features">Other features</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Async support</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#use-to-run-the-command-in-the-background">1. Use &amp; to run the command in the background</a></li>
<li class="toctree-l4"><a class="reference internal" href="#list-background-jobs">2. List background jobs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#suspend-and-cannel-job">3. Suspend and Cannel job</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fg-bg-bring-a-background-job-to-the-foreground-restart-a-stopped-background-job">4. fg/bg, Bring a background job to the foreground/Restart a stopped background job</a></li>
<li class="toctree-l4"><a class="reference internal" href="#redirect-the-job-output">5. Redirect the job output</a></li>
<li class="toctree-l4"><a class="reference internal" href="#stop-job">6. Stop job</a></li>
<li class="toctree-l4"><a class="reference internal" href="#others">7. Others</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="save-log.html">log the output</a></li>
<li class="toctree-l3"><a class="reference internal" href="batch-support.html">batch</a></li>
<li class="toctree-l3"><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</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%3Auser-case">User cases</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 internal" href="release-notes.html">Release Notes</a></li>
@ -141,6 +169,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="advanced-use.html">Advanced Usage</a> &raquo;</li>
<li>Arthas Async Jobs</li> <li>Arthas Async Jobs</li>
@ -244,6 +274,15 @@ cache location : /Users/gehui/logs/arthas-cache/28198/2
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="save-log.html" class="btn btn-neutral float-right" title="Log command outputs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="web-console.html" class="btn btn-neutral" title="Web Console" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/> <hr/>

37
en/batch-support.html
Unescape Escape View File

@ -31,6 +31,8 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" /> <link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="All Commands" href="commands.html" />
<link rel="prev" title="Log command outputs" href="save-log.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -86,10 +88,30 @@
<ul> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</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="quick-start.html">Quick start</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="advanced-use.html">Advanced usage</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#jvm">JVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#class-classloader">class/classloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#monitor-watch-trace-related">monitor/watch/trace - related</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#options">options</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#pipe">pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#async-in-background">async in background</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#web-console">Web Console</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="advanced-use.html#other-features">Other features</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="async.html">Async support</a></li>
<li class="toctree-l3"><a class="reference internal" href="save-log.html">log the output</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">batch</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</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%3Auser-case">User cases</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 internal" href="release-notes.html">Release Notes</a></li>
@ -141,6 +163,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="advanced-use.html">Advanced Usage</a> &raquo;</li>
<li>Batch Processing</li> <li>Batch Processing</li>
@ -208,6 +232,15 @@ sc -d org.apache.commons.lang.StringUtils
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="commands.html" class="btn btn-neutral float-right" title="All Commands" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="save-log.html" class="btn btn-neutral" title="Log command outputs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/> <hr/>

4
en/commands.html
Unescape Escape View File

@ -32,7 +32,7 @@
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="dashboard" href="dashboard.html" /> <link rel="next" title="dashboard" href="dashboard.html" />
<link rel="prev" title="Advanced Usage" href="advanced-use.html" /> <link rel="prev" title="Batch Processing" href="batch-support.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -233,7 +233,7 @@
<a href="dashboard.html" class="btn btn-neutral float-right" title="dashboard" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="dashboard.html" class="btn btn-neutral float-right" title="dashboard" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="advanced-use.html" class="btn btn-neutral" title="Advanced Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> <a href="batch-support.html" class="btn btn-neutral" title="Batch Processing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div> </div>

37
en/save-log.html
Unescape Escape View File

@ -31,6 +31,8 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" /> <link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Batch Processing" href="batch-support.html" />
<link rel="prev" title="Arthas Async Jobs" href="async.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -86,10 +88,30 @@
<ul> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</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="quick-start.html">Quick start</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="advanced-use.html">Advanced usage</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#jvm">JVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#class-classloader">class/classloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#monitor-watch-trace-related">monitor/watch/trace - related</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#options">options</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#pipe">pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#async-in-background">async in background</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#web-console">Web Console</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="advanced-use.html#other-features">Other features</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="async.html">Async support</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">log the output</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#asynchronous-log">Asynchronous log</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="batch-support.html">batch</a></li>
<li class="toctree-l3"><a class="reference external" href="https://github.com/alibaba/arthas/issues/11">how to use ognl</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</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%3Auser-case">User cases</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 internal" href="release-notes.html">Release Notes</a></li>
@ -141,6 +163,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="advanced-use.html">Advanced Usage</a> &raquo;</li>
<li>Log command outputs</li> <li>Log command outputs</li>
@ -202,6 +226,15 @@ cache location : /Users/zhuyong/logs/arthas-cache/28198/2
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="batch-support.html" class="btn btn-neutral float-right" title="Batch Processing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="async.html" class="btn btn-neutral" title="Arthas Async Jobs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/> <hr/>

2
en/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
en/stack.html
Unescape Escape View File

@ -197,7 +197,7 @@
<div class="section" id="stack"> <div class="section" id="stack">
<span id="stack"></span><h1>stack<a class="headerlink" href="#stack" title="Permalink to this headline"></a></h1> <span id="stack"></span><h1>stack<a class="headerlink" href="#stack" title="Permalink to this headline"></a></h1>
<p>Print out the full call stack trace containing the current method.</p> <p>Print out the full call stack trace <em>till</em> the current method.</p>
<p>Most of the time, we know the method being invoked but not always we know <strong>HOW being invoked</strong>; <code class="docutils literal notranslate"><span class="pre">stack</span></code> can be a great help to locate the <em>source</em> for you.</p> <p>Most of the time, we know the method being invoked but not always we know <strong>HOW being invoked</strong>; <code class="docutils literal notranslate"><span class="pre">stack</span></code> can be a great help to locate the <em>source</em> for you.</p>
<div class="section" id="parameters"> <div class="section" id="parameters">
<span id="parameters"></span><h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline"></a></h2> <span id="parameters"></span><h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline"></a></h2>

2
en/tt.html
Unescape Escape View File

@ -349,7 +349,7 @@ $
</div> </div>
<div class="section" id="check-context-of-the-call"> <div class="section" id="check-context-of-the-call">
<span id="check-context-of-the-call"></span><h2>Check context of the call<a class="headerlink" href="#check-context-of-the-call" title="Permalink to this headline"></a></h2> <span id="check-context-of-the-call"></span><h2>Check context of the call<a class="headerlink" href="#check-context-of-the-call" title="Permalink to this headline"></a></h2>
<p>Using <code class="docutils literal notranslate"><span class="pre">tt</span> <span class="pre">-i</span> <span class="pre">&lt;index&gt;</span></code> to check a specific record.</p> <p>Using <code class="docutils literal notranslate"><span class="pre">tt</span> <span class="pre">-i</span> <span class="pre">&lt;index&gt;</span></code> to check a specific calling details.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$
$ tt -i 1003 $ tt -i 1003
+-----------------+------------------------------------------------------------------------------------------------------+ +-----------------+------------------------------------------------------------------------------------------------------+

33
en/web-console.html
Unescape Escape View File

@ -31,6 +31,8 @@
<link rel="stylesheet" href="_static/overrides.css" type="text/css" /> <link rel="stylesheet" href="_static/overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Arthas Async Jobs" href="async.html" />
<link rel="prev" title="Advanced Usage" href="advanced-use.html" />
<script src="_static/center_page.js"></script> <script src="_static/center_page.js"></script>
@ -86,10 +88,24 @@
<ul> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">Installation</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="quick-start.html">Quick start</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="advanced-use.html">Advanced usage</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#basic">Basic</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#jvm">JVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#class-classloader">class/classloader</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#monitor-watch-trace-related">monitor/watch/trace - related</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#options">options</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#pipe">pipe</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#async-in-background">async in background</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="advanced-use.html#web-console">Web Console</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Web Console</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advanced-use.html#other-features">Other features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</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%3Auser-case">User cases</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 internal" href="release-notes.html">Release Notes</a></li>
@ -141,6 +157,8 @@
<li><a href="index.html">Docs</a> &raquo;</li> <li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="advanced-use.html">Advanced Usage</a> &raquo;</li>
<li>Web Console</li> <li>Web Console</li>
@ -164,7 +182,7 @@
<div class="section" id="web-console"> <div class="section" id="web-console">
<span id="web-console"></span><h1>Web Console<a class="headerlink" href="#web-console" title="Permalink to this headline"></a></h1> <span id="web-console"></span><h1>Web Console<a class="headerlink" href="#web-console" title="Permalink to this headline"></a></h1>
<p>Arthas supports the Web Console. After attach success, the user can access: [http://localhost:8563/] (http://localhost:8563/).</p> <p>Arthas supports the Web Console. After attach success, the user can access: <a class="reference external" href="http://localhost:8563/">http://localhost:8563/</a>.</p>
<p>The user can fill in the IP and connect the remote arthas on other machines.</p> <p>The user can fill in the IP and connect the remote arthas on other machines.</p>
<p><img alt="web console" src="_images/web-console-local.png" /></p> <p><img alt="web console" src="_images/web-console-local.png" /></p>
<p>If you have suggestions for the Web Console, please leave a message here: <a class="reference external" href="https://github.com/alibaba/arthas/issues/15">https://github.com/alibaba/arthas/issues/15</a></p> <p>If you have suggestions for the Web Console, please leave a message here: <a class="reference external" href="https://github.com/alibaba/arthas/issues/15">https://github.com/alibaba/arthas/issues/15</a></p>
@ -176,6 +194,15 @@
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="async.html" class="btn btn-neutral float-right" title="Arthas Async Jobs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="advanced-use.html" class="btn btn-neutral" title="Advanced Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/> <hr/>

Write Preview
Loading…
Cancel
Save