github/arthas
4
0 Fork 0
mirror of https://github.com/alibaba/arthas.git synced 2026-11-08 00:36:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

update doc 3.1.2

Browse Source
This commit is contained in:
hengyunabc committed 2019-09-09 14:49:55 +08:00
1 parent 1afcb5035d
commit 39091052c1
206 files changed
+8994 -6117
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

en/save-log.html
+36 -50
View File
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Log command outputs &mdash; Arthas 3.1.1 documentation</title>
<title>Log command outputs &mdash; Arthas 3.1.2 documentation</title>
@@ -19,13 +19,20 @@
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/overrides.css" type="text/css" />
@@ -37,21 +44,16 @@
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/github.min.css">
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div class="wy-side-nav-search" >
@@ -65,7 +67,7 @@
<div class="version">
3.1.1
3.1.2
</div>
@@ -92,6 +94,7 @@
<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 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>
@@ -115,12 +118,13 @@
</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="web-console.html">WebConsole</a></li>
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Auser-case">User cases</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered">Questions and answers</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Fork me at GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md">CONTRIBUTING</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING">Compile and debug/CONTRIBUTING</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/releases">Release Notes</a></li>
</ul>
@@ -190,35 +194,34 @@
<div itemprop="articleBody">
<div class="section" id="log-command-outputs">
<span id="log-command-outputs"></span><h1>Log command outputs<a class="headerlink" href="#log-command-outputs" title="Permalink to this headline"></a></h1>
<h1>Log command outputs<a class="headerlink" href="#log-command-outputs" title="Permalink to this headline"></a></h1>
<blockquote>
<div>Log command outputs for later analysis</div></blockquote>
<div><p>Log command outputs for later analysis</p>
</div></blockquote>
<ul>
<li><p class="first">By default, this behavior is turned off. To enable it, execute the command below:</p>
<li><p>By default, this behavior is turned off. To enable it, execute the command below:</p>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ options save-result true
NAME BEFORE-VALUE AFTER-VALUE
----------------------------------------
save-result false true
Affect(row-cnt:1) cost in 3 ms.
</pre></div>
Affect(row-cnt:1) cost in 3 ms.</pre></div>
</div>
<p>If the message above is output on the console, then this behavior is enabled successfully.</p>
</li>
<li><p class="first">Log file path</p>
<p>The command execution result will be save in <tt class="docutils literal">{user.home}/logs/arthas-cache/result.log</tt>. Pls. clean it up regularly to save disk space.</p>
<li><p>Log file path</p>
<p>The command execution result will be save in <code class="docutils literal notranslate"><span class="pre">{user.home}/logs/arthas-cache/result.log</span></code>. Pls. clean it up regularly to save disk space.</p>
</li>
</ul>
<div class="section" id="use-asynchronous-job-to-log">
<span id="use-asynchronous-job-to-log"></span><h2>Use asynchronous job to log<a class="headerlink" href="#use-asynchronous-job-to-log" title="Permalink to this headline"></a></h2>
<h2>Use asynchronous job to log<a class="headerlink" href="#use-asynchronous-job-to-log" title="Permalink to this headline"></a></h2>
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">$ trace Test t &gt;&gt; &amp;
job id : 2
cache location : /Users/zhuyong/logs/arthas-cache/28198/2
</pre></div>
cache location : /Users/zhuyong/logs/arthas-cache/28198/2</pre></div>
</div>
<p>By doing this, the command will run at background asynchronously, and output the execution result into <tt class="docutils literal">~/logs/arthas-cache/{PID}/{JobId}</tt>:</p>
<p>By doing this, the command will run at background asynchronously, and output the execution result into <code class="docutils literal notranslate"><span class="pre">~/logs/arthas-cache/{PID}/{JobId}</span></code>:</p>
<ul class="simple">
<li>The background job will continue to run even if the current session is disconnected. The default job timeout value is 1 day, use global ‘<a class="reference internal" href="options.html"><span class="doc">options</span></a>’ command to alternate it.</li>
<li>The execution result will be output into the file asynchronously. Pls. note the behavior of this command is not controlled by <tt class="docutils literal">save-result</tt> option from global <a class="reference internal" href="options.html"><span class="doc">options</span></a>. No matter <tt class="docutils literal">save-result</tt> is set to <tt class="docutils literal">true</tt> or not, this command will write into <tt class="docutils literal">~/logs/arthas-cache/{PID}/{JobId}</tt> anyway, instead of into <tt class="docutils literal">~/logs/arthas-cache/result.log</tt>.</li>
<li><p>The background job will continue to run even if the current session is disconnected. The default job timeout value is 1 day, use global ‘<a class="reference internal" href="options.html"><span class="doc">options</span></a>’ command to alternate it.</p></li>
<li><p>The execution result will be output into the file asynchronously. Pls. note the behavior of this command is not controlled by <code class="docutils literal notranslate"><span class="pre">save-result</span></code> option from global <a class="reference internal" href="options.html"><span class="doc">options</span></a>. No matter <code class="docutils literal notranslate"><span class="pre">save-result</span></code> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code> or not, this command will write into <code class="docutils literal notranslate"><span class="pre">~/logs/arthas-cache/{PID}/{JobId}</span></code> anyway, instead of into <code class="docutils literal notranslate"><span class="pre">~/logs/arthas-cache/result.log</span></code>.</p></li>
</ul>
</div>
</div>
@@ -234,7 +237,7 @@ cache location : /Users/zhuyong/logs/arthas-cache/28198/2
<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>
<a href="async.html" class="btn btn-neutral float-left" title="Arthas Async Jobs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -243,7 +246,7 @@ cache location : /Users/zhuyong/logs/arthas-cache/28198/2
<div role="contentinfo">
<p>
&copy; Copyright 2018-2019, Alibaba Middleware Group, and contributors.
&copy; Copyright 2018-2019, Alibaba Middleware Group, and contributors
</p>
</div>
@@ -260,33 +263,16 @@ cache location : /Users/zhuyong/logs/arthas-cache/28198/2
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'3.1.1',
LANGUAGE:'en',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="github-fork-ribbon-wrapper right">
<div class="github-fork-ribbon">
<a href="https://github.com/alibaba/arthas" target="_blank">Fork me at GitHub</a>