updates

jaydeluca · jaydeluca · commit 617c8cdf2f47 · 2025-09-26T15:21:20.000-04:00
diff --git a/docs/contributing/documenting-instrumentation.md b/docs/contributing/documenting-instrumentation.md
@@ -88,6 +88,9 @@ semantic_conventions:
   - HTTP_CLIENT_SPANS
   - DATABASE_CLIENT_SPANS
   - JVM_RUNTIME_METRICS
+functions:
+  - HTTP_ROUTE_ENRICHER
+  - CONTEXT_PROPAGATION
 disabled_by_default: true
 classification: library
 library_link: https://github.com/...
@@ -174,6 +177,23 @@ List of possible options:
 * [GENAI_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-spans.md)
 * [GENAI_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-metrics.md#generative-ai-client-metrics)
 
+### Functions (optional)
+
+As a way to help further categorize instrumentations, you can add a `functions` field with a list of
+the relevant functionality descriptions.
+
+List of possible options:
+
+* `HTTP_ROUTE_ENRICHER`: Instrumentation that enriches HTTP spans with route information
+* `LIBRARY_DOMAIN_ENRICHER`: Instrumentation that enriches spans with library-specific domain information
+* `EXPERIMENTAL_ONLY`: Instrumentation that is experimental and may not be stable
+* `CONTEXT_PROPAGATION`: Instrumentation that provides context propagation capabilities
+* `UPSTREAM_ADAPTER`: Instrumentation that adapts or bridges instrumentation from upstream libraries or frameworks
+* `CONFIGURATION`: Instrumentation that provides configuration-related functionality
+* `CONTROLLER_SPANS`: Instrumentation that generates controller-level spans
+* `VIEW_SPANS`: Instrumentation that generates view-level spans
+* `SYSTEM_METRICS`: Instrumentation that generates system-level metrics
+
 ### Library Link
 
 For library instrumentations, include a `library_link` field with a URL to the library or framework's
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
@@ -70,6 +70,8 @@ libraries:
     description: This instrumentation provides context propagation for Akka actors,
       it does not emit any telemetry on its own.
     library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
+    functions:
+    - CONTEXT_PROPAGATION
     source_path: instrumentation/akka/akka-actor-2.3
     scope:
       name: io.opentelemetry.akka-actor-2.3
@@ -83,6 +85,8 @@ libraries:
     description: This instrumentation provides context propagation for the Akka Fork-Join
       Pool, it does not emit any telemetry on its own.
     library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
+    functions:
+    - CONTEXT_PROPAGATION
     source_path: instrumentation/akka/akka-actor-fork-join-2.5
     scope:
       name: io.opentelemetry.akka-actor-fork-join-2.5
@@ -101,6 +105,8 @@ libraries:
     - HTTP_SERVER_SPANS
     - HTTP_SERVER_METRICS
     library_link: https://doc.akka.io/docs/akka-http/current/index.html
+    functions:
+    - HTTP_ROUTE_ENRICHER
     source_path: instrumentation/akka/akka-http-10.0
     scope:
       name: io.opentelemetry.akka-http-10.0
diff --git a/instrumentation-docs/instrumentations.sh b/instrumentation-docs/instrumentations.sh
@@ -14,13 +14,12 @@ readonly INSTRUMENTATIONS=(
   "apache-dbcp-2.0:javaagent:test"
   "apache-dbcp-2.0:javaagent:testStableSemconv"
   "apache-dubbo-2.7:javaagent:testDubbo"
-  "apache-dubbo-2.7:javaagent:testDubbo"
   "apache-httpasyncclient-4.1:javaagent:test"
   "apache-httpclient:apache-httpclient-2.0:javaagent:test"
   "apache-httpclient:apache-httpclient-4.0:javaagent:test"
-  #  "apache-httpclient:apache-httpclient-4.3:library:test"  # See https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/14771
+  "apache-httpclient:apache-httpclient-4.3:library:test"
   "apache-httpclient:apache-httpclient-5.0:javaagent:test"
-  #  "apache-httpclient:apache-httpclient-5.2:library:test"  # See https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/14771
+  "apache-httpclient:apache-httpclient-5.2:library:test"
   "armeria:armeria-1.3:javaagent:test"
   "armeria:armeria-grpc-1.14:javaagent:test"
   "async-http-client:async-http-client-1.9:javaagent:test"
diff --git a/instrumentation-docs/readme.md b/instrumentation-docs/readme.md
@@ -134,6 +134,18 @@ public class SpringWebInstrumentationModule extends InstrumentationModule
     * FAAS_SERVER_SPANS
     * GENAI_CLIENT_SPANS
     * GENAI_CLIENT_METRIC
+* functions
+  * The specific functionality that the instrumentation provides
+  * Options are:
+    * HTTP_ROUTE_ENRICHER
+    * LIBRARY_DOMAIN_ENRICHER
+    * EXPERIMENTAL_ONLY
+    * CONTEXT_PROPAGATION
+    * UPSTREAM_ADAPTER
+    * CONFIGURATION
+    * CONTROLLER_SPANS
+    * VIEW_SPANS
+    * SYSTEM_METRICS
 * library_link
   * URL to the library or framework's main website or documentation, or if those don't exist, the
   GitHub repository.
@@ -173,6 +185,9 @@ semantic_conventions:                             # List of semantic conventions
   - HTTP_CLIENT_SPANS
   - DATABASE_CLIENT_SPANS
   - JVM_RUNTIME_METRICS
+functions:                                        # List of functions this instrumentation provides
+  - HTTP_ROUTE_ENRICHER
+  - CONTEXT_PROPAGATION
 disabled_by_default: true                         # Defaults to `false`
 classification: internal                          # instrumentation classification: library | internal | custom
 library_link: https://...                         # URL to the library or framework's main website or documentation
diff --git a/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationFunction.java b/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationFunction.java
@@ -5,42 +5,18 @@
 
 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 name;
-
-  InstrumentationFunction(String name) {
-    this.name = name;
-  }
-
-  @JsonValue
-  public String getName() {
-    return name;
-  }
-
-  @JsonCreator
-  public static InstrumentationFunction fromYamlName(String yamlName) {
-    for (InstrumentationFunction function : values()) {
-      if (function.name.equals(yamlName)) {
-        return function;
-      }
-    }
-    throw new IllegalArgumentException("Unknown instrumentation function: " + yamlName);
-  }
+  HTTP_ROUTE_ENRICHER,
+  LIBRARY_DOMAIN_ENRICHER,
+  EXPERIMENTAL_ONLY,
+  CONTEXT_PROPAGATION,
+  UPSTREAM_ADAPTER,
+  CONFIGURATION,
+  CONTROLLER_SPANS,
+  VIEW_SPANS,
+  SYSTEM_METRICS
 }
diff --git a/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/utils/YamlHelper.java b/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/utils/YamlHelper.java
@@ -218,7 +218,7 @@ private static void addMetadataProperties(
       if (!module.getMetadata().getFunctions().isEmpty()) {
         List<String> functionNames =
             module.getMetadata().getFunctions().stream()
-                .map(function -> function.getName())
+                .map(Enum::name)
                 .collect(Collectors.toList());
         moduleMap.put("functions", functionNames);
       }
diff --git a/instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/utils/YamlHelperTest.java b/instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/utils/YamlHelperTest.java
@@ -126,7 +126,7 @@ void testGenerateInstrumentationYamlSeparatesClassifications() throws Exception
             .functions(
                 List.of(
                     InstrumentationFunction.HTTP_ROUTE_ENRICHER,
-                    InstrumentationFunction.CONTEXT_PROPAGATOR))
+                    InstrumentationFunction.CONTEXT_PROPAGATION))
             .semanticConventions(List.of(DATABASE_CLIENT_METRICS, DATABASE_CLIENT_SPANS))
             .configurations(
                 List.of(
@@ -199,8 +199,8 @@ void testGenerateInstrumentationYamlSeparatesClassifications() throws Exception
                 - DATABASE_CLIENT_METRICS
                 - DATABASE_CLIENT_SPANS
                 functions:
-                - http-route-enricher
-                - context-propagator
+                - HTTP_ROUTE_ENRICHER
+                - CONTEXT_PROPAGATION
                 source_path: instrumentation/spring/spring-web/spring-web-6.0
                 minimum_java_version: 11
                 scope:
@@ -240,8 +240,8 @@ void testMetadataParser() throws JsonProcessingException {
             disabled_by_default: true
             library_link: https://example.com/test-library
             functions:
-              - http-route-enricher
-              - library-domain-enricher
+              - HTTP_ROUTE_ENRICHER
+              - LIBRARY_DOMAIN_ENRICHER
             configurations:
               - name: otel.instrumentation.common.db-statement-sanitizer.enabled
                 description: Enables statement sanitization for database queries.
@@ -340,7 +340,7 @@ void testMetadataParserWithOnlyFunctions() throws JsonProcessingException {
     String input =
         """
             functions:
-              - http-route-enricher
+              - HTTP_ROUTE_ENRICHER
         """;
     InstrumentationMetadata metadata = YamlHelper.metaDataParser(input);
 
diff --git a/instrumentation/akka/akka-actor-2.3/metadata.yaml b/instrumentation/akka/akka-actor-2.3/metadata.yaml
@@ -2,4 +2,4 @@ display_name: Akka Actors
 description: This instrumentation provides context propagation for Akka actors, it does not emit any telemetry on its own.
 library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
 functions:
-  - context-propagation
+  - CONTEXT_PROPAGATION
diff --git a/instrumentation/akka/akka-actor-fork-join-2.5/metadata.yaml b/instrumentation/akka/akka-actor-fork-join-2.5/metadata.yaml
@@ -2,4 +2,4 @@ display_name: Akka Actors
 description: This instrumentation provides context propagation for the Akka Fork-Join Pool, it does not emit any telemetry on its own.
 library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
 functions:
-  - context-propagation
+  - CONTEXT_PROPAGATION
diff --git a/instrumentation/akka/akka-http-10.0/metadata.yaml b/instrumentation/akka/akka-http-10.0/metadata.yaml
@@ -9,4 +9,4 @@ semantic_conventions:
   - HTTP_SERVER_SPANS
   - HTTP_SERVER_METRICS
 functions:
-  - http-route-enricher
+  - HTTP_ROUTE_ENRICHER

Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ private static void addMetadataProperties(`
`218`	`218`	`if (!module.getMetadata().getFunctions().isEmpty()) {`
`219`	`219`	`List<String> functionNames =`
`220`	`220`	`module.getMetadata().getFunctions().stream()`
`221`		`- .map(function -> function.getName())`
	`221`	`+ .map(Enum::name)`
`222`	`222`	`.collect(Collectors.toList());`
`223`	`223`	`moduleMap.put("functions", functionNames);`
`224`	`224`	`}`