You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
arthas/en/doc/start-arthas.html

59 lines
66 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
3 years ago
<meta name="generator" content="VuePress 2.0.0-beta.51">
<style>
:root {
--c-bg: #fff;
}
html.dark {
--c-bg: #22272e;
}
html, body {
background-color: var(--c-bg);
}
</style>
<script>
const userMode = localStorage.getItem('vuepress-color-scheme');
const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
document.documentElement.classList.toggle('dark', true);
}
</script>
3 years ago
<link rel="icon" href="/images/favicon.ico"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:title" content="Arthas"><meta property="og:image:alt" content="Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas - alibaba/arthas: Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas"><meta property="og:image" content="/images/arthas_mate_image.png"><meta property="og:description" content="Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas - alibaba/arthas: Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas"><meta property="og:image:width" content="1200"><meta property="og:image:height" content="600"><meta property="twitter:image:src" content="/images/arthas_mate_image.png"><meta property="twitter:image:alt" content="Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas - alibaba/arthas: Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas"><meta itemprop="name" content="Arthas"><meta itemprop="image" content="/images/arthas_mate_image.png"><meta itemprop="description" content="Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas - alibaba/arthas: Alibaba Java Diagnostic Tool Arthas/Alibaba Java诊断利器Arthas"><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);
})();
2 years ago
</script><meta name="aes-config" content="pid=xux-opensource&user_type=101&uid=&username=&dim10=arthas"><script src="//g.alicdn.com/alilog/mlog/aplus_v2.js" id="beacon-aplus" exparams="clog=o&aplus&sidx=aplusSidx&ckx=aplusCkx"></script><script src="//g.alicdn.com/aes/??tracker/1.0.34/index.js,tracker-plugin-pv/2.4.5/index.js,tracker-plugin-event/1.2.5/index.js,tracker-plugin-jserror/1.0.13/index.js,tracker-plugin-api/1.1.14/index.js,tracker-plugin-perf/1.1.8/index.js,tracker-plugin-eventTiming/1.0.4/index.js"></script><title>Start Arthas | arthas</title><meta name="description" content="arthas user document">
2 years ago
<link rel="modulepreload" href="/assets/app.170c6bb7.js"><link rel="modulepreload" href="/assets/start-arthas.html.45712bf7.js"><link rel="modulepreload" href="/assets/start-arthas.html.853fb346.js"><link rel="prefetch" href="/assets/index.html.027a535c.js"><link rel="prefetch" href="/assets/index.html.f4fc56b4.js"><link rel="prefetch" href="/assets/index.html.4fabef9a.js"><link rel="prefetch" href="/assets/advanced-use.html.a364a077.js"><link rel="prefetch" href="/assets/advice-class.html.1e16b78a.js"><link rel="prefetch" href="/assets/agent.html.ea4b4c17.js"><link rel="prefetch" href="/assets/arthas-properties.html.3c6dd837.js"><link rel="prefetch" href="/assets/arthas3.html.653e03bd.js"><link rel="prefetch" href="/assets/async.html.c7f2ec88.js"><link rel="prefetch" href="/assets/auth.html.976ea268.js"><link rel="prefetch" href="/assets/base64.html.0ce179d7.js"><link rel="prefetch" href="/assets/batch-support.html.a8ea483a.js"><link rel="prefetch" href="/assets/cat.html.57193482.js"><link rel="prefetch" href="/assets/classloader.html.1cccb103.js"><link rel="prefetch" href="/assets/cls.html.9cc716a2.js"><link rel="prefetch" href="/assets/commands.html.9b04eeb3.js"><link rel="prefetch" href="/assets/contact-us.html.4b75bb12.js"><link rel="prefetch" href="/assets/dashboard.html.471cdbf0.js"><link rel="prefetch" href="/assets/docker.html.eef4a9b6.js"><link rel="prefetch" href="/assets/download.html.ff354b6f.js"><link rel="prefetch" href="/assets/dump.html.c72d4940.js"><link rel="prefetch" href="/assets/echo.html.49af5ef2.js"><link rel="prefetch" href="/assets/faq.html.75378aba.js"><link rel="prefetch" href="/assets/getstatic.html.dafe19bf.js"><link rel="prefetch" href="/assets/grep.html.1d94643c.js"><link rel="prefetch" href="/assets/groovy.html.982837a9.js"><link rel="prefetch" href="/assets/heapdump.html.770781d7.js"><link rel="prefetch" href="/assets/help.html.509b4db6.js"><link rel="prefetch" href="/assets/history.html.24c98bc1.js"><link rel="prefetch" href="/assets/http-api.html.c0834238.js"><link rel="prefetch" href="/assets/idea-plugin.html.ec624e96.js"><link rel="prefetch" href="/assets/install-detail.html.76d1df70.js"><link rel="prefetch" href="/assets/jad.html.f02068c8.js"><link rel="prefetch" href="/assets/jfr.html.0b62ef92.js"><link rel="prefetch" href="/assets/jvm.html.9b6cb899.js"><link rel="prefetch" href="/assets/keymap.html.a8e445a7.js"><link rel="prefetch" href="/assets/logger.html.635d0790.js"><link rel="prefetch" href="/assets/manual-install.html.c49561b2.js"><link rel="prefetch" href="/assets/mbean.html.c09c879d.js"><link rel="prefetch" href="/assets/mc.html.d9028bda.js"><link rel="prefetch" href="/assets/memory.html.953a0d4f.js"><link rel="prefetch" href="/assets/monitor.html.7df88e93.js"><link rel="prefetch" href="/assets/ognl.html.aa12b486.js"><link rel="prefetch" href="/assets/options.html.0348e01c.js"><link rel="prefetch" href="/assets/perfcounter.html.098c9c9e.js"><link rel="prefetch" href="/assets/profiler.html.8be69b54.js"><link rel="prefetch" href="/assets/pwd.html.713f9c32.js"><link rel="prefetch" href="/assets/quick-start.html.be359054.js"><link rel="prefetch" href="/assets/quit.html.02ca41a5.js"><link rel="prefetch" href="/assets/redefine.html.5a9b270a.js"><link rel="prefetch" href="/assets/release-notes.html.a57b43af.js"><link rel="prefetch" href="/assets/reset.html.9c4606b8.js"><link rel="prefetch" href="/assets/retransform.html.6e43ccc9.js"><link rel="prefetch" href="/assets/save-log.html.8bdd55ac.js"><link rel="prefetch" href="/assets/sc.html.a90007ab.js"><link rel="prefetch" href="/assets/session.html.e6db1dfb.js"><link rel="prefetch" href="/assets/sm.html.24ba31c4.js"><link rel="prefetch" href="/assets/spring-boot-starter.html.b19d8a00.js"><link rel="prefetch" href="/assets/stack.html.466606a8.js"><link rel="prefetch" href="/assets/start-arthas.html.b89051d7.js"><link rel="prefetch" href="/assets/stop.html.31f63c78.js"><link rel="prefetch" href="/assets/sysenv.html.bac684ed.js"><link rel="prefetch" href="/assets/sysprop.html.85801cda.js"><link rel="prefetch" href="/assets/tee.htm
3 years ago
<link rel="stylesheet" href="/assets/style.da1934a3.css">
</head>
<body>
2 years ago
<div id="app"><!--[--><div class="theme-container"><!--[--><header class="navbar"><div class="toggle-sidebar-button" title="toggle sidebar" aria-expanded="false" role="button" tabindex="0"><div class="icon" aria-hidden="true"><span></span><span></span><span></span></div></div><span><a href="/en/" class="" data-v-61144abc><!----><span class="site-name can-hide" data-v-61144abc>arthas</span><span class="navbar-version" data-v-61144abc>v3.7.0</span></a></span><div class="navbar-items-wrapper" style=""><!--[--><!--]--><nav class="navbar-items can-hide"><!--[--><div class="navbar-item"><a href="/en/" class="" aria-label="HOME"><!--[--><!--]--> HOME <!--[--><!--]--></a></div><div class="navbar-item"><a class="external-link" href="/doc/arthas-tutorials.html?language=en&amp;id=arthas-basics" rel="noopener noreferrer" target="_blank" aria-label="ONLINE TUTORIALS"><!--[--><!--]--><span>ONLINE TUTORIALS</span><span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!--[--><!--]--></a></div><div class="navbar-item"><a href="/en/doc" class="router-link-active" aria-label="DOCS"><!--[--><!--]--> DOCS <!--[--><!--]--></a></div><div class="navbar-item"><a href="/en/doc/commands.md" class="" aria-label="COMMANDS"><!--[--><!--]--> COMMANDS <!--[--><!--]--></a></div><div class="navbar-item"><a href="/en/doc/download.md" class="" aria-label="DOWNLOAD"><!--[--><!--]--> DOWNLOAD <!--[--><!--]--></a></div><div class="navbar-item"><div class="navbar-dropdown-wrapper"><button class="navbar-dropdown-title" type="button" aria-label="SOLUTIONS"><span class="title">SOLUTIONS</span><span class="arrow down"></span></button><button class="navbar-dropdown-title-mobile" type="button" aria-label="SOLUTIONS"><span class="title">SOLUTIONS</span><span class="right arrow"></span></button><ul style="display:none;" class="navbar-dropdown"><!--[--><li class="navbar-dropdown-item"><a class="external-link" href="https://cn.aliyun.com/product/aliware/mse?spm=arthas.topbar.0.0.0" rel="noopener noreferrer" target="_blank" aria-label="Microservice solutions"><!--[--><!--]--><span>Microservice solutions</span><span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!--[--><!--]--></a></li><li class="navbar-dropdown-item"><a class="external-link" href="https://www.aliyun.com/aliware/txc?spm=arthas.topbar.0.0.0" rel="noopener noreferrer" target="_blank" aria-label="Distributed transaction solutions"><!--[--><!--]--><span>Distributed transaction solutions</span><span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!--[--><!--]--></a></li><li class="navbar-dropdown-item"><a class="external-link" href="https://www.aliyun.com/product/aha
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-bash ext-sh line-numbers-mode"><pre class="language-bash"><code>➜ bin git:<span class="token punctuation">(</span>develop<span class="token punctuation">)</span> ✗ ./as.sh
3 years ago
Found existing <span class="token function">java</span> process, please choose one and input the serial number of the process, eg <span class="token builtin class-name">:</span> <span class="token number">1</span>. Then hit ENTER.
<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span>: <span class="token number">3088</span> org.jetbrains.idea.maven.server.RemoteMavenServer
* <span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span>: <span class="token number">12872</span> org.apache.catalina.startup.Bootstrap
<span class="token punctuation">[</span><span class="token number">3</span><span class="token punctuation">]</span>: <span class="token number">2455</span>
Attaching to <span class="token number">12872</span><span class="token punctuation">..</span>.
,---. ,------. ,--------.,--. ,--. ,---. ,---.
/ O <span class="token punctuation">\</span> <span class="token operator">|</span> .--. <span class="token string">&#39;&#39;</span>--. .--<span class="token string">&#39;| &#39;</span>--<span class="token string">&#39; | / O \ &#39;</span> .-<span class="token string">&#39;
| .-. || &#39;</span>--<span class="token string">&#39;.&#39;</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span> .--. <span class="token operator">||</span> .-. <span class="token operator">|</span><span class="token variable"><span class="token variable">`</span><span class="token builtin class-name">.</span> <span class="token variable">`</span></span>-.
<span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">||</span> <span class="token operator">|</span><span class="token punctuation">\</span> <span class="token punctuation">\</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">||</span> <span class="token operator">|</span> <span class="token operator">|</span> <span class="token operator">|</span>.-<span class="token string">&#39; |
`--&#39;</span> <span class="token variable"><span class="token variable">`</span>--&#39;<span class="token variable">`</span></span>--<span class="token string">&#39; &#39;</span>--<span class="token string">&#39; `--&#39;</span> <span class="token variable"><span class="token variable">`</span>--&#39; <span class="token variable">`</span></span>--<span class="token string">&#39;`--&#39;</span> <span class="token variable"><span class="token variable">`</span>--&#39;<span class="token variable">`</span></span>-----&#39;
$
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="non-interactive-mode" tabindex="-1"><a class="header-anchor" href="#non-interactive-mode" aria-hidden="true">#</a> Non-Interactive Mode</h2><p>Startup script is as follows:</p><div class="language-bash ext-sh line-numbers-mode"><pre class="language-bash"><code>./as.sh <span class="token operator">&lt;</span>PID<span class="token operator">&gt;</span><span class="token punctuation">[</span>@IP:PORT<span class="token punctuation">]</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><h3 id="parameter-description" tabindex="-1"><a class="header-anchor" href="#parameter-description" aria-hidden="true">#</a> Parameter Description</h3><ul><li><em>PID</em>: Target Java process ID (Make sure that the user executing the command has sufficient permissions to operate the target Java process.)</li><li><em>IP</em>: The address that Arthas Server listens on, the default value is <code>127.0.0.1</code>. Arthas allows multiple users to access simultaneously without interfering with each other.</li><li><em>PORT</em>: Arthas Server portthe default value is 3658</li></ul><h3 id="sample" tabindex="-1"><a class="header-anchor" href="#sample" aria-hidden="true">#</a> Sample</h3><ul><li><p>If IP and PORT are not specified, then the default values are 127.0.0.1 and 3658</p><blockquote><p>./as.sh 12345</p></blockquote><p>Equivalent to:</p><blockquote><p>./as.sh 12356@127.0.0.1:3658</p></blockquote></li></ul><h3 id="remote-diagnosis" tabindex="-1"><a class="header-anchor" href="#remote-diagnosis" aria-hidden="true">#</a> Remote Diagnosis</h3><p>After starting Arthas Server on the target Java process, users can use <code>telnet</code> connect to the remote Arthas Server, for example</p><div class="language-bash ext-sh line-numbers-mode"><pre class="language-bash"><code>telnet <span class="token number">192.168</span>.1.119 <span class="token number">3658</span>
3 years ago
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><h3 id="sudo-support" tabindex="-1"><a class="header-anchor" href="#sudo-support" aria-hidden="true">#</a> sudo Support</h3><p>Usually online environment will only grant users privilege as low as possible, instead, all advanced operations are through sudo-list. Since <code>as.sh</code> script takes into account the current effective user, it is possible to run the script in the other rule, by specifying <code>-H</code> option like this:</p><div class="language-bash ext-sh line-numbers-mode"><pre class="language-bash"><code><span class="token function">sudo</span> <span class="token parameter variable">-u</span> admin <span class="token parameter variable">-H</span> ./as.sh <span class="token number">12345</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><h3 id="windows-support" tabindex="-1"><a class="header-anchor" href="#windows-support" aria-hidden="true">#</a> Windows Support</h3><p>Right now <code>as.bat</code> script supports one parameter only, which is: pid</p><div class="language-bash ext-sh line-numbers-mode"><pre class="language-bash"><code>as.bat <span class="token operator">&lt;</span>pid<span class="token operator">&gt;</span>
3 years ago
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div></div><!--[--><!--]--></div><footer class="page-meta right-menu-padding" data-v-fdd717e0><div class="meta-item edit-link"><a class="external-link meta-item-label" href="https://github.com/alibaba/arthas/edit/master/site/docs/en/doc/start-arthas.md" rel="noopener noreferrer" target="_blank" aria-label="Edit this page on GitHub"><!--[--><!--]--><span>Edit this page on GitHub</span><span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!--[--><!--]--></a></div><div class="meta-item last-updated"><span class="meta-item-label">Last Updated: </span><!----></div><div class="meta-item contributors"><span class="meta-item-label">Contributors: </span><span class="meta-item-info"><!--[--><!--[--><span class="contributor" title="email: hengyunabc@gmail.com">hengyunabc</span><!--[-->, <!--]--><!--]--><!--[--><span class="contributor" title="email: ian.luo@gmail.com">beiwei30</span><!--[-->, <!--]--><!--]--><!--[--><span class="contributor" title="email: 240951888@qq.com">mantuliu</span><!----><!--]--><!--]--></span></div></footer><!----><!--[--><!--]--></main><!--]--></div><!----><!--]--></div>
2 years ago
<script type="module" src="/assets/app.170c6bb7.js" defer></script>
</body>
</html>