initial

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

@@ -0,0 +1,46 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.docs.internal;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Represents functionality of instrumentations. This class is internal and is hence not for public
+ * use. Its APIs are unstable and can change at any time.
+ */
+public enum InstrumentationFunction {
+  HTTP_ROUTE_ENRICHER("http-route-enricher"),
+  LIBRARY_DOMAIN_ENRICHER("library-domain-enricher"),
+  EXPERIMENTAL_ONLY("experimental-only"),
+  CONTEXT_PROPAGATOR("context-propagator"),
+  UPSTREAM_ADAPTER("upstream-adapter"),
+  CONFIGURATION("configuration"),
+  CONTROLLER_SPANS("controller-spans"),
+  VIEW_SPANS("view-spans"),
+  SYSTEM_METRICS("system-metrics");
+
+  private final String yamlName;
+
+  InstrumentationFunction(String yamlName) {
+    this.yamlName = yamlName;
+  }
+
+  @JsonValue
+  public String getYamlName() {
+    return yamlName;
+  }
+
+  @JsonCreator
+  public static InstrumentationFunction fromYamlName(String yamlName) {
+    for (InstrumentationFunction function : values()) {
+      if (function.yamlName.equals(yamlName)) {
+        return function;
+      }
+    }
+    throw new IllegalArgumentException("Unknown instrumentation function: " + yamlName);
+  }
+}

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

@@ -47,6 +47,8 @@ public class InstrumentationMetadata {
   @Nullable
   private Boolean overrideTelemetry;
 
+  private List<InstrumentationFunction> functions = emptyList();
+
   public InstrumentationMetadata() {
     this.classification = InstrumentationClassification.LIBRARY.name();
   }
@@ -147,6 +149,14 @@ public void setOverrideTelemetry(@Nullable Boolean overrideTelemetry) {
     this.overrideTelemetry = overrideTelemetry;
   }
 
+  public List<InstrumentationFunction> getFunctions() {
+    return functions;
+  }
+
+  public void setFunctions(@Nullable List<InstrumentationFunction> functions) {
+    this.functions = Objects.requireNonNullElse(functions, emptyList());
+  }
+
   /**
    * This class is internal and is hence not for public use. Its APIs are unstable and can change at
    * any time.
@@ -162,6 +172,7 @@ public static class Builder {
     private List<SemanticConvention> semanticConventions = emptyList();
     private List<ManualTelemetryEntry> additionalTelemetry = emptyList();
     @Nullable private Boolean overrideTelemetry;
+    private List<InstrumentationFunction> functions = emptyList();
 
     @CanIgnoreReturnValue
     public Builder description(@Nullable String description) {
@@ -217,6 +228,12 @@ public Builder overrideTelemetry(@Nullable Boolean overrideTelemetry) {
       return this;
     }
 
+    @CanIgnoreReturnValue
+    public Builder functions(@Nullable List<InstrumentationFunction> functions) {
+      this.functions = Objects.requireNonNullElse(functions, emptyList());
+      return this;
+    }
+
     public InstrumentationMetadata build() {
       InstrumentationMetadata metadata =
           new InstrumentationMetadata(
@@ -231,6 +248,7 @@ public InstrumentationMetadata build() {
               configurations);
       metadata.setAdditionalTelemetry(additionalTelemetry);
       metadata.setOverrideTelemetry(overrideTelemetry);
+      metadata.setFunctions(functions);
       return metadata;
     }
   }

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

@@ -16,6 +16,7 @@
 import io.opentelemetry.instrumentation.docs.internal.EmittedMetrics;
 import io.opentelemetry.instrumentation.docs.internal.EmittedSpans;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationClassification;
+import io.opentelemetry.instrumentation.docs.internal.InstrumentationFunction;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationMetadata;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationModule;
 import io.opentelemetry.instrumentation.docs.internal.InstrumentationType;
@@ -315,6 +316,22 @@ void testMetadataParserWithOnlyConfigurations() throws JsonProcessingException {
     assertThat(config.type()).isEqualTo(ConfigurationType.BOOLEAN);
   }
 
+  @Test
+  void testMetadataParserWithOnlyFunctions() throws JsonProcessingException {
+    String input =
+        """
+            functions:
+              - http-route-enricher
+        """;
+    InstrumentationMetadata metadata = YamlHelper.metaDataParser(input);
+
+    assertThat(metadata.getClassification()).isEqualTo(InstrumentationClassification.LIBRARY);
+    assertThat(metadata.getDescription()).isNull();
+    assertThat(metadata.getDisabledByDefault()).isFalse();
+    assertThat(metadata.getFunctions())
+        .containsExactly(InstrumentationFunction.HTTP_ROUTE_ENRICHER);
+  }
+
   @Test
   void testMetricsParsing() throws Exception {
     List<InstrumentationModule> modules = new ArrayList<>();