Add jdk.httpserver instrumentation (#13243)

Co-authored-by: Lauri Tulmin <[email protected]>

Author: SentryMan

.fossa.yml

@@ -148,6 +148,12 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:java-http-client:library'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:java-http-server:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:java-http-server:library'
     - type: gradle
       path: ./
       target: ':instrumentation:java-util-logging:javaagent'

docs/supported-libraries.md

@@ -80,6 +80,7 @@ These are the supported libraries and frameworks:
 | [InfluxDB Client](https://github.com/influxdata/influxdb-java)                                                                              | 2.4+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Client Spans], [Database Client Metrics] [6]                                                                             |
 | [Java Executors](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html)                                              | Java 8+                            | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                     |
 | [Java Http Client](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html)                     | Java 11+                           | [opentelemetry-java-http-client](../instrumentation/java-http-client/library)                                                                                                                                                                                                                                                                                                           | [HTTP Client Spans], [HTTP Client Metrics]                                                                                              |
+| [Java Http Server](https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html)                                   | Java 8+                            | [opentelemetry-java-http-server](../instrumentation/java-http-server/library)                                                                                                                                                                                                                                                                                                           | [HTTP Server Spans], [HTTP Server Metrics]                                                                                              |
 | [java.util.logging](https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html)                                       | Java 8+                            | N/A                                                                                                                                                                                                                                                                                                                                                                                     | none                                                                                                                                    |
 | [Java Platform](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ManagementFactory.html)                                      | Java 8+                            | [opentelemetry-runtime-telemetry-java8](../instrumentation/runtime-telemetry/runtime-telemetry-java8/library),<br>[opentelemetry-runtime-telemetry-java17](../instrumentation/runtime-telemetry/runtime-telemetry-java17/library),<br>[opentelemetry-resources](../instrumentation/resources/library)                                                                                   | [JVM Runtime Metrics]                                                                                                                   |
 | [Javalin](https://javalin.io/)                                                                                                              | 5.0+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Provides `http.route` [2]                                                                                                               |

instrumentation/java-http-server/javaagent/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    coreJdk()
+  }
+}
+
+dependencies {
+  implementation(project(":instrumentation:java-http-server:library"))
+  testImplementation(project(":instrumentation:java-http-server:testing"))
+}

instrumentation/java-http-server/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/HttpServerInstrumentation.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.extendsClass;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isPublic;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import com.sun.net.httpserver.HttpContext;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class HttpServerInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return extendsClass(named("com.sun.net.httpserver.HttpServer"));
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod().and(isPublic()).and(named("createContext")),
+        HttpServerInstrumentation.class.getName() + "$BuildAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class BuildAdvice {
+
+    @Advice.OnMethodExit(suppress = Throwable.class)
+    public static void onExit(@Advice.Return HttpContext httpContext) {
+      httpContext.getFilters().addAll(JavaHttpServerSingletons.FILTERS);
+    }
+  }
+}

instrumentation/java-http-server/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/JavaHttpServerInstrumentationModule.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import static java.util.Collections.singletonList;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.List;
+
+@AutoService(InstrumentationModule.class)
+public class JavaHttpServerInstrumentationModule extends InstrumentationModule {
+  public JavaHttpServerInstrumentationModule() {
+    super("java-http-server");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new HttpServerInstrumentation());
+  }
+}

instrumentation/java-http-server/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/JavaHttpServerResponseMutator.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import com.sun.net.httpserver.Headers;
+import io.opentelemetry.javaagent.bootstrap.http.HttpServerResponseMutator;
+
+enum JavaHttpServerResponseMutator implements HttpServerResponseMutator<Headers> {
+  INSTANCE;
+
+  @Override
+  public void appendHeader(Headers response, String name, String value) {
+    response.add(name, value);
+  }
+}

instrumentation/java-http-server/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/JavaHttpServerSingletons.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import com.sun.net.httpserver.Filter;
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.CommonConfig;
+import io.opentelemetry.instrumentation.javahttpserver.JavaHttpServerTelemetry;
+import io.opentelemetry.instrumentation.javahttpserver.JavaHttpServerTelemetryBuilder;
+import io.opentelemetry.instrumentation.javahttpserver.internal.JavaHttpServerInstrumenterBuilderUtil;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
+import java.util.Arrays;
+import java.util.List;
+
+public final class JavaHttpServerSingletons {
+
+  public static final List<Filter> FILTERS;
+
+  static {
+    CommonConfig config = AgentCommonConfig.get();
+
+    JavaHttpServerTelemetryBuilder serverBuilder =
+        JavaHttpServerTelemetry.builder(GlobalOpenTelemetry.get());
+    JavaHttpServerInstrumenterBuilderUtil.getServerBuilderExtractor()
+        .apply(serverBuilder)
+        .configure(config);
+    JavaHttpServerTelemetry serverTelemetry = serverBuilder.build();
+
+    FILTERS = Arrays.asList(serverTelemetry.newFilter(), new ResponseCustomizingFilter());
+  }
+
+  private JavaHttpServerSingletons() {}
+}

instrumentation/java-http-server/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/ResponseCustomizingFilter.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import com.sun.net.httpserver.Filter;
+import com.sun.net.httpserver.HttpExchange;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.javaagent.bootstrap.http.HttpServerResponseCustomizerHolder;
+import java.io.IOException;
+
+final class ResponseCustomizingFilter extends Filter {
+
+  ResponseCustomizingFilter() {}
+
+  @Override
+  public void doFilter(HttpExchange exchange, Chain chain) throws IOException {
+    Context context = Context.current();
+    HttpServerResponseCustomizerHolder.getCustomizer()
+        .customize(context, exchange.getResponseHeaders(), JavaHttpServerResponseMutator.INSTANCE);
+    chain.doFilter(exchange);
+  }
+
+  @Override
+  public String description() {
+    return "OpenTelemetry response customizing filter";
+  }
+}

instrumentation/java-http-server/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/javahttpserver/JavaHttpServerTest.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.javahttpserver;
+
+import io.opentelemetry.instrumentation.javahttpserver.AbstractJavaHttpServerTest;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.HttpServerInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.http.HttpServerTestOptions;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class JavaHttpServerTest extends AbstractJavaHttpServerTest {
+
+  @RegisterExtension
+  static final InstrumentationExtension testing = HttpServerInstrumentationExtension.forAgent();
+
+  @Override
+  protected void configure(HttpServerTestOptions options) {
+    super.configure(options);
+
+    options.setHasResponseCustomizer(serverEndpoint -> true);
+  }
+}

instrumentation/java-http-server/library/README.md

@@ -0,0 +1,63 @@
+# Library Instrumentation for Java HTTP Server
+
+Provides OpenTelemetry instrumentation for [Java HTTP Server](https://docs.oracle.com/en/java/javase/21/docs/api/jdk.httpserver/module-summary.html).
+
+## Quickstart
+
+### Add these dependencies to your project
+
+Replace `OPENTELEMETRY_VERSION` with the [latest
+release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-java-http-server).
+
+For Maven, add to your `pom.xml` dependencies:
+
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.opentelemetry.instrumentation</groupId>
+    <artifactId>opentelemetry-java-http-server</artifactId>
+    <version>OPENTELEMETRY_VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+For Gradle, add to your dependencies:
+
+```groovy
+implementation("io.opentelemetry.instrumentation:opentelemetry-java-http-server:OPENTELEMETRY_VERSION")
+```
+
+### Usage
+
+The instrumentation library contains a `Filter` wrapper that provides OpenTelemetry-based spans
+and context propagation.
+
+```java
+
+import java.io.IOException;
+import java.net.InetSocketAddress;
+
+import com.sun.net.httpserver.HttpContext;
+import com.sun.net.httpserver.HttpServer;
+
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+
+public class Application {
+
+  static void main(String args) throws IOException {
+
+    final HttpServer server = HttpServer.create(new InetSocketAddress(8080), 0);
+    final HttpContext context =
+        server.createContext(
+            "/",
+            ctx -> {
+              // http logic
+            });
+
+    OpenTelemetry openTelemetry = //...
+
+    JavaHttpServerTelemetry.create(openTelemetry).configure(context);
+  }
+}
+```