arthas/CONTRIBUTING.md
2018-09-20 11:34:59 +08:00

2.5 KiB
Raw Blame History

issue

欢迎在issue里对arthas做反馈分享使用技巧排查问题的经历。

改进用户文档

用户文档在site/src/site/sphinx目录下如果希望改进arthas用户文档欢迎提交PR。

英文文档在site/src/site/sphinx/en目录下欢迎提交翻译PR。

开发者相关

编绎要求jdk7以上。因为使用到了jdk7才有的java.lang.management.BufferPoolMXBean运行时要求是jdk6。

安装到本地

本地开发时,推荐执行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下面的版本。

启动指定版本的arthas

本地开发时,可能会产生多个版本,可以用 --use-version 参数来指定版本,比如

./as.sh --use-version 3.0.5.20180919185025

可以用--versions参数来列出所有版本:

./as.sh --versions

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
    
  2. attach成功之后arthas agent运行目标进程里。想要调试agent的代码则需要目标进程本身是以debug方式启动的。可以直接引入arthas的source打断点

全量打包

  • arthas是用sphinx来生成静态网站

  • 在site/pom.xml里配置了sphinx-maven-plugin

  • sphinx-maven-plugin通过下载sphinx-binary/来执行

  • sphinx配置的recommonmark插件有bughttps://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