提交新的编译指导文档

2016-08-14 10:21:00 +08:00 · 2016-08-14 10:21:00 +08:00 · bd992a5e2a
parent 34a9d26b82
commit bd992a5e2a
2 changed files with 25 additions and 54 deletions
--- a/BUILD_DOC.md
+++ b/BUILD_DOC.md
@ -1,54 +1,23 @@
-### 编译安装SkyWalking Server / Build SkyWalking Server
+### 编译SkyWalking Protocol / Build SkyWalking Protocol
 - 编译工程
 - build
 ```shell
-$cd github/sky-walking/skywalking-server
-$mvn package -Dmaven.test.skip=true
-$cd github/sky-walking/skywalking-server/target/installer
+$cd github/sky-walking/skywalking-protocol
+$mvn clean install -Dmaven.test.skip=true
 ```
- 拷贝installer到服务器
- upload installer to server

-
-### 编译安装SkyWalking Alarm / Build SkyWalking Alarm
- 编译工程
- build
+### 编译SkyWalking主工程 / Build SkyWalking
 ```shell
-$cd github/sky-walking/skywalking-alarm
-$mvn package -Dmaven.test.skip=true
-$cd github/sky-walking/skywalking-alarm/target/installer
-```
- 拷贝installer到服务器
- upload installer to server
-
-
-### 编译安装SkyWalking WebUI / Build SkyWalking WebUI
-
- 编译工程
- build
-```shell
-$cd github/sky-walking/skywalking-webui
-$mvn package
+$cd github/sky-walking
+$mvn clean install -Dmaven.test.skip=true
 ```

- 上传war包到服务器，启动Tomcat服务器
- startup tomcat of webui
-
-### 编译安装SkyWalking Analysis / Build SkyWalking Analysis
- 编译工程
- build
-```shell
-$cd github/sky-walking/skywalking-analysis
-$mvn package -Dmaven.test.skip=true
-```
-
- 上传skywalking-analysis-1.0-Final.jar. Upload the skywalking-analysis-1.0-Final.jar
- 上传start-analysis.sh. Upload the start-analysis.sh
-
-
-## 使用maven发布各插件工程 / build and deploy plugins
- build and deploy skywalking-sdk-plugin(dubbo-plugin，spring-plugin，web-plugin，jdbc-plugin，httpclient-4.2.x-plugin，httpclient-4.3.x-plugin, etc.)
- 请跳过maven.test环节，避免打包失败
-```properties
-Dmaven.test.skip=true
-```
+- 从各工程目录中获取安装包
+	- SkyWalking Agent: github/sky-walking/skywalking-collector/skywalking-agent/target/skywalking-agent-1.0-Final.jar
+	- SkyWalking Server: github/sky-walking/skywalking-server/target/installer
+	- SkyWalking Alarm:  github/sky-walking/skywalking-alarm/target/installer
+	- SkyWalking WebUI: github/sky-walking/skywalking-webui/skywalking.war
+	- SkyWalking Analysis: github/sky-walking/skywalking-analysis/skywalking-analysis-1.0-Final.jar
+		- 上传skywalking-analysis-1.0-Final.jar. Upload the skywalking-analysis-1.0-Final.jar
+		- 上传start-analysis.sh到同一目录. Upload the start-analysis.sh to the same directory
+		- 为start-analysis.sh创建crontable定时任务，30分钟执行一次。create crontable for shell, set cycle=30min.
--- a/README.md
+++ b/README.md
@ -116,17 +116,11 @@ SkyWalking: Large-Scale Distributed Systems Tracing Infrastructure, 是一个对
 - use public repository  [https://jcenter.bintray.com/](https://jcenter.bintray.com/) to download sdk


-## 使用-javaagent 启动应用程序 / start application with -javaagent
- 为应用程序添加启动参数
-```shell
-java -jar ...  -javaagent:/..ospath../skywalking-agent-x.x-Final.jar
-```
-
 ## 下载并设置授权文件 / Download auth file
 - 注册并登陆过skywalking-webui，创建应用。（一个用户代表一个逻辑集群，一个应用代表一个服务集群。如前后端应用应该设置两个应用，但归属一个用户）
 - Sign up and login in skywalking-webui. Create application as needed.
- 下载授权文件，并在运行时环境中，将授权文件加入到CLASSPATH或LIB中
- download auth file(*.jar), and add the jar file to the CLASSPATH or lib.
+- 下载授权文件，放在在agent jar所在目录中
+- download auth file(*.auth), and copy the auth file to directory of the agent jar

 ## 在运行时环境中设置环境变量 / set environment variables 
 ```
@ -135,6 +129,14 @@ export SKYWALKING_RUN=true
 - 设置完成后，SkyWalking将随应用启动运行
 - After set env, SkyWalking will be working, when application startup.

+
+## 使用-javaagent 并启动应用程序 / start application with -javaagent
+- 为应用程序添加启动参数
+```shell
+java -jar ...  -javaagent:/..ospath../skywalking-agent-x.x-Final.jar
+```
+- Tomcat可以使用修改启动文件，配置-javaagent参数
+
 # 在应用程序中显示traceid / How to find tid
 - [Find TID](HOW_TO_FIND_TID.md)