# Library Instrumentation for Spring Web version 3.1 and higher Provides OpenTelemetry instrumentation for Spring's RestTemplate. ## Quickstart ### Add these dependencies to your project Replace `SPRING_VERSION` with the version of spring you're using. `Minimum version: 3.1` Replace `OPENTELEMETRY_VERSION` with the [latest release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-spring-web-3.1). For Maven, add to your `pom.xml` dependencies: ```xml io.opentelemetry.instrumentation opentelemetry-spring-web-3.1 OPENTELEMETRY_VERSION io.opentelemetry opentelemetry-exporter-logging OPENTELEMETRY_VERSION org.springframework spring-web SPRING_VERSION ``` For Gradle, add to your dependencies: ```groovy implementation("io.opentelemetry.instrumentation:opentelemetry-spring-web-3.1:OPENTELEMETRY_VERSION") implementation("io.opentelemetry:opentelemetry-exporter-logging:OPENTELEMETRY_VERSION") //this artifact should already be present in your application implementation("org.springframework:spring-web:SPRING_VERSION") ``` ### Features #### Telemetry-producing `ClientHttpRequestInterceptor` implementation `SpringWebTelemetry` allows creating a custom [ClientHttpRequestInterceptor](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/client/ClientHttpRequestInterceptor.html) that produces telemetry for HTTP requests sent using a `RestTemplate`. Example: ##### Usage ```java import io.opentelemetry.instrumentation.spring.web.SpringWebTelemetry; import io.opentelemetry.api.OpenTelemetry; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.client.ClientHttpRequestInterceptor; import org.springframework.web.client.RestTemplate; @Configuration public class RestTemplateConfig { @Bean public RestTemplate restTemplate(OpenTelemetry openTelemetry) { RestTemplate restTemplate = new RestTemplate(); SpringWebTelemetry telemetry = SpringWebTelemetry.create(openTelemetry); restTemplate.getInterceptors().add(telemetry.newInterceptor()); return restTemplate; } } ``` ### Starter Guide Check out [OpenTelemetry Manual Instrumentation](https://opentelemetry.io/docs/instrumentation/java/manual/) to learn more about using the OpenTelemetry API to instrument your code.