add Nullaway to instrumentation API incubator (#14459)

zeitlinger · web-flow · commit 74c0683520d1 · 2025-09-27T08:55:44.000-07:00
diff --git a/instrumentation-api-incubator/build.gradle.kts b/instrumentation-api-incubator/build.gradle.kts
@@ -6,6 +6,7 @@ plugins {
   id("otel.jacoco-conventions")
   id("otel.japicmp-conventions")
   id("otel.publish-conventions")
+  id("otel.nullaway-conventions")
 }
 
 group = "io.opentelemetry.instrumentation"
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java
@@ -71,7 +71,7 @@ private DefaultHttpClientInstrumenterBuilder(
       String instrumentationName,
       OpenTelemetry openTelemetry,
       HttpClientAttributesGetter<REQUEST, RESPONSE> attributesGetter,
-      TextMapSetter<REQUEST> headerSetter) {
+      @Nullable TextMapSetter<REQUEST> headerSetter) {
     this.instrumentationName = Objects.requireNonNull(instrumentationName, "instrumentationName");
     this.openTelemetry = Objects.requireNonNull(openTelemetry, "openTelemetry");
     this.attributesGetter = Objects.requireNonNull(attributesGetter, "attributesGetter");
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpServerInstrumenterBuilder.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpServerInstrumenterBuilder.java
@@ -64,7 +64,7 @@ private DefaultHttpServerInstrumenterBuilder(
       String instrumentationName,
       OpenTelemetry openTelemetry,
       HttpServerAttributesGetter<REQUEST, RESPONSE> attributesGetter,
-      TextMapGetter<REQUEST> headerGetter) {
+      @Nullable TextMapGetter<REQUEST> headerGetter) {
     this.instrumentationName = Objects.requireNonNull(instrumentationName, "instrumentationName");
     this.openTelemetry = Objects.requireNonNull(openTelemetry, "openTelemetry");
     this.attributesGetter = Objects.requireNonNull(attributesGetter, "attributesGetter");
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/CommonConfig.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/CommonConfig.java
@@ -17,8 +17,8 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
-import java.util.function.Function;
 import java.util.function.Supplier;
+import javax.annotation.Nullable;
 
 /**
  * This class is internal and is hence not for public use. Its APIs are unstable and can change at
@@ -41,6 +41,11 @@ public final class CommonConfig {
   private final String loggingSpanIdKey;
   private final String loggingTraceFlagsKey;
 
+  interface ValueProvider<T> {
+    @Nullable
+    T get(ConfigProvider configProvider);
+  }
+
   public CommonConfig(InstrumentationConfig config) {
     peerServiceResolver =
         PeerServiceResolver.create(
@@ -159,12 +164,12 @@ public String getTraceFlagsKey() {
 
   private static <T> T getFromConfigProviderOrFallback(
       InstrumentationConfig config,
-      Function<ConfigProvider, T> getFromConfigProvider,
+      ValueProvider<T> getFromConfigProvider,
       T defaultValue,
       Supplier<T> fallback) {
     ConfigProvider configProvider = config.getConfigProvider();
     if (configProvider != null) {
-      T value = getFromConfigProvider.apply(configProvider);
+      T value = getFromConfigProvider.get(configProvider);
       return value != null ? value : defaultValue;
     }
     // fallback doesn't return null, so we can safely call it
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientSpanNameExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientSpanNameExtractor.java
@@ -8,6 +8,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
 import io.opentelemetry.instrumentation.api.internal.SemconvStability;
 import java.util.Collection;
+import javax.annotation.Nullable;
 
 public abstract class DbClientSpanNameExtractor<REQUEST> implements SpanNameExtractor<REQUEST> {
 
@@ -42,7 +43,8 @@ public static <REQUEST> SpanNameExtractor<REQUEST> create(
 
   private DbClientSpanNameExtractor() {}
 
-  protected String computeSpanName(String dbName, String operation, String mainIdentifier) {
+  protected String computeSpanName(
+      @Nullable String dbName, @Nullable String operation, @Nullable String mainIdentifier) {
     if (operation == null) {
       return dbName == null ? DEFAULT_SPAN_NAME : dbName;
     }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/MultiQuery.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/MultiQuery.java
@@ -8,14 +8,16 @@
 import java.util.Collection;
 import java.util.LinkedHashSet;
 import java.util.Set;
+import javax.annotation.Nullable;
 
 class MultiQuery {
 
-  private final String mainIdentifier;
-  private final String operation;
+  @Nullable private final String mainIdentifier;
+  @Nullable private final String operation;
   private final Set<String> statements;
 
-  private MultiQuery(String mainIdentifier, String operation, Set<String> statements) {
+  private MultiQuery(
+      @Nullable String mainIdentifier, @Nullable String operation, Set<String> statements) {
     this.mainIdentifier = mainIdentifier;
     this.operation = operation;
     this.statements = statements;
@@ -40,10 +42,12 @@ static MultiQuery analyze(
         uniqueMainIdentifier.getValue(), uniqueOperation.getValue(), uniqueStatements);
   }
 
+  @Nullable
   public String getMainIdentifier() {
     return mainIdentifier;
   }
 
+  @Nullable
   public String getOperation() {
     return operation;
   }
@@ -53,10 +57,10 @@ public Set<String> getStatements() {
   }
 
   private static class UniqueValue {
-    private String value;
+    @Nullable private String value;
     private boolean valid = true;
 
-    void set(String value) {
+    void set(@Nullable String value) {
       if (!valid) {
         return;
       }
@@ -67,6 +71,7 @@ void set(String value) {
       }
     }
 
+    @Nullable
     String getValue() {
       return valid ? value : null;
     }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesGetter.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesGetter.java
@@ -8,6 +8,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
+import javax.annotation.Nullable;
 
 /**
  * An interface for getting SQL database client attributes.
@@ -33,6 +34,7 @@ public interface SqlClientAttributesGetter<REQUEST, RESPONSE>
   Collection<String> getRawQueryTexts(REQUEST request);
 
   // TODO: make this required to implement
+  @Nullable
   default Long getBatchSize(REQUEST request) {
     return null;
   }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlStatementSanitizer.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlStatementSanitizer.java
@@ -51,7 +51,7 @@ public SqlStatementInfo sanitize(@Nullable String statement, SqlDialect dialect)
         CacheKey.create(statement, dialect), k -> sanitizeImpl(statement, dialect));
   }
 
-  private static SqlStatementInfo sanitizeImpl(@Nullable String statement, SqlDialect dialect) {
+  private static SqlStatementInfo sanitizeImpl(String statement, SqlDialect dialect) {
     supportability.incrementCounter(SQL_STATEMENT_SANITIZER_CACHE_MISS);
     return AutoSqlSanitizer.sanitize(statement, dialect);
   }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/genai/GenAiAttributesGetter.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/genai/GenAiAttributesGetter.java
@@ -50,17 +50,17 @@ public interface GenAiAttributesGetter<REQUEST, RESPONSE> {
   @Nullable
   Double getRequestTopP(REQUEST request);
 
-  List<String> getResponseFinishReasons(REQUEST request, RESPONSE response);
+  List<String> getResponseFinishReasons(REQUEST request, @Nullable RESPONSE response);
 
   @Nullable
-  String getResponseId(REQUEST request, RESPONSE response);
+  String getResponseId(REQUEST request, @Nullable RESPONSE response);
 
   @Nullable
-  String getResponseModel(REQUEST request, RESPONSE response);
+  String getResponseModel(REQUEST request, @Nullable RESPONSE response);
 
   @Nullable
-  Long getUsageInputTokens(REQUEST request, RESPONSE response);
+  Long getUsageInputTokens(REQUEST request, @Nullable RESPONSE response);
 
   @Nullable
-  Long getUsageOutputTokens(REQUEST request, RESPONSE response);
+  Long getUsageOutputTokens(REQUEST request, @Nullable RESPONSE response);
 }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/http/HttpClientPeerServiceAttributesExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/http/HttpClientPeerServiceAttributesExtractor.java
@@ -76,7 +76,7 @@ public void onEnd(
 
   @Nullable
   private String mapToPeerService(
-      @Nullable String host, @Nullable Integer port, @Nullable Supplier<String> pathSupplier) {
+      @Nullable String host, @Nullable Integer port, Supplier<String> pathSupplier) {
     if (host == null) {
       return null;
     }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java
@@ -141,6 +141,7 @@ public void onEnd(
    * any time.
    */
   @Override
+  @Nullable
   public SpanKey internalGetSpanKey() {
     if (operation == null) {
       return null;
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceAttributesExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceAttributesExtractor.java
@@ -72,6 +72,6 @@ private String mapToPeerService(@Nullable String host, @Nullable Integer port) {
     if (host == null) {
       return null;
     }
-    return peerServiceResolver.resolveService(host, port, null);
+    return peerServiceResolver.resolveService(host, port, () -> null);
   }
 }
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceResolver.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceResolver.java
@@ -14,8 +14,7 @@ public interface PeerServiceResolver {
   public boolean isEmpty();
 
   @Nullable
-  public String resolveService(
-      String host, @Nullable Integer port, @Nullable Supplier<String> pathSupplier);
+  public String resolveService(String host, @Nullable Integer port, Supplier<String> pathSupplier);
 
   static PeerServiceResolver create(Map<String, String> mapping) {
     return new PeerServiceResolverImpl(mapping);
diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceResolverImpl.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/net/PeerServiceResolverImpl.java
@@ -46,8 +46,7 @@ public boolean isEmpty() {
 
   @Override
   @Nullable
-  public String resolveService(
-      String host, @Nullable Integer port, @Nullable Supplier<String> pathSupplier) {
+  public String resolveService(String host, @Nullable Integer port, Supplier<String> pathSupplier) {
     Map<ServiceMatcher, String> matchers = mapping.get(host);
     if (matchers == null) {
       return null;
@@ -62,7 +61,7 @@ public String resolveService(
   @AutoValue
   abstract static class ServiceMatcher {
 
-    static ServiceMatcher create(Integer port, String path) {
+    static ServiceMatcher create(@Nullable Integer port, @Nullable String path) {
       return new AutoValue_PeerServiceResolverImpl_ServiceMatcher(port, path);
     }
 
@@ -72,16 +71,13 @@ static ServiceMatcher create(Integer port, String path) {
     @Nullable
     abstract String getPath();
 
-    public boolean matches(Integer port, Supplier<String> pathSupplier) {
+    public boolean matches(@Nullable Integer port, Supplier<String> pathSupplier) {
       if (this.getPort() != null) {
         if (!this.getPort().equals(port)) {
           return false;
         }
       }
       if (this.getPath() != null && this.getPath().length() > 0) {
-        if (pathSupplier == null) {
-          return false;
-        }
         String path = pathSupplier.get();
         if (path == null) {
           return false;

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ plugins {`
`6`	`6`	`id("otel.jacoco-conventions")`
`7`	`7`	`id("otel.japicmp-conventions")`
`8`	`8`	`id("otel.publish-conventions")`
	`9`	`+ id("otel.nullaway-conventions")`
`9`	`10`	`}`
`10`	`11`
`11`	`12`	`group = "io.opentelemetry.instrumentation"`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,16 @@`
`8`	`8`	`import java.util.Collection;`
`9`	`9`	`import java.util.LinkedHashSet;`
`10`	`10`	`import java.util.Set;`
	`11`	`+import javax.annotation.Nullable;`
`11`	`12`
`12`	`13`	`class MultiQuery {`
`13`	`14`
`14`		`- private final String mainIdentifier;`
`15`		`- private final String operation;`
	`15`	`+ @Nullable private final String mainIdentifier;`
	`16`	`+ @Nullable private final String operation;`
`16`	`17`	`private final Set<String> statements;`
`17`	`18`
`18`		`- private MultiQuery(String mainIdentifier, String operation, Set<String> statements) {`
	`19`	`+ private MultiQuery(`
	`20`	`+ @Nullable String mainIdentifier, @Nullable String operation, Set<String> statements) {`
`19`	`21`	`this.mainIdentifier = mainIdentifier;`
`20`	`22`	`this.operation = operation;`
`21`	`23`	`this.statements = statements;`
`@@ -40,10 +42,12 @@ static MultiQuery analyze(`
`40`	`42`	`uniqueMainIdentifier.getValue(), uniqueOperation.getValue(), uniqueStatements);`
`41`	`43`	`}`
`42`	`44`
	`45`	`+ @Nullable`
`43`	`46`	`public String getMainIdentifier() {`
`44`	`47`	`return mainIdentifier;`
`45`	`48`	`}`
`46`	`49`
	`50`	`+ @Nullable`
`47`	`51`	`public String getOperation() {`
`48`	`52`	`return operation;`
`49`	`53`	`}`
`@@ -53,10 +57,10 @@ public Set<String> getStatements() {`
`53`	`57`	`}`
`54`	`58`
`55`	`59`	`private static class UniqueValue {`
`56`		`- private String value;`
	`60`	`+ @Nullable private String value;`
`57`	`61`	`private boolean valid = true;`
`58`	`62`
`59`		`- void set(String value) {`
	`63`	`+ void set(@Nullable String value) {`
`60`	`64`	`if (!valid) {`
`61`	`65`	`return;`
`62`	`66`	`}`
`@@ -67,6 +71,7 @@ void set(String value) {`
`67`	`71`	`}`
`68`	`72`	`}`
`69`	`73`
	`74`	`+ @Nullable`
`70`	`75`	`String getValue() {`
`71`	`76`	`return valid ? value : null;`
`72`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public SqlStatementInfo sanitize(@Nullable String statement, SqlDialect dialect)`
`51`	`51`	`CacheKey.create(statement, dialect), k -> sanitizeImpl(statement, dialect));`
`52`	`52`	`}`
`53`	`53`
`54`		`- private static SqlStatementInfo sanitizeImpl(@Nullable String statement, SqlDialect dialect) {`
	`54`	`+ private static SqlStatementInfo sanitizeImpl(String statement, SqlDialect dialect) {`
`55`	`55`	`supportability.incrementCounter(SQL_STATEMENT_SANITIZER_CACHE_MISS);`
`56`	`56`	`return AutoSqlSanitizer.sanitize(statement, dialect);`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public void onEnd(`
`76`	`76`
`77`	`77`	`@Nullable`
`78`	`78`	`private String mapToPeerService(`
`79`		`- @Nullable String host, @Nullable Integer port, @Nullable Supplier<String> pathSupplier) {`
	`79`	`+ @Nullable String host, @Nullable Integer port, Supplier<String> pathSupplier) {`
`80`	`80`	`if (host == null) {`
`81`	`81`	`return null;`
`82`	`82`	`}`