io.opentelemetry.javaagent.instrumentation.springweb.v3_1.SpringWebInstrumentationModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-javaagent-spring-web-3.1 Show documentation

Instrumentation of Java libraries using OpenTelemetry.

There is a newer version: 2.12.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.javaagent.instrumentation.springweb.v3_1;

import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static java.util.Collections.singletonList;
import static net.bytebuddy.matcher.ElementMatchers.not;

import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.extension.instrumentation.HelperResourceBuilder;
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import java.util.List;
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class SpringWebInstrumentationModule extends InstrumentationModule {
  public SpringWebInstrumentationModule() {
    super("spring-web", "spring-web-3.1");
  }

  @Override
  public ElementMatcher.Junction classLoaderMatcher() {
    // class added in 3.1
    return hasClassesNamed("org.springframework.web.method.HandlerMethod")
        // class added in 6.0
        .and(not(hasClassesNamed("org.springframework.web.ErrorResponse")));
  }

  @Override
  public void registerHelperResources(HelperResourceBuilder helperResourceBuilder) {
    // make the filter class file loadable by ClassPathResource - in some cases (e.g. spring-guice,
    // see https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/7428) Spring
    // might want to read the class file metadata; this line will make the filter class file visible
    // to the bean class loader
    helperResourceBuilder.register(
        "org/springframework/web/servlet/v3_1/OpenTelemetryHandlerMappingFilter.class");
  }

  @Override
  public List typeInstrumentations() {
    return singletonList(new WebApplicationContextInstrumentation());
  }
}