Skip to content

Latest commit

 

History

History
126 lines (114 loc) · 5.69 KB

How-to-build-CN.md

File metadata and controls

126 lines (114 loc) · 5.69 KB
Raw

工程编译指南

本文档用于指导开发者，在本地开发环境中编译工程。

前言

因为工程结构和代码依赖会随版本变化，如果读者熟悉travis-ci,则可直接参考.travis.yml

工程使用Git Submodule，所以不建议使用GitHub的tag和release页面的源码下载，来编译工程

从GitHub下载代码编译

  1. 准备环境: git, jdk8，Maven
  2. git clone https://github.com/apache/incubator-skywalking.git
  3. cd incubator-skywalking/
  4. 切换到tag git checkout [tagname] (可选，当需要编译发行版本时，请是切换到指定分支)
  5. git submodule init
  6. git submodule update
  7. 执行mvn clean package -DskipTests
  8. 生成包在/dist目录下（.tar.gz是linux环境，.zip是windows环境）

从Apache源码镜像下载编译

  1. 准备环境: jdk8，Maven
  2. 执行mvn clean package -DskipTests
  3. 生成包在/dist目录下（.tar.gz是linux环境，.zip是windows环境）

在IntelliJ IDEA中编译工程

上述步骤在命令行中，能够很好的编译工程，但导入到编译器中的工程依然会有一些报错，我们需要进行几步简单的操作。

  1. 在IntelliJ Terminal中，执行mvn compile -Dmaven.test.skip=true进行编译
  2. 设置gRPC的自动生成代码目录，为源码目录
  • apm-protocol/apm-network/target/generated-sources/protobuf目录下的grpc-java和java目录
  • apm-collector/apm-collector-remote/apm-remote-grpc-provider/target/generated-sources/protobuf目录下的grpc-java和java目录

在IntelliJ IDEA中编译工程

上述步骤在命令行中，能够很好的编译工程，但导入到编译器中的工程依然会有一些报错，我们需要进行几步简单的操作。

  1. 在IntelliJ Terminal中，执行mvn compile -Dmaven.test.skip=true进行编译
  2. 设置gRPC的自动生成代码目录，为源码目录
  • apm-protocol/apm-network/target/generated-sources/protobuf目录下的grpc-java和java目录
  • apm-collector/apm-collector-remote/apm-remote-grpc-provider/target/generated-sources/protobuf目录下的grpc-java和java目录

在Eclipse IDE中编译工程

  1. 导入incubator-skywalking maven工程
  2. 在主目录incubator-skywalking/pom.xml文件中添加如下两个plugin配置，首先配置多源码目录支持，在build/plugins节点下添加如下配置：
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <version>1.8</version>
    <executions>
        <execution>
            <id>add-source</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>add-source</goal>
            </goals>
            <configuration>
                <sources>
                    <source>src/java/main</source>
                    <source>apm-protocol/apm-network/target/generated-sources/protobuf</source>
                    <source>apm-collector/apm-collector-remote/collector-remote-grpc-provider/target/generated-sources/protobuf</source>
               </sources>
            </configuration>
        </execution>
    </executions>
</plugin>

其次需要支持多source目录，但eclipse的m2e插件还没支持到execution，需要在在build节点下添加如下配置：

<pluginManagement>
    <plugins>
    <!--This plugin's configuration is used to store Eclipse m2e settings 
    only. It has no influence on the Maven build itself. -->
        <plugin>
            <groupId>org.eclipse.m2e</groupId>
            <artifactId>lifecycle-mapping</artifactId>
            <version>1.0.0</version>
            <configuration>
                <lifecycleMappingMetadata>
                    <pluginExecutions>
                        <pluginExecution>
                            <pluginExecutionFilter>
                                <groupId>org.codehaus.mojo</groupId>
                                <artifactId>build-helper-maven-plugin</artifactId>
                                <versionRange>[1.8,)</versionRange>
                                <goals>
                                    <goal>add-source</goal>
                                </goals>
                            </pluginExecutionFilter>
                        </pluginExecution>
                    </pluginExecutions>
                </lifecycleMappingMetadata>
            </configuration>
        </plugin>
    </plugins>
</pluginManagement>
  1. 修改apm-collector-remote/collector-remote-grpc-provider/pom.xml文件，添加google guava的依赖
<dependency>
   <groupId>com.google.guava</groupId>
   <artifactId>guava</artifactId>
   <version>24.0-jre</version>
</dependency>
  1. 执行mvn compile -Dmaven.test.skip=true进行编译
  2. 执行maven update,切记去掉勾选 Clean projects选项(会清掉complie生成的proto转化Java文件)
  3. mvn compile 编译collector-remote-grpc-provider和apm-protocol工程并Refresh

编译Resin-3， Resin-4 和 Oracle JDBC 驱动插件

为了遵守Apache关于协议（License）的相关要求，不符合Apache相关要求的类库所对应的Plugin不会自动编译。如需编译对应的插件， 需要手动下载驱动或类库，并将文件拷贝到ci-dependencies/中，运行mvn package进行编译。

ci-dependencies/下对应的类库文件名为：

  • resin-3.0.9.jar
  • resin-4.0.41.jar
  • ojdbc14-10.2.0.4.0.jar

FAQ

npm install超时失败

如果在编译apm-webapp时碰到下载包失败问题，可以将apm-webapp中pom.xml中npm源地址修改为淘宝的源，在中国的访问速度可以大大提高.

<arguments>install --registry=https://registry.npmjs.org/</arguments>

修改为

<arguments>install --registry=https://registry.npm.taobao.org/</arguments>