feat: Add OpenTelemetry instrumentation for ActiveJ HTTP server

.fossa.yml

@@ -49,6 +49,9 @@ targets:
     - type: gradle
       path: ./
       target: ':testing:agent-for-testing'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:activej-http-6.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:alibaba-druid-1.0:javaagent'

docs/supported-libraries.md

@@ -19,6 +19,7 @@ These are the supported libraries and frameworks:
 
 | Library/Framework                                                                                                                           | Auto-instrumented versions         | Standalone Library Instrumentation [1]                                                                                                                                                                                                                                                                                                                                                  | Semantic Conventions                                                                                                                    |
 |---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| [ActiveJ](https://activej.io/)                                                                                                              | 6.0+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [HTTP Server Spans], [HTTP Server Metrics]                                                                                              |
 | [Akka Actors](https://doc.akka.io/docs/akka/current/typed/index.html)                                                                       | 2.3+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                     |
 | [Akka HTTP](https://doc.akka.io/docs/akka-http/current/index.html)                                                                          | 10.0+                              | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics], Provides `http.route` [2]                       |
 | [Alibaba Druid](https://github.com/alibaba/druid)                                                                                           | 1.0+                               | [opentelemetry-alibaba-druid-1.0](../instrumentation/alibaba-druid-1.0/library)                                                                                                                                                                                                                                                                                                         | [Database Pool Metrics]                                                                                                                 |

instrumentation/activej-http-6.0/javaagent/build.gradle.kts

@@ -0,0 +1,21 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("io.activej")
+    module.set("activej-http")
+    versions.set("[6.0,)")
+    assertInverse.set(true)
+  }
+}
+
+dependencies {
+  library("io.activej:activej-http:6.0-rc2")
+  latestDepTestLibrary("io.activej:activej-http:6.+") // documented limitation, can be removed when there is a non rc version in 6.x series
+}
+
+otelJava {
+  minJavaVersionSupported.set(JavaVersion.VERSION_17)
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/ActivejHttpServerConnectionInstrumentation.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasSuperType;
+import static io.opentelemetry.javaagent.instrumentation.activejhttp.ActivejHttpServerConnectionSingletons.instrumenter;
+import static net.bytebuddy.matcher.ElementMatchers.isInterface;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.not;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import io.activej.http.AsyncServlet;
+import io.activej.http.HttpRequest;
+import io.activej.http.HttpResponse;
+import io.activej.promise.Promise;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+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 ActivejHttpServerConnectionInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return hasSuperType(named("io.activej.http.AsyncServlet")).and(not(isInterface()));
+  }
+
+  @Override
+  public ElementMatcher<ClassLoader> classLoaderOptimization() {
+    return hasClassesNamed("io.activej.http.AsyncServlet");
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod()
+            .and(named("serve"))
+            .and(takesArguments(1).and(takesArgument(0, named("io.activej.http.HttpRequest")))),
+        this.getClass().getName() + "$ServeAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class ServeAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void methodEnter(
+        @Advice.This AsyncServlet asyncServlet,
+        @Advice.Argument(0) HttpRequest request,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope,
+        @Advice.Local("httpRequest") HttpRequest httpRequest) {
+      Context parentContext = currentContext();
+      httpRequest = request;
+      if (!instrumenter().shouldStart(parentContext, request)) {
+        return;
+      }
+      context = instrumenter().start(parentContext, request);
+      scope = context.makeCurrent();
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void methodExit(
+        @Advice.This AsyncServlet asyncServlet,
+        @Advice.Return(readOnly = false) Promise<HttpResponse> responsePromise,
+        @Advice.Thrown Throwable throwable,
+        @Advice.Local("otelContext") Context context,
+        @Advice.Local("otelScope") Scope scope,
+        @Advice.Local("httpRequest") HttpRequest httpRequest) {
+      if (scope == null) {
+        return;
+      }
+      scope.close();
+      if (throwable != null) {
+        instrumenter().end(context, httpRequest, null, throwable);
+      } else {
+        responsePromise = PromiseWrapper.wrap(responsePromise, httpRequest, context);
+      }
+    }
+  }
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/ActivejHttpServerConnectionInstrumentationModule.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+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;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class ActivejHttpServerConnectionInstrumentationModule extends InstrumentationModule {
+
+  public ActivejHttpServerConnectionInstrumentationModule() {
+    super("activej-http", "activej-http-6.0");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new ActivejHttpServerConnectionInstrumentation());
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    // class which was added in 6.0, the minimum version we support.
+    return hasClassesNamed("io.activej.http.HttpServer");
+  }
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/ActivejHttpServerConnectionSingletons.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import io.activej.http.HttpRequest;
+import io.activej.http.HttpResponse;
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+import io.opentelemetry.javaagent.bootstrap.internal.JavaagentHttpServerInstrumenters;
+
+public final class ActivejHttpServerConnectionSingletons {
+
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.activej-http-6.0";
+
+  private static final Instrumenter<HttpRequest, HttpResponse> INSTRUMENTER;
+
+  static {
+    INSTRUMENTER =
+        JavaagentHttpServerInstrumenters.create(
+            INSTRUMENTATION_NAME,
+            new ActivejHttpServerHttpAttributesGetter(),
+            ActivejHttpServerRequestGetter.INSTANCE);
+  }
+
+  public static Instrumenter<HttpRequest, HttpResponse> instrumenter() {
+    return INSTRUMENTER;
+  }
+
+  private ActivejHttpServerConnectionSingletons() {}
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/ActivejHttpServerHttpAttributesGetter.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import io.activej.http.HttpHeader;
+import io.activej.http.HttpHeaderValue;
+import io.activej.http.HttpHeaders;
+import io.activej.http.HttpRequest;
+import io.activej.http.HttpResponse;
+import io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesGetter;
+import java.net.InetAddress;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nullable;
+
+final class ActivejHttpServerHttpAttributesGetter
+    implements HttpServerAttributesGetter<HttpRequest, HttpResponse> {
+
+  @Override
+  public String getHttpRequestMethod(HttpRequest request) {
+    return request.getMethod().name();
+  }
+
+  @Override
+  public List<String> getHttpRequestHeader(HttpRequest request, String name) {
+    HttpHeader httpHeader = HttpHeaders.of(name);
+    List<String> values = new ArrayList<>();
+    for (Map.Entry<HttpHeader, HttpHeaderValue> entry : request.getHeaders()) {
+      if (httpHeader.equals(entry.getKey())) {
+        values.add(entry.getValue().toString());
+      }
+    }
+
+    return values;
+  }
+
+  @Override
+  public Integer getHttpResponseStatusCode(
+      HttpRequest request, HttpResponse httpResponse, @Nullable Throwable error) {
+    return httpResponse.getCode();
+  }
+
+  @Override
+  public List<String> getHttpResponseHeader(
+      HttpRequest request, HttpResponse httpResponse, String name) {
+    HttpHeader httpHeader = HttpHeaders.of(name);
+    List<String> values = new ArrayList<>();
+    for (Map.Entry<HttpHeader, HttpHeaderValue> entry : httpResponse.getHeaders()) {
+      if (httpHeader.equals(entry.getKey())) {
+        values.add(entry.getValue().toString());
+      }
+    }
+
+    return values;
+  }
+
+  @Override
+  public String getUrlScheme(HttpRequest request) {
+    return request.getProtocol().lowercase();
+  }
+
+  @Override
+  public String getUrlPath(HttpRequest request) {
+    return request.getPath();
+  }
+
+  @Override
+  public String getUrlQuery(HttpRequest request) {
+    return request.getQuery();
+  }
+
+  @Override
+  public String getNetworkProtocolName(HttpRequest request, @Nullable HttpResponse httpResponse) {
+    return switch (request.getVersion()) {
+      case HTTP_0_9, HTTP_1_0, HTTP_1_1, HTTP_2_0 -> "http";
+      default -> null;
+    };
+  }
+
+  @Override
+  public String getNetworkProtocolVersion(
+      HttpRequest request, @Nullable HttpResponse httpResponse) {
+    return switch (request.getVersion()) {
+      case HTTP_0_9 -> "0.9";
+      case HTTP_1_0 -> "1.0";
+      case HTTP_1_1 -> "1.1";
+      case HTTP_2_0 -> "2";
+      default -> null;
+    };
+  }
+
+  @Nullable
+  @Override
+  public String getNetworkPeerAddress(HttpRequest request, @Nullable HttpResponse httpResponse) {
+    InetAddress remoteAddress = request.getConnection().getRemoteAddress();
+    return remoteAddress != null ? remoteAddress.getHostAddress() : null;
+  }
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/ActivejHttpServerRequestGetter.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import io.activej.http.HttpHeader;
+import io.activej.http.HttpHeaderValue;
+import io.activej.http.HttpHeaders;
+import io.activej.http.HttpRequest;
+import io.opentelemetry.context.propagation.internal.ExtendedTextMapGetter;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+enum ActivejHttpServerRequestGetter implements ExtendedTextMapGetter<HttpRequest> {
+  INSTANCE;
+
+  @Override
+  public Iterable<String> keys(HttpRequest httpRequest) {
+    return httpRequest.getHeaders().stream().map(h -> h.getKey().toString()).toList();
+  }
+
+  @Override
+  public String get(HttpRequest carrier, String key) {
+    if (carrier == null) {
+      return null;
+    }
+
+    return carrier.getHeader(HttpHeaders.of(key));
+  }
+
+  @Override
+  public Iterator<String> getAll(HttpRequest carrier, String key) {
+    if (carrier == null) {
+      return Collections.emptyIterator();
+    }
+
+    HttpHeader httpHeader = HttpHeaders.of(key);
+    List<String> values = new ArrayList<>();
+    for (Map.Entry<HttpHeader, HttpHeaderValue> entry : carrier.getHeaders()) {
+      if (httpHeader.equals(entry.getKey())) {
+        values.add(entry.getValue().toString());
+      }
+    }
+    return values.iterator();
+  }
+}

instrumentation/activej-http-6.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/activejhttp/PromiseWrapper.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.activejhttp;
+
+import static io.opentelemetry.javaagent.instrumentation.activejhttp.ActivejHttpServerConnectionSingletons.instrumenter;
+
+import io.activej.http.HttpRequest;
+import io.activej.http.HttpResponse;
+import io.activej.promise.Promise;
+import io.opentelemetry.context.Context;
+
+public final class PromiseWrapper {
+
+  public static Promise<HttpResponse> wrap(
+      Promise<HttpResponse> promise, HttpRequest httpRequest, Context context) {
+    return promise.whenComplete(
+        (httpResponse, exception) ->
+            instrumenter().end(context, httpRequest, httpResponse, exception));
+  }
+
+  private PromiseWrapper() {}
+}