Metadata for influxdb, java server and client, jul, and javalin (#15166)

jaydeluca · web-flow · commit d757dd81a5a7 · 2025-10-29T10:52:36.000+02:00
diff --git a/docs/contributing/documenting-instrumentation.md b/docs/contributing/documenting-instrumentation.md
@@ -209,6 +209,7 @@ List of possible options:
 * `AUTO_INSTRUMENTATION_SHIM`: Instrumentation that adapts or bridges instrumentation from upstream libraries or frameworks
 * `CONTROLLER_SPANS`: Instrumentation that generates controller-level spans for controller/handler methods in web frameworks (disabled by default, experimental)
 * `VIEW_SPANS`: Instrumentation that generates view-level spans for view rendering such as templates or JSP (disabled by default, experimental)
+* `LOGGING_BRIDGE`: Instrumentation that bridges logging framework events to the OpenTelemetry Logs API. These instrumentations capture log records from standard logging frameworks and emit them as OpenTelemetry log records.
 
 ### Library Link
 
diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml
@@ -5044,6 +5044,11 @@ libraries:
     target_versions:
       javaagent:
       - org.influxdb:influxdb-java:[2.4,)
+    configurations:
+    - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+      description: Enables or disables statement sanitization for database queries.
+      type: boolean
+      default: true
     telemetry:
     - when: default
       spans:
@@ -5097,6 +5102,9 @@ libraries:
   - name: java-http-client
     description: This instrumentation enables HTTP client spans and HTTP client metrics
       for requests made using the Java HTTP client.
+    semantic_conventions:
+    - HTTP_CLIENT_SPANS
+    - HTTP_CLIENT_METRICS
     library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html
     source_path: instrumentation/java-http-client
     minimum_java_version: 11
@@ -5175,6 +5183,9 @@ libraries:
   - name: java-http-server
     description: This instrumentation enables HTTP server spans and HTTP server metrics
       for the Java HTTP server.
+    semantic_conventions:
+    - HTTP_SERVER_SPANS
+    - HTTP_SERVER_METRICS
     library_link: https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html
     source_path: instrumentation/java-http-server
     scope:
@@ -5255,11 +5266,29 @@ libraries:
           type: STRING
         - name: user_agent.original
           type: STRING
+  - name: java-util-logging
+    display_name: Java Util Logging (JUL)
+    description: This instrumentation bridges Java Util Logging (JUL) log records
+      to OpenTelemetry logs.
+    library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html
+    features:
+    - LOGGING_BRIDGE
+    source_path: instrumentation/java-util-logging
+    scope:
+      name: io.opentelemetry.java-util-logging
+    configurations:
+    - name: otel.instrumentation.java-util-logging.experimental-log-attributes
+      description: Enables capturing the experimental `thread.name` and `thread.id`
+        log attributes.
+      type: boolean
+      default: false
   javalin:
   - name: javalin-5.0
     description: This instrumentation enriches existing HTTP server spans with route
       information, it does not emit any telemetry on its own.
     library_link: https://javalin.io/
+    features:
+    - HTTP_ROUTE
     source_path: instrumentation/javalin-5.0
     minimum_java_version: 11
     scope:
@@ -9257,10 +9286,6 @@ internal:
   source_path: instrumentation/internal/internal-class-loader
   scope:
     name: io.opentelemetry.internal-class-loader
-- name: java-util-logging
-  source_path: instrumentation/java-util-logging
-  scope:
-    name: io.opentelemetry.java-util-logging
 - name: internal-reflection
   source_path: instrumentation/internal/internal-reflection
   scope:
diff --git a/instrumentation-docs/readme.md b/instrumentation-docs/readme.md
@@ -142,6 +142,7 @@ public class SpringWebInstrumentationModule extends InstrumentationModule
     * AUTO_INSTRUMENTATION_SHIM
     * CONTROLLER_SPANS
     * VIEW_SPANS
+    * LOGGING_BRIDGE
 * library_link
   * URL to the library or framework's main website or documentation, or if those don't exist, the
   GitHub repository.
diff --git a/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationFeature.java b/instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationFeature.java
@@ -15,4 +15,5 @@ public enum InstrumentationFeature {
   AUTO_INSTRUMENTATION_SHIM,
   CONTROLLER_SPANS,
   VIEW_SPANS,
+  LOGGING_BRIDGE
 }
diff --git a/instrumentation/influxdb-2.4/metadata.yaml b/instrumentation/influxdb-2.4/metadata.yaml
@@ -4,3 +4,8 @@ semantic_conventions:
   - DATABASE_CLIENT_SPANS
   - DATABASE_CLIENT_METRICS
 library_link: https://github.com/influxdata/influxdb-java
+configurations:
+  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
+    description: Enables or disables statement sanitization for database queries.
+    type: boolean
+    default: true
diff --git a/instrumentation/java-http-client/metadata.yaml b/instrumentation/java-http-client/metadata.yaml
@@ -1,4 +1,7 @@
 description: This instrumentation enables HTTP client spans and HTTP client metrics for requests made using the Java HTTP client.
+semantic_conventions:
+  - HTTP_CLIENT_SPANS
+  - HTTP_CLIENT_METRICS
 library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html
 configurations:
   - name: otel.instrumentation.http.known-methods
diff --git a/instrumentation/java-http-server/metadata.yaml b/instrumentation/java-http-server/metadata.yaml
@@ -1,4 +1,7 @@
 description: This instrumentation enables HTTP server spans and HTTP server metrics for the Java HTTP server.
+semantic_conventions:
+  - HTTP_SERVER_SPANS
+  - HTTP_SERVER_METRICS
 library_link: https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html
 configurations:
   - name: otel.instrumentation.http.known-methods
diff --git a/instrumentation/java-util-logging/javaagent/build.gradle.kts b/instrumentation/java-util-logging/javaagent/build.gradle.kts
@@ -13,7 +13,15 @@ dependencies {
   testImplementation("org.awaitility:awaitility")
 }
 
-tasks.withType<Test>().configureEach {
-  // TODO run tests both with and without experimental log attributes
-  jvmArgs("-Dotel.instrumentation.java-util-logging.experimental-log-attributes=true")
+tasks {
+  val testExperimental by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.instrumentation.java-util-logging.experimental-log-attributes=true")
+  }
+
+  check {
+    dependsOn(testExperimental)
+  }
 }
diff --git a/instrumentation/java-util-logging/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jul/JavaUtilLoggingTest.java b/instrumentation/java-util-logging/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jul/JavaUtilLoggingTest.java
@@ -18,6 +18,7 @@
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
 import io.opentelemetry.sdk.logs.data.LogRecordData;
 import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes;
+import io.opentelemetry.testing.internal.armeria.common.annotation.Nullable;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Stream;
@@ -27,6 +28,8 @@
 import org.junit.jupiter.params.provider.MethodSource;
 
 class JavaUtilLoggingTest {
+  private static final boolean isExperimentalAttributesEnabled =
+      Boolean.getBoolean("otel.instrumentation.java-util-logging.experimental-log-attributes");
 
   private static final Logger logger = Logger.getLogger("abc");
 
@@ -117,17 +120,25 @@ private static void test(
       if (logException) {
         assertThat(log)
             .hasAttributesSatisfyingExactly(
-                equalTo(ThreadIncubatingAttributes.THREAD_NAME, Thread.currentThread().getName()),
-                equalTo(ThreadIncubatingAttributes.THREAD_ID, Thread.currentThread().getId()),
+                equalTo(
+                    ThreadIncubatingAttributes.THREAD_NAME,
+                    experimental(Thread.currentThread().getName())),
+                equalTo(
+                    ThreadIncubatingAttributes.THREAD_ID,
+                    experimental(Thread.currentThread().getId())),
                 equalTo(EXCEPTION_TYPE, IllegalStateException.class.getName()),
                 equalTo(EXCEPTION_MESSAGE, "hello"),
                 satisfies(
                     EXCEPTION_STACKTRACE, v -> v.contains(JavaUtilLoggingTest.class.getName())));
       } else {
         assertThat(log)
             .hasAttributesSatisfyingExactly(
-                equalTo(ThreadIncubatingAttributes.THREAD_NAME, Thread.currentThread().getName()),
-                equalTo(ThreadIncubatingAttributes.THREAD_ID, Thread.currentThread().getId()));
+                equalTo(
+                    ThreadIncubatingAttributes.THREAD_NAME,
+                    experimental(Thread.currentThread().getName())),
+                equalTo(
+                    ThreadIncubatingAttributes.THREAD_ID,
+                    experimental(Thread.currentThread().getId())));
       }
 
       if (withParent) {
@@ -164,4 +175,20 @@ private static void performLogging(
   interface LoggerMethod {
     void call(Logger logger, String msg);
   }
+
+  @Nullable
+  public static String experimental(String value) {
+    if (isExperimentalAttributesEnabled) {
+      return value;
+    }
+    return null;
+  }
+
+  @Nullable
+  public static Long experimental(long value) {
+    if (isExperimentalAttributesEnabled) {
+      return value;
+    }
+    return null;
+  }
 }
diff --git a/instrumentation/java-util-logging/metadata.yaml b/instrumentation/java-util-logging/metadata.yaml
@@ -1 +1,10 @@
-classification: internal
+display_name: Java Util Logging (JUL)
+description: This instrumentation bridges Java Util Logging (JUL) log records to OpenTelemetry logs.
+features:
+  - LOGGING_BRIDGE
+library_link: https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/package-summary.html
+configurations:
+  - name: otel.instrumentation.java-util-logging.experimental-log-attributes
+    description: Enables capturing the experimental `thread.name` and `thread.id` log attributes.
+    type: boolean
+    default: false
diff --git a/instrumentation/javalin-5.0/metadata.yaml b/instrumentation/javalin-5.0/metadata.yaml
@@ -1,2 +1,4 @@
 description: This instrumentation enriches existing HTTP server spans with route information, it does not emit any telemetry on its own.
+features:
+  - HTTP_ROUTE
 library_link: https://javalin.io/

Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,5 @@ public enum InstrumentationFeature {`
`15`	`15`	`AUTO_INSTRUMENTATION_SHIM,`
`16`	`16`	`CONTROLLER_SPANS,`
`17`	`17`	`VIEW_SPANS,`
	`18`	`+ LOGGING_BRIDGE`
`18`	`19`	`}`