Add nullaway to spring autoconfigure (#15170)

Author: zeitlinger

instrumentation/spring/spring-boot-autoconfigure/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
   id("otel.library-instrumentation")
+  id("otel.nullaway-conventions")
 }
 
 base.archivesName.set("opentelemetry-spring-boot-autoconfigure")

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/OpenTelemetryAutoConfiguration.java

@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure;
 
+import static java.util.Objects.requireNonNull;
+
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.incubator.config.ConfigProvider;
 import io.opentelemetry.api.trace.TracerProvider;
@@ -145,7 +147,7 @@ public InstrumentationConfig instrumentationConfig(ConfigProperties properties)
       @Bean
       public ConfigProperties otelProperties(
           AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
-        return AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk);
+        return requireNonNull(AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk));
       }
     }
 

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/InstrumentationPropertyEnabled.java

@@ -5,6 +5,8 @@
 
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal;
 
+import static java.util.Objects.requireNonNull;
+
 import java.util.Map;
 import java.util.Objects;
 import org.springframework.context.annotation.Condition;
@@ -25,7 +27,7 @@ public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata)
 
     return EarlyConfig.isInstrumentationEnabled(
         context.getEnvironment(),
-        attributes.get("module").toString(),
-        (boolean) attributes.get("enabledByDefault"));
+        requireNonNull(attributes.get("module")).toString(),
+        (boolean) requireNonNull(attributes.get("enabledByDefault")));
   }
 }

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/annotations/InstrumentationWithSpanAspect.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.annotations;
 
 import io.opentelemetry.api.OpenTelemetry;
+import javax.annotation.Nullable;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
@@ -24,6 +25,7 @@ class InstrumentationWithSpanAspect extends WithSpanAspect {
             .InstrumentationAnnotationAttributeNameSupplier());
   }
 
+  @Nullable
   @Override
   @Around("@annotation(io.opentelemetry.instrumentation.annotations.WithSpan)")
   public Object traceMethod(ProceedingJoinPoint pjp) throws Throwable {

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/annotations/WithSpanAspect.java

@@ -16,6 +16,7 @@
 import io.opentelemetry.instrumentation.api.annotation.support.async.AsyncOperationEndSupport;
 import io.opentelemetry.instrumentation.api.incubator.semconv.code.CodeAttributesExtractor;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+import javax.annotation.Nullable;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.springframework.core.ParameterNameDiscoverer;
 
@@ -64,6 +65,7 @@ private static Context parentContext(
     return request.inheritContext() ? parentContext : Context.root();
   }
 
+  @Nullable
   public Object traceMethod(ProceedingJoinPoint pjp) throws Throwable {
     JoinPointRequest request = requestFactory.create(pjp);
     Context parentContext = Context.current();

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java

@@ -17,6 +17,7 @@
 import java.sql.SQLException;
 import java.sql.SQLFeatureNotSupportedException;
 import java.util.logging.Logger;
+import javax.annotation.Nullable;
 import javax.sql.DataSource;
 import org.springframework.aop.SpringProxy;
 import org.springframework.aop.framework.AdvisedSupport;
@@ -27,7 +28,7 @@
 
 final class DataSourcePostProcessor implements BeanPostProcessor, Ordered {
 
-  private static final Class<?> ROUTING_DATA_SOURCE_CLASS = getRoutingDataSourceClass();
+  @Nullable private static final Class<?> ROUTING_DATA_SOURCE_CLASS = getRoutingDataSourceClass();
 
   private final ObjectProvider<OpenTelemetry> openTelemetryProvider;
   private final ObjectProvider<InstrumentationConfig> configProvider;
@@ -39,6 +40,7 @@ final class DataSourcePostProcessor implements BeanPostProcessor, Ordered {
     this.configProvider = configProvider;
   }
 
+  @Nullable
   private static Class<?> getRoutingDataSourceClass() {
     try {
       return Class.forName("org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource");

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/kafka/ConcurrentKafkaListenerContainerFactoryPostProcessor.java

@@ -8,6 +8,7 @@
 import io.opentelemetry.instrumentation.spring.kafka.v2_7.SpringKafkaTelemetry;
 import java.lang.reflect.Field;
 import java.util.function.Supplier;
+import javax.annotation.Nullable;
 import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.kafka.config.AbstractKafkaListenerContainerFactory;
 import org.springframework.kafka.config.ConcurrentKafkaListenerContainerFactory;
@@ -47,6 +48,7 @@ public Object postProcessAfterInitialization(Object bean, String beanName) {
     return listenerContainerFactory;
   }
 
+  @Nullable
   private static <T> T readField(Object container, String filedName, Class<T> fieldType) {
     try {
       Field field = AbstractKafkaListenerContainerFactory.class.getDeclaredField(filedName);

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/runtimemetrics/Java17RuntimeMetricsProvider.java

@@ -9,6 +9,7 @@
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics;
 import io.opentelemetry.instrumentation.runtimemetrics.java17.internal.RuntimeMetricsConfigUtil;
+import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -26,6 +27,7 @@ public int minJavaVersion() {
     return 17;
   }
 
+  @Nullable
   @Override
   public AutoCloseable start(OpenTelemetry openTelemetry, InstrumentationConfig config) {
     logger.debug("Use runtime metrics instrumentation for Java 17+");

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/runtimemetrics/Java8RuntimeMetricsProvider.java

@@ -9,6 +9,7 @@
 import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.RuntimeMetrics;
 import io.opentelemetry.instrumentation.runtimemetrics.java8.internal.RuntimeMetricsConfigUtil;
+import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -26,6 +27,7 @@ public int minJavaVersion() {
     return 8;
   }
 
+  @Nullable
   @Override
   public AutoCloseable start(OpenTelemetry openTelemetry, InstrumentationConfig config) {
     logger.debug("Use runtime metrics instrumentation for Java 8");

instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/runtimemetrics/RuntimeMetricsAutoConfiguration.java

@@ -10,6 +10,7 @@
 import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
 import java.util.Comparator;
 import java.util.Optional;
+import javax.annotation.Nullable;
 import javax.annotation.PreDestroy;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -31,7 +32,7 @@ public class RuntimeMetricsAutoConfiguration {
   private static final Logger logger =
       LoggerFactory.getLogger(RuntimeMetricsAutoConfiguration.class);
 
-  private AutoCloseable closeable;
+  @Nullable private AutoCloseable closeable;
 
   @PreDestroy
   public void stopMetrics() throws Exception {