[Feature] GraalVM Native Image support (Experimental). #11365
+12,167
−63
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,6 +32,7 @@ | |
| * Add a component ID for Netty-http (ID=151). | ||
| * Add a component ID for Fiber (ID=5021). | ||
| * BanyanDBStorageClient: Add `define(Property property, PropertyStore.Strategy strategy)` API. | ||
| * Support GraalVM native-image (Experimental). | ||
|
|
||
| #### UI | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,7 +20,7 @@ The native-image compilation is not enabled by default. To enable it, we need to | |
|
|
||
| ``` | ||
|
|
||
| Then, 2 packages are in `graal/dist`, | ||
| As this is an experimental feature, a package named `apache-skywalking-apm-native-pre-bin.tar.gz` is a tarball for GraalVMization friendly, including original classes to be compiled by GraalVM. | ||
| The package named `apache-skywalking-apm-native-bin.tar.gz` includes the final compiled native binary, relative configuration files, and booting shells. Read `Package Structure` doc for more details. | ||
|
|
||
|
|
@@ -46,4 +46,12 @@ we can successfully start SkyWalking-oap. | |
| With native-image, some features are not yet supported. | ||
|
|
||
| 1. [LAL](https://skywalking.apache.org/docs/main/next/en/concepts-and-designs/lal/), [MAL](https://skywalking.apache.org/docs/main/next/en/concepts-and-designs/mal/), and some other features related to them are not supported at the moment. | ||
| 2. The [OAL](https://skywalking.apache.org/docs/main/next/en/concepts-and-designs/oal/) files are used in the compiling stage, which means that users would not see these files inside the native image package, and can't change it. Consider recompiling and packaging from the source codes including your OAL file changes. | ||
|
|
||
| ## Current Limitations | ||
|
There was a problem hiding this comment. The path you are using here should use the relative path. The website compiling could translate it to the correct path binding in the version(commit ID). |
||
| Native-image supports reflection and other dynamic features through some JSON-formatted configuration files. SkyWalking currently provides a set of configuration files for basic support. You can find them [here](https://github.com/apache/skywalking/tree/master/graal/graal-server-starter/src/main/resources/META-INF/native-image). | ||
|
|
||
| For now, these configuration files do not support all runtime environments (but will be fully supported in the future). Therefore, in other environments, users may need to generate the configuration files required by native-image on their own. | ||
|
|
||
| SkyWalking uses [native build tools](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html) to generate native-image. Additionally, GraalVM provides an agent to assist in generating configuration files. Therefore, users can generate the required configuration files by referring to [native build tools agent guide](https://graalvm.github.io/native-build-tools/latest/maven-plugin.html#agent-support). | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| SHELL := /bin/bash -o pipefail | ||
|
|
||
| SW_GRAAL_ROOT := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) | ||
| CONTEXT = ${SW_GRAAL_ROOT}/dist | ||
| DIST ?= apache-skywalking-apm-native-bin.tar.gz | ||
| CLI_VERSION ?= 0.12.0 # CLI version inside OAP image should always use an Apache released artifact. | ||
|
|
||
| HUB ?= skywalking | ||
|
|
||
| TAG ?= latest | ||
|
|
||
| DOCKER_BUILD_TOP:=${CONTEXT}/docker_build | ||
|
|
||
| NAME := oap | ||
|
|
||
| LOAD_OR_PUSH = --load | ||
|
|
||
| BUILD_ARGS := $(BUILD_ARGS) --build-arg DIST=$(DIST) --build-arg SKYWALKING_CLI_VERSION=$(CLI_VERSION) | ||
|
|
||
| docker.% push.docker.%: $(CONTEXT)/$(DIST) $(SW_GRAAL_ROOT)/docker/%/* | ||
| $(DOCKER_RULE) | ||
|
|
||
| define DOCKER_RULE | ||
| mkdir -p $(DOCKER_BUILD_TOP)/$(NAME) | ||
| cp -r $^ $(DOCKER_BUILD_TOP)/$(NAME) | ||
| docker buildx create --use --driver docker-container --name skywalking_main > /dev/null 2>&1 || true | ||
| docker buildx build $(PLATFORMS) $(LOAD_OR_PUSH) \ | ||
| --no-cache $(BUILD_ARGS) \ | ||
| -t $(HUB)/$(NAME):$(TAG) \ | ||
| -t $(HUB)/$(NAME):latest \ | ||
| $(DOCKER_BUILD_TOP)/$(NAME) | ||
| docker buildx rm skywalking_main || true | ||
| endef |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,15 +63,28 @@ | |
| <artifactId>maven-assembly-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>dist-native-pre</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>single</goal> | ||
| </goals> | ||
| <configuration> | ||
| <finalName>apache-skywalking-apm-native-pre-bin</finalName> | ||
| <descriptors> | ||
| <descriptor>${project.basedir}/src/main/assembly/binary-native-pre.xml</descriptor> | ||
| </descriptors> | ||
| </configuration> | ||
| </execution> | ||
| <execution> | ||
| <id>dist-native</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>single</goal> | ||
| </goals> | ||
| <configuration> | ||
| <finalName>apache-skywalking-apm-native-bin</finalName> | ||
| <descriptors> | ||
| <descriptor>${project.basedir}/src/main/assembly/binary-native.xml</descriptor> | ||
| </descriptors> | ||
| </configuration> | ||
| </execution> | ||
|
|
@@ -95,6 +108,7 @@ | |
| <configuration> | ||
| <target> | ||
| <copy file="${project.build.directory}/apache-skywalking-apm-native-pre-bin.tar.gz" tofile="${project.basedir}/../dist/apache-skywalking-apm-native-pre-bin.tar.gz" overwrite="true" /> | ||
| <copy file="${project.build.directory}/apache-skywalking-apm-native-bin.tar.gz" tofile="${project.basedir}/../dist/apache-skywalking-apm-native-bin.tar.gz" overwrite="true" /> | ||
| </target> | ||
| </configuration> | ||
| </execution> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,15 +25,6 @@ | |
| <format>tar.gz</format> | ||
| </formats> | ||
| <fileSets> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../dist-material</directory> | ||
| <outputDirectory>config</outputDirectory> | ||
|
|
@@ -125,5 +116,10 @@ | |
| <outputDirectory>config</outputDirectory> | ||
| <fileMode>0644</fileMode> | ||
| </file> | ||
| <file> | ||
| <source>${project.basedir}/../dist-material/bin/oapService-native-jar.sh</source> | ||
| <outputDirectory>bin</outputDirectory> | ||
| <fileMode>0755</fileMode> | ||
| </file> | ||
| </files> | ||
| </assembly> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| <!-- | ||
| ~ Licensed to the Apache Software Foundation (ASF) under one or more | ||
| ~ contributor license agreements. See the NOTICE file distributed with | ||
| ~ this work for additional information regarding copyright ownership. | ||
| ~ The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| ~ (the "License"); you may not use this file except in compliance with | ||
| ~ the License. You may obtain a copy of the License at | ||
| ~ | ||
| ~ http://www.apache.org/licenses/LICENSE-2.0 | ||
| ~ | ||
| ~ Unless required by applicable law or agreed to in writing, software | ||
| ~ distributed under the License is distributed on an "AS IS" BASIS, | ||
| ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| ~ See the License for the specific language governing permissions and | ||
| ~ limitations under the License. | ||
| ~ | ||
| --> | ||
|
|
||
| <assembly | ||
| xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> | ||
| <id>dist</id> | ||
| <formats> | ||
| <format>tar.gz</format> | ||
| </formats> | ||
| <fileSets> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../dist-material</directory> | ||
| <outputDirectory>config</outputDirectory> | ||
| <includes> | ||
| <include>log4j2.xml</include> | ||
| <include>alarm-settings.yml</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../dist-material</directory> | ||
| <outputDirectory/> | ||
| <includes> | ||
| <include>config-examples/*</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../oap-server/server-starter/src/main/resources</directory> | ||
| <includes> | ||
| <include>component-libraries.yml</include> | ||
| <include>gateways.yml</include> | ||
| <include>service-apdex-threshold.yml</include> | ||
| <include>endpoint-name-grouping.yml</include> | ||
| <include>metadata-service-mapping.yaml</include> | ||
| <include>trace-sampling-policy-settings.yml</include> | ||
| <include>oal/*.oal</include> | ||
| <include>fetcher-prom-rules/*.yaml</include> | ||
| <include>envoy-metrics-rules/**</include> | ||
| <include>meter-analyzer-config/*.yaml</include> | ||
| <include>zabbix-rules/*.yaml</include> | ||
| <include>openapi-definitions/*/*.yaml</include> | ||
| <include>otel-rules/**</include> | ||
| <include>ui-initialized-templates/*/*.json</include> | ||
| <include>ui-initialized-templates/menu.yaml</include> | ||
| <include>lal/*</include> | ||
| <include>log-mal-rules/**</include> | ||
| <include>telegraf-rules/*</include> | ||
| </includes> | ||
| <outputDirectory>config</outputDirectory> | ||
| </fileSet> | ||
|
|
||
| <!-- data generator --> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../oap-server/server-tools/data-generator/target/</directory> | ||
| <includes> | ||
| <include>data-generator-${project.version}.jar</include> | ||
| </includes> | ||
| <outputDirectory>oap-libs</outputDirectory> | ||
| </fileSet> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../oap-server/server-tools/data-generator/src/main/assembly/bin</directory> | ||
| <outputDirectory>tools/data-generator/bin</outputDirectory> | ||
| <includes> | ||
| <include>*.sh</include> | ||
| </includes> | ||
| <fileMode>0755</fileMode> | ||
| </fileSet> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../oap-server/server-tools/data-generator/src/main/resources</directory> | ||
| <outputDirectory>tools/data-generator/config</outputDirectory> | ||
| <includes> | ||
| <include>application.yml</include> | ||
| </includes> | ||
| </fileSet> | ||
| <!-- data generator --> | ||
|
|
||
| <!-- Profile exporter tools --> | ||
| <fileSet> | ||
| <directory>${project.basedir}/../../tools/profile-exporter</directory> | ||
| <outputDirectory>tools/profile-exporter</outputDirectory> | ||
| </fileSet> | ||
|
|
||
| <fileSet> | ||
| <directory>${project.basedir}/../../dist-material/release-docs</directory> | ||
| <outputDirectory/> | ||
| </fileSet> | ||
| </fileSets> | ||
| <files> | ||
| <file> | ||
| <source>${project.basedir}/../graal-server-starter/src/main/resources/application.yml</source> | ||
| <outputDirectory>config</outputDirectory> | ||
| <fileMode>0644</fileMode> | ||
| </file> | ||
| <file> | ||
| <source>${project.basedir}/../dist-material/bin/oapService-native.sh</source> | ||
| <outputDirectory>bin</outputDirectory> | ||
| <fileMode>0755</fileMode> | ||
| </file> | ||
| <file> | ||
| <source>${project.basedir}/../graal-server-starter/target/skywalking-oap-native</source> | ||
| <outputDirectory>image</outputDirectory> | ||
| <fileMode>0755</fileMode> | ||
| </file> | ||
| </files> | ||
| </assembly> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,8 +24,6 @@ PRGDIR=$(dirname "$PRG") | |
| OAP_LOG_DIR="${OAP_LOG_DIR:-${OAP_HOME}/logs}" | ||
| JAVA_OPTS="${JAVA_OPTS:- -Xms256M -Xmx4096M}" | ||
|
|
||
| if [ ! -d "${OAP_LOG_DIR}" ]; then | ||
| mkdir -p "${OAP_LOG_DIR}" | ||
| fi | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.