github-forks
/
arthas
mirror of https://github.com/alibaba/arthas.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
master
gh-pages
3.x
grpc-service
killercoda
dependabot/npm_and_yarn/web-ui/arthasWebConsole/vite-2.9.16
channel-server
object-view-model
oneagent
improve-http-api
http-api
4.0.x
arthas-all-3.4.3
arthas-all-3.4.2
arthas-all-3.4.1
arthas-all-3.4.0
arthas-all-3.3.9
arthas-all-3.3.8
arthas-all-3.3.7
arthas-all-3.3.6
arthas-all-3.3.5
arthas-all-3.3.3
arthas-all-3.3.2
arthas-all-3.3.1
arthas-all-3.3.0
arthas-all-3.2.0
arthas-all-3.1.8
arthas-all-3.1.7
arthas-all-3.1.6
arthas-all-3.1.5
arthas-all-3.1.4
arthas-all-3.1.3
arthas-all-3.1.2
arthas-all-3.1.1
3.1.0
arthas-all-3.0.5
arthas-all-3.0.4
arthas-all-3.0.3
arthas-all-3.0.0-RC
3.0.0-SNAPSHOT
arthas-all-3.3.4
arthas-all-3.4.4
arthas-all-3.4.5
arthas-all-3.4.6
arthas-all-3.4.7
arthas-all-3.4.8
arthas-all-3.5.0
arthas-all-3.5.1
arthas-all-3.5.2
arthas-all-3.5.3
arthas-all-3.5.4
arthas-all-3.5.5
arthas-all-3.5.6
arthas-all-3.6.0
arthas-all-3.6.1
arthas-all-3.6.2
arthas-all-3.6.3
arthas-all-3.6.4
arthas-all-3.6.5
arthas-all-3.6.6
arthas-all-3.6.7
arthas-all-3.6.8
arthas-all-3.6.9
arthas-all-3.7.0
arthas-all-3.7.1
arthas-all-3.7.2
arthas-all-3.7.3
arthas-all-4.0.0
arthas-all-4.0.1
arthas-all-4.0.2
arthas-all-4.0.3
arthas-all-4.0.4
doc-3.0.4-20181112
doc-3.0.4-20181128
doc-3.0.5-20190213
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9d91350bbe'
${ noResults }
arthas/CONTRIBUTING.md

56 lines
2.1 KiB
Markdown
Raw Blame History Unescape Escape

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

## issue
欢迎在issue里对arthas做反馈，分享使用技巧，排查问题的经历。
* https://github.com/alibaba/arthas/issues
## 改进用户文档
用户文档在`site/src/site/sphinx`目录下，如果希望改进arthas用户文档，可以提交PR。
## 开发者相关
### 安装到本地
本地开发时，推荐执行`as-package.sh`来打包，会自动安装最新版本的arthas到`~/.arthas`目录里。debug时会自动使用最新版本。
`as.sh`在启动时，会对`~/.arthas/lib`下面的目录排序，取最新的版本。`as-package.sh`在打包时，会取`pom.xml`里的版本号，再拼接上当前时间，比如： `3.0.5.20180917161808`，这样子排序时取的就是最新的版本。
也可以直接 `./mvnw clean package -DskipTests`打包，生成的zip在 `packaging/target/` 下面。但是注意`as.sh`启动加载的是`~/.arthas/lib`下面的版本。
### Debug
Arthas启动过程分为两部分：
1. 执行`com.taobao.arthas.core.Arthas`，查找到合适的jvm，然后attach上面。如果想debug这部分代码，可以直接
```
./as.sh debug pid
```
JPDA端口是`8888`，然后可以远程连接来debug。
如果启动时等待，则
```
JPDA_SUSPEND=y ./as.sh debug pid
```
1. attach成功之后，arthas agent运行目标进程里。想要调试agent的代码，则需要目标进程本身是以debug方式启动的。可以直接引入arthas的source，打断点
### 全量打包
* arthas是用sphinx来生成静态网站
* 在site/pom.xml里配置了`sphinx-maven-plugin`
* `sphinx-maven-plugin`通过下载`sphinx-binary/`来执行
* sphinx配置的`recommonmark`插件有bug：https://github.com/rtfd/recommonmark/issues/93 ，因此另外打包了一个修复版本： https://github.com/hengyunabc/sphinx-binary/releases/tag/v0.4.0.1
* 全量打包时，需要配置下面的参数（目前只支持mac/linux）：
```
./mvnw clean package -DskipTests -P full -Dsphinx.binUrl=https://github.com/hengyunabc/sphinx-binary/releases/download/v0.4.0.1/sphinx.osx-x86_64
```
Reference in New Issue View Git Blame Copy Permalink