<!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 > Manually Install Arthas — Arthas 3.3.9 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" / >
< script >
if (window.location.href.startsWith("https://alibaba.github.io/arthas/")) {
window.location.href = "https://arthas.aliyun.com/doc/" + window.location.href.substr("https://alibaba.github.io/arthas/".length);
}
< / script >
< script src = "_static/center_page.js" > < / script >
< link rel = "stylesheet" href = "https://g.alicdn.com/code/lib/highlight.js/9.13.1/styles/github.min.css" >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > Arthas
< / a >
< div class = "version" >
3.3.9
< / 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 >
< li class = "toctree-l1" > < a class = "reference external" href = "https://arthas.aliyun.com/" > Home< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en" > Online tutorials(Recommend)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "install-detail.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "download.html" > Download< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "quick-start.html" > Quick start< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "advanced-use.html" > Advanced usage< / a > < / li >
< li class = "toctree-l1" > < 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 = "http-api.html" > Http API< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "docker.html" > Docker< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "spring-boot-starter.html" > Arthas Spring Boot Starter< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "idea-plugin.html" > IDEA Plugin< / a > < / li >
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/alibaba/arthas/issues?q=label%3Auser-case" > User cases< / a > < / li >
< li class = "toctree-l1" > < a class = "reference 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 >
< li class = "toctree-l1" > < a class = "reference internal" href = "contact-us.html" > Contact us< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > Arthas< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > Manually Install Arthas< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/en/manual-install.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 = "manually-install-arthas" >
< h1 > Manually Install Arthas< a class = "headerlink" href = "#manually-install-arthas" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "id1" >
< h2 > Manually Install Arthas< a class = "headerlink" href = "#id1" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ol >
< li > < p > Download the latest version< / p >
< p > < strong > Latest version, Click To Download< / strong > : < a class = "reference external" href = "https://arthas.aliyun.com/download/latest_version" > < img alt = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" src = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" / > < / a > < / p >
< / li >
< li > < p > Unzip zip file< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > unzip arthas-packaging-bin.zip< / pre > < / div >
< / div >
< / li >
< li > < p > Install Arthas< / p >
< p > It is recommended to completely remove all old versions of Arthas before installation.< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > sudo su admin
rm -rf /home/admin/.arthas/lib/* # remove all the leftover of the old outdated Arthas
cd arthas
./install-local.sh # switch the user based on the owner of the target Java process.< / pre > < / div >
< / div >
< / li >
< li > < p > Start Arthas< / p >
< p > Make sure < code class = "docutils literal notranslate" > < span class = "pre" > stop< / span > < / code > the old Arthas server before start.< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > ./as.sh< / pre > < / div >
< / div >
< / li >
< / ol >
< / div >
< div class = "section" id = "startup-with-as-sh-as-bat" >
< h2 > Startup with as.sh/as.bat< a class = "headerlink" href = "#startup-with-as-sh-as-bat" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "section" id = "linux-unix-mac" >
< h3 > Linux/Unix/Mac< a class = "headerlink" href = "#linux-unix-mac" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press < em > Enter< / em > to run:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > curl -L https://arthas.aliyun.com/install.sh | sh< / pre > < / div >
< / div >
< p > The command above will download the bootstrap script < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > to the current directory. You can move it the any other place you want, or put its location in < code class = "docutils literal notranslate" > < span class = "pre" > $PATH< / span > < / code > .< / p >
< p > You can enter its interactive interface by executing < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < / code > , or execute < code class = "docutils literal notranslate" > < span class = "pre" > as.sh< / span > < span class = "pre" > -h< / span > < / code > for more help information.< / p >
< / div >
< div class = "section" id = "windows" >
< h3 > Windows< a class = "headerlink" href = "#windows" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > Latest Version, Click To Download: < a class = "reference external" href = "https://arthas.aliyun.com/download/latest_version" > < img alt = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" src = "https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square" / > < / a > < / p >
< p > Download and unzip, then find < code class = "docutils literal notranslate" > < span class = "pre" > as.bat< / span > < / code > from ‘ ’ < code class = "docutils literal notranslate" > < span class = "pre" > pid< / span > < / code > , which means you can only diagnose the local Java process. (Welcome any bat script expert to make it better :heart:)< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > as.bat < pid> < / pre > < / div >
< / div >
< p > If you want to diagnose Java process run as windows service, try these commands:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > as-service.bat -port < port>
as-service.bat -pid < pid>
as-service.bat -pid < pid> --interact< / pre > < / div >
< / div >
< p > Use this command to remove arthas service:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > as-service.bat -remove< / pre > < / div >
< / div >
< / div >
< / div >
< div class = "section" id = "manual-command-line-startup" >
< h2 > Manual command line startup< a class = "headerlink" href = "#manual-command-line-startup" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > If you fail to boot Arthas with the provided batch file, you could try to assemble the bootstrap command in the following way.< / p >
< ol >
< li > < p > Locate java in the target JVM:< / p >
< ul class = "simple" >
< li > < p > Linux/Unix/Mac: < code class = "docutils literal notranslate" > < span class = "pre" > ps< / span > < span class = "pre" > aux< / span > < span class = "pre" > |< / span > < span class = "pre" > grep< / span > < span class = "pre" > java< / span > < / code > < / p > < / li >
< li > < p > Windows: open the Process Monitor to search java< / p > < / li >
< / ul >
< / li >
< li > < p > Assemble bootstrap command:< / p >
< p > Let’ < code class = "docutils literal notranslate" > < span class = "pre" > /opt/jdk1.8/bin/java< / span > < / code > , then the command should be:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > /opt/jdk1.8/bin/java -Xbootclasspath/a:/opt/jdk1.8/lib/tools.jar \
-jar /tmp/arthas-packaging/arthas-core.jar \
-pid 15146 \
-target-ip 127.0.0.1 -telnet-port 3658 -http-port 8563 \
-core /tmp/arthas-packaging/arthas-core.jar \
-agent /tmp/arthas-packaging/arthas/arthas-agent.jar< / pre > < / div >
< / div >
< p > Note:< / p >
< ul class = "simple" >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -Xbootclasspath< / span > < / code > adds tools.jar< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -jar< / span > < span class = "pre" > /tmp/arthas-packaging/arthas-core.jar< / span > < / code > specifies main entry< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -pid< / span > < span class = "pre" > 15146< / span > < / code > specifies the target java process PID< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -target-ip< / span > < span class = "pre" > 127.0.0.1< / span > < / code > specifies the IP< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -telnet-port< / span > < span class = "pre" > 3658< / span > < span class = "pre" > -http-port< / span > < span class = "pre" > 8563< / span > < / code > specifies telnet and HTTP ports for remote access< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -core< / span > < span class = "pre" > /tmp/arthas-packaging/arthas-core.jar< / span > < span class = "pre" > -agent< / span > < span class = "pre" > /tmp/arthas-packaging/arthas/arthas-agent.jar< / span > < / code > specifies core/agent jar package< / p > < / li >
< / ul >
< p > If you are running on JDK 1.9 or above， ’ < code class = "docutils literal notranslate" > < span class = "pre" > tools.jar< / span > < / code > in option < code class = "docutils literal notranslate" > < span class = "pre" > -Xbootclasspath< / span > < / code > .< / p >
< p > You can find the logs from < code class = "docutils literal notranslate" > < span class = "pre" > ~/logs/arthas/arthas.log< / span > < / code > .< / p >
< / li >
< li > < p > Use telnet to connect once attaching to the target JVM (in step 2) succeeds< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight hljs" > < pre class = "bash" > telnet 127.0.0.1 3658< / pre > < / div >
< / div >
< / li >
< / ol >
< / div >
< / div >
< / div >
< / div >
< footer >
< 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://g.alicdn.com/code/lib/highlight.js/9.13.1/highlight.min.js" > < / script >
< script src = "https://g.alicdn.com/code/lib/highlightjs-line-numbers.js/2.5.0/highlightjs-line-numbers.min.js" > < / script >
< script >
document.querySelectorAll('div.hljs > pre').forEach(function(block) {
hljs.highlightBlock(block);
hljs.lineNumbersBlock(block);
});
< / script >
< script type = "text/javascript" > document . write ( unescape ( "%3Cspan style='display:none;' id='cnzz_stat_icon_1279151497'%3E%3C/span%3E%3Cscript src='https://s4.cnzz.com/z_stat.php%3Fid%3D1279151497' type='text/javascript'%3E%3C/script%3E" ) ) ; < / script >
< script >
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?d5c5e25b100f0eb51a4c35c8a86ea9b4";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
< / script >
< / body >
< / html >
