CONTRIBUTING.md

Contributing

Pull requests for bug fixes are welcome, but before submitting new features or changes to current functionality open an issue and discuss your ideas or propose the changes you wish to make. After a resolution is reached a PR can be submitted for review.

In order to build and test this whole repository you need JDK 11+. Some instrumentations and tests may put constraints on which java versions they support. See Running the tests for more details.

Building

Snapshot builds

For developers testing code changes before a release is complete, there are snapshot builds of the master branch. They are available from JFrog OSS repository

Building from source

Build using Java 11:

java -version

./gradlew assemble

and then generate the -all artifact

./gradlew :javaagent:shadowJar

and then you can find the java agent artifact at

javaagent/build/lib/opentelemetry-javaagent-<version>-all.jar.

IntelliJ setup

See IntelliJ setup

Style guide

See Style guide

Running the tests

See Running the tests

Writing instrumentation

See Writing instrumentation

Understanding the javaagent components

See Understanding the javaagent components

Debugging

See Debugging

Understanding Muzzle

See Understanding Muzzle

Maintainers, Approvers and Triagers

Maintainers:

• Anuraag Agrawal, AWS
• Nikita Salnikov-Tarnovski, Splunk
• Trask Stalnaker, Microsoft
• Tyler Benson, DataDog

Approvers:

• John Watson, Splunk
• Mateusz Rzeszutek, Splunk

Triagers:

• Sergei Malafeev, Lightstep

Become a Triager, Approver or Maintainer

See the community membership document in OpenTelemetry community repo.