opentelemetry-java-instrume.../instrumentation-core/spring
Munir Abdinur 3cd9ffa370
Empty gradle project (#497)
2020-06-11 18:41:18 -07:00
..
src Empty gradle project (#497) 2020-06-11 18:41:18 -07:00
README.md Otel-Spring-Contrib: First draft of readme with initial details (#484) 2020-06-09 14:58:20 -07:00
build.gradle Empty gradle project (#497) 2020-06-11 18:41:18 -07:00

README.md

OpenTelemetry Instrumentation: Spring and Spring Boot

This package streamlines the manual instrumentation process of OpenTelemetry for Spring and Spring Boot applications. It will enable you to add traces to requests and database calls with minimal changes to application code. This package will not fully automate your OpenTelemetry instrumentation, instead, it will provide you with better tools to instrument your own code.

The first section will walk you through span creation and propagation using the OpenTelemetry Java API and Spring's RestTemplate Http Web Client. This approach will use the "vanilla" OpenTelemetry API to make explicit tracing calls within an application's controller.

The second section will build on the first. It will walk you through implementing spring-web handler and interceptor interfaces to create traces with minimal changes to existing application code. Using the OpenTelemetry API, this approach involves copy and pasting files and a significant amount of manual configurations.

The third section will walk you through the annotations and configurations defined in the opentelemetry-contrib-spring package. This section will equip you with new tools to streamline the set up and instrumentation of OpenTelemetry on Spring and Spring Boot applications. With these tools you will be able to setup distributed tracing with little to no changes to existing configurations and easily customize traces with minor additions to application code.