Pull requests for bug fixes are always welcome!
Before submitting new features or changes to current functionality, it is recommended to first open an issue and discuss your ideas or propose the changes you wish to make.
This project requires Java 17 to build and run tests. Newer JDK's may work, but this version is used in CI.
Some instrumentations and tests may put constraints on which java versions they support. See Running the tests for more details.
For developers testing code changes before a release is complete, there are
snapshot builds of the main branch. They are available from
the Sonatype OSS snapshots repository at https://oss.sonatype.org/content/repositories/snapshots/
(browse)
Build using Java 17:
java -version./gradlew assembleand then you can find the java agent artifact at
javaagent/build/libs/opentelemetry-javaagent-<version>.jar.
To simplify local development, you can remove the version number from the build product. This allows
the file name to stay consistent across versions. To do so, add the following to
~/.gradle/gradle.properties.
removeJarVersionNumbers=trueSee IntelliJ setup and troubleshooting
See Style guide
See Understanding the javaagent structure
See Understanding the javaagent instrumentation testing components
See Debugging
The build logs are very long and there is a lot of parallelization, so the logs can be hard to decipher, but if you scroll to the bottom you should see something like:
Publishing build scan...
https://gradle.com/s/ila4qwp5lcf5s
Opening the build scan link can sometimes take several seconds (it's a large build), but it typically makes it a lot clearer what's failing.
Draft PRs are welcome, especially when exploring new ideas or experimenting with a hypothesis. However, draft PRs may not receive the same degree of attention, feedback, or scrutiny unless requested directly. In order to help keep the PR backlog maintainable, drafts older than 6 months will be closed by the project maintainers. This should not be interpreted as a rejection. Closed PRs may be reopened by the author when time or interest allows.