Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

101 lines (63 loc) · 3.29 KB
Raw

Contributing

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.

Building

This project requires Java 21 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.

Snapshot builds

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)

Building from source

Build using Java 21:

java -version
./gradlew assemble

and 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=true

IntelliJ setup and troubleshooting

See IntelliJ setup and troubleshooting

Style guide

See Style guide

Running the tests

See Running the tests

Writing instrumentation

See Writing instrumentation

Understanding the javaagent structure

See Understanding the javaagent structure

Understanding the javaagent instrumentation testing components

See Understanding the javaagent instrumentation testing components

Debugging

See Debugging

Understanding Muzzle

See Understanding Muzzle

Troubleshooting PR build failures

The build logs are very long and there is a lot of parallelization, so the logs can be hard to decipher, but if you expand the "Build scan" step, you should see something like:

Run cat build-scan.txt
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.

You can also try the "Explain error" button at the top of the GitHub Actions page, which often does a reasonable job of parsing the long build log and displaying the important part.

Draft PRs

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.