This document helps people to compile and build the project in your maven and set your IDE.
Because we are using Git submodule, we recommend don't use GitHub
tag or release page to download source codes for compiling.
git clone https://github.com/apache/skywalking.git
cd skywalking/
git checkout [tagname]
(Optional, switch if want to build a release from source codes)git submodule init
git submodule update
./mvnw clean package -DskipTests
/dist
(.tar.gz for Linux and .zip for Windows).Apache source code release
?For each official Apache release, there is a complete and independent source code tar, which is including all source codes. You could download it from SkyWalking Apache download page. No git related stuff required when compiling this. Just follow these steps.
./mvnw clean package -DskipTests
/dist
.(.tar.gz for Linux and .zip for Windows).SkyWalking is a complex maven project, including many modules, which could cause long compiling time. If you just want to recompile part of the project, you have following options
./mvnw package -Pagent,dist
or
make build.agent
./mvnw package -Pbackend,dist
or
make build.backend
./mvnw package -Pui,dist
or
make build.ui
We can build docker images of backend
and ui
with Makefile
located in root folder.
make docker.all
make docker.oap
make docker.ui
HUB
and TAG
variables ares used to setup REPOSITORY
and TAG
of a docker image. To get a oap image with name bar/oap:foo
, run the following command
HUB=bar TAG=foo make docker.oap
NOTICE: If you clone the codes from GitHub, please make sure that you had finished step 1 to 7 in section Build from GitHub, if you download the source codes from the official website of SkyWalking, please make sure that you had followed the steps in section Build from Apache source code release.
./mvnw compile -Dmaven.test.skip=true
to compile project and generate source codes. Because we use gRPC and protobuf.grpc-java
and java
folders in apm-protocol/apm-network/target/generated-sources/protobufgrpc-java
and java
folders in oap-server/server-core/target/generated-sources/protobufgrpc-java
and java
folders in oap-server/server-receiver-plugin/receiver-proto/target/generated-sources/protobufgrpc-java
and java
folders in oap-server/exporter/target/generated-sources/protobufgrpc-java
and java
folders in oap-server/server-configuration/grpc-configuration-sync/target/generated-sources/protobufantlr4
folder in oap-server/oal-grammar/target/generated-sourcesNOTICE: If you clone the codes from GitHub, please make sure that you had finished step 1 to 7 in section Build from GitHub, if you download the source codes from the official website of SkyWalking, please make sure that you had followed the steps in section Build from Apache source code release.
skywalking/pom.xml
file:<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>
<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>
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>24.0-jre</version> </dependency>
./mvnw compile -Dmaven.test.skip=true
maven update
. Must remove the clean projects item before maven update(This will be clear the proto conversion Java file generated by the complie)./mvnw compile
compile collector-remote-grpc-provider and apm-protocol