Development Notes

March 31, 2021 ยท View on GitHub

Makefile

Makefiles are used to encapsulate the various tools in the toolchain:

make build      # builds JRE libraries and examples
make publish    # increment versions and publish the artifacts to sonatype

NOTE: to publish, SONATYPE_USERNAME and SONATYPE_PASSWORD need to be set in the shell environment.

Directory structure

Makefile                    # Top-level Makefile to encapsulate tool-specifics
lightstep-tracer-jre/       # JRE instrumentation library
examples/                   # Sample code for JRE

Formatting

The project uses the Google Java Style Guide as a formatting standard. Configurations for your IDE can be downloaded from github.com/google/styleguide.