# Library Instrumentation for Spring Web MVC version 6.0.0 and higher Provides OpenTelemetry instrumentation for Spring WebMVC controllers. ## Quickstart ### Add these dependencies to your project Replace `SPRING_VERSION` with the version of spring you're using. - `Minimum version: 6.0.0` Replace `OPENTELEMETRY_VERSION` with the [latest release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-spring-webmvc-6.0). For Maven add the following to your `pom.xml`: ```xml io.opentelemetry.instrumentation opentelemetry-spring-webmvc-6.0 OPENTELEMETRY_VERSION io.opentelemetry opentelemetry-exporter-logging OPENTELEMETRY_VERSION org.springframework spring-webmvc SPRING_VERSION ``` For Gradle add the following to your dependencies: ```groovy // OpenTelemetry instrumentation implementation("io.opentelemetry.instrumentation:opentelemetry-spring-webmvc-6.0:OPENTELEMETRY_VERSION") // OpenTelemetry exporter // replace this default exporter with your OpenTelemetry exporter (ex. otlp/zipkin/jaeger/..) implementation("io.opentelemetry:opentelemetry-exporter-logging:OPENTELEMETRY_VERSION") // required to instrument Spring WebMVC // this artifact should already be present in your application implementation("org.springframework:spring-webmvc:SPRING_VERSION") ``` ### Features #### `SpringWebMvcTelemetry` `SpringWebMvcTelemetry` enables creating OpenTelemetry server spans around HTTP requests processed by the Spring servlet container. ##### Usage in Spring Boot Spring Boot allows servlet `Filter`s to be registered as beans: ```java import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetry; import jakarta.servlet.Filter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class SpringWebMvcTelemetryConfiguration { @Bean public Filter telemetryFilter(OpenTelemetry openTelemetry) { return SpringWebMvcTelemetry.create(openTelemetry).createServletFilter(); } } ``` ### 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.