rename and update test

Author: jaydeluca

instrumentation-docs/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
   id("otel.java-conventions")
-//  id("otel.nullaway-conventions")
+  id("otel.nullaway-conventions")
 }
 
 otelJava {

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationFunction.java

@@ -23,21 +23,21 @@ public enum InstrumentationFunction {
   VIEW_SPANS("view-spans"),
   SYSTEM_METRICS("system-metrics");
 
-  private final String yamlName;
+  private final String name;
 
-  InstrumentationFunction(String yamlName) {
-    this.yamlName = yamlName;
+  InstrumentationFunction(String name) {
+    this.name = name;
   }
 
   @JsonValue
-  public String getYamlName() {
-    return yamlName;
+  public String getName() {
+    return name;
   }
 
   @JsonCreator
   public static InstrumentationFunction fromYamlName(String yamlName) {
     for (InstrumentationFunction function : values()) {
-      if (function.yamlName.equals(yamlName)) {
+      if (function.name.equals(yamlName)) {
         return function;
       }
     }

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/utils/YamlHelper.java

@@ -215,6 +215,13 @@ private static void addMetadataProperties(
       if (module.getMetadata().getDisabledByDefault()) {
         moduleMap.put("disabled_by_default", module.getMetadata().getDisabledByDefault());
       }
+      if (!module.getMetadata().getFunctions().isEmpty()) {
+        List<String> functionNames =
+            module.getMetadata().getFunctions().stream()
+                .map(function -> function.getName())
+                .collect(Collectors.toList());
+        moduleMap.put("functions", functionNames);
+      }
     }
   }
 

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/ManualTelemetryTest.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.docs;
 
+import static java.util.Collections.emptyList;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -142,40 +143,11 @@ void testEmptyAdditionalTelemetry() throws JsonProcessingException {
 
     InstrumentationMetadata actualMetadata = YamlHelper.metaDataParser(yamlContent);
 
-    ManualTelemetryEntry defaultEntry =
-        new ManualTelemetryEntry(
-            "default",
-            List.of(
-                new ManualTelemetryEntry.ManualMetric(
-                    "system.disk.io",
-                    "System disk IO",
-                    "LONG_SUM",
-                    "By",
-                    List.of(
-                        new TelemetryAttribute("device", "STRING"),
-                        new TelemetryAttribute("direction", "STRING")))),
-            List.of(
-                new ManualTelemetryEntry.ManualSpan(
-                    "CLIENT", List.of(new TelemetryAttribute("custom.operation", "STRING")))));
-
-    ManualTelemetryEntry experimentalEntry =
-        new ManualTelemetryEntry(
-            "experimental",
-            List.of(
-                new ManualTelemetryEntry.ManualMetric(
-                    "experimental.feature.usage",
-                    "Usage of experimental features",
-                    "HISTOGRAM",
-                    "s",
-                    List.of(new TelemetryAttribute("feature.name", "STRING")))),
-            List.of());
-
     InstrumentationMetadata expectedMetadata =
         new InstrumentationMetadata.Builder()
-            .description("Example instrumentation with manual telemetry documentation")
-            .libraryLink("https://example.com/library")
+            .description("Example without manual telemetry")
             .semanticConventions(List.of(SemanticConvention.HTTP_CLIENT_SPANS))
-            .additionalTelemetry(List.of(defaultEntry, experimentalEntry))
+            .additionalTelemetry(emptyList())
             .overrideTelemetry(false)
             .build();
 

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/utils/YamlHelperTest.java

@@ -123,6 +123,11 @@ void testGenerateInstrumentationYamlSeparatesClassifications() throws Exception
             .description("Spring Web 6.0 instrumentation")
             .classification(InstrumentationClassification.LIBRARY.name())
             .disabledByDefault(false)
+            .functions(
+                List.of(
+                    InstrumentationFunction.HTTP_ROUTE_ENRICHER,
+                    InstrumentationFunction.CONTEXT_PROPAGATOR))
+            .semanticConventions(List.of(DATABASE_CLIENT_METRICS, DATABASE_CLIENT_SPANS))
             .configurations(
                 List.of(
                     new ConfigurationOption(
@@ -190,6 +195,12 @@ void testGenerateInstrumentationYamlSeparatesClassifications() throws Exception
               spring:
               - name: spring-web-6.0
                 description: Spring Web 6.0 instrumentation
+                semantic_conventions:
+                - DATABASE_CLIENT_METRICS
+                - DATABASE_CLIENT_SPANS
+                functions:
+                - http-route-enricher
+                - context-propagator
                 source_path: instrumentation/spring/spring-web/spring-web-6.0
                 minimum_java_version: 11
                 scope:
@@ -228,6 +239,9 @@ void testMetadataParser() throws JsonProcessingException {
             classification: internal
             disabled_by_default: true
             library_link: https://example.com/test-library
+            functions:
+              - http-route-enricher
+              - library-domain-enricher
             configurations:
               - name: otel.instrumentation.common.db-statement-sanitizer.enabled
                 description: Enables statement sanitization for database queries.
@@ -244,6 +258,11 @@ void testMetadataParser() throws JsonProcessingException {
         .isEqualTo("Enables statement sanitization for database queries.");
     assertThat(config.defaultValue()).isEqualTo("true");
 
+    assertThat(metadata.getFunctions())
+        .containsExactly(
+            InstrumentationFunction.HTTP_ROUTE_ENRICHER,
+            InstrumentationFunction.LIBRARY_DOMAIN_ENRICHER);
+
     assertThat(metadata.getClassification()).isEqualTo(InstrumentationClassification.INTERNAL);
     assertThat(metadata.getDescription()).isEqualTo("test description");
     assertThat(metadata.getDisabledByDefault()).isEqualTo(true);