Add GraalVM native image demo for agent support #200
Merged
Conversation
This file contains hidden or 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
|
|
steverao
reviewed
Mar 19, 2024
Collaborator
steverao
left a comment
steverao
left a comment
There was a problem hiding this comment.
BTW, I suggest that use graalvm-demo to replace the graalvm-native-image-demo and create a directory named ot-demo under graalvm-demo. then, replace spring-boot-ot by spring-boot. In this way, it looks like more clearly and we can add other frameworks demo easily.
| This project adds GraalVM native image support for [OpenTelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation). It serves as an input for native image building of OT agent-enabled applications. | ||
|
|
||
| There are two things that the GraalVM [agent support PR](https://github.com/oracle/graal/pull/8077) can't automatically handle when supporting the agent instrumentation in native image: | ||
| 1. The actions in agent `premain`. Java agent usually initializes the context and registers the class transformations in the premain phase. Native image needs the `premain` to do part of such works, e.g. initializations to activate the agent at runtime is necessary, but the actual bytecode transformations should be excluded. In this project, we provide a native version of OT agent premain via GraalVM's substitution mechanism. See src/main/java/com/alibaba/jvm/Target_io_opentelemetry_javaagent_OpenTelemetryAgent.java for details. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 1. The actions in agent `premain`. Java agent usually initializes the context and registers the class transformations in the premain phase. Native image needs the `premain` to do part of such works, e.g. initializations to activate the agent at runtime is necessary, but the actual bytecode transformations should be excluded. In this project, we provide a native version of OT agent premain via GraalVM's substitution mechanism. See src/main/java/com/alibaba/jvm/Target_io_opentelemetry_javaagent_OpenTelemetryAgent.java for details. | |
| 1. The actions in agent `premain`. Java agent usually initializes the context and registers the class transformations in the premain phase. Native image needs the `premain` to do part of such works, e.g. initializations to activate the agent at runtime is necessary, but the actual bytecode transformations should be excluded. In this project, we provide a native version of OT agent premain via GraalVM's substitution mechanism. See `src/main/java/com/alibaba/jvm/Target_io_opentelemetry_javaagent_OpenTelemetryAgent.java` for details. |
| ### Steps | ||
| 1. cd to the root of this project | ||
| 2. `mvn package`: Build the jar package of this project | ||
| 3. `./run.sh --jvm --collect --log`: Execute the project in JVM mode, enabling OpenTelemetry agent to log monitoring data. Meanwhile, native-image-agent is enbeled to collect transformation classes and other dynamic data. When this step ends, data is dumped to `native-configs` directory. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 3. `./run.sh --jvm --collect --log`: Execute the project in JVM mode, enabling OpenTelemetry agent to log monitoring data. Meanwhile, native-image-agent is enbeled to collect transformation classes and other dynamic data. When this step ends, data is dumped to `native-configs` directory. | |
| 3. `./run.sh --jvm --collect --log`: Execute the project in JVM mode, enabling OpenTelemetry agent to log monitoring data. Meanwhile, native-image-agent is enabled to collect transformation classes and other dynamic data. When this step ends, data is dumped to `native-configs` directory. |
| @@ -0,0 +1,81 @@ | |||
| #!/bin/bash | |||
| JAVA="$HOME/tools/GRAALVM21" | |||
Collaborator
There was a problem hiding this comment.
The line is correct? If users set export GRAALVM_HOME=/root/graalvm-test/graalvm-17-23.0.2-ali-1.1-instru according to README.md, it seems they can't locate to relevant directory.
Contributor
Author
|
Graalvm-demo is not accurate. Because Graalvm could be Graalvm JIT or Graalvm native image. Graalvm-native-image is more accurate. |
steverao
approved these changes
Mar 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.