Add instrumentation for Armeria WebClient. (#920)

* Add instrumentation for Armeria WebClient.

* Format:

* httpurlconnection

* Docs and consistency:

Author: Anuraag Agrawal

instrumentation/armeria-1.0/auto/src/main/java/io/opentelemetry/auto/instrumentation/armeria/v1_0/AbstractArmeriaInstrumentation.java

@@ -29,12 +29,18 @@ public AbstractArmeriaInstrumentation() {
   @Override
   public String[] helperClassNames() {
     return new String[] {
-      "io.opentelemetry.instrumentation.armeria.v1_0.internal.ContextUtil",
+      "io.opentelemetry.auto.instrumentation.armeria.v1_0.ArmeriaDecorators",
+      "io.opentelemetry.instrumentation.armeria.v1_0.client.ArmeriaClientTracer",
+      "io.opentelemetry.instrumentation.armeria.v1_0.client.ArmeriaClientTracer$ArmeriaSetter",
+      "io.opentelemetry.instrumentation.armeria.v1_0.client.OpenTelemetryClient",
+      "io.opentelemetry.instrumentation.armeria.v1_0.client.OpenTelemetryClient$Decorator",
+      // Corresponds to lambda when calling .thenAccept(log -> ...
+      "io.opentelemetry.instrumentation.armeria.v1_0.client.OpenTelemetryClient$1",
       "io.opentelemetry.instrumentation.armeria.v1_0.server.ArmeriaServerTracer",
       "io.opentelemetry.instrumentation.armeria.v1_0.server.ArmeriaServerTracer$ArmeriaGetter",
       "io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService",
       "io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService$Decorator",
-      // .thenAccept(log -> lambda
+      // Corresponds to lambda when calling .thenAccept(log -> ...
       "io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService$1",
     };
   }

instrumentation/armeria-1.0/auto/src/main/java/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaDecorators.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.auto.instrumentation.armeria.v1_0;
+
+import com.linecorp.armeria.client.HttpClient;
+import com.linecorp.armeria.server.HttpService;
+import io.opentelemetry.instrumentation.armeria.v1_0.client.OpenTelemetryClient;
+import io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService;
+import java.util.function.Function;
+
+// Holds singleton references to decorators to match against during suppression.
+// https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/903
+public final class ArmeriaDecorators {
+
+  public static final Function<? super HttpClient, ? extends HttpClient> CLIENT_DECORATOR =
+      OpenTelemetryClient.newDecorator();
+
+  public static final Function<? super HttpService, ? extends HttpService> SERVER_DECORATOR =
+      OpenTelemetryService.newDecorator();
+}

instrumentation/armeria-1.0/auto/src/main/java/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaServerBuilderInstrumentation.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.auto.instrumentation.armeria.v1_0;
+
+import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isPublic;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import com.google.auto.service.AutoService;
+import com.linecorp.armeria.server.ServerBuilder;
+import io.opentelemetry.auto.tooling.Instrumenter;
+import io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.method.MethodDescription;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(Instrumenter.class)
+public class ArmeriaServerBuilderInstrumentation extends AbstractArmeriaInstrumentation {
+
+  @Override
+  public ElementMatcher<? super TypeDescription> typeMatcher() {
+    return named("com.linecorp.armeria.server.ServerBuilder");
+  }
+
+  @Override
+  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
+    Map<ElementMatcher<MethodDescription>, String> transformers = new HashMap<>();
+    transformers.put(
+        isConstructor(),
+        ArmeriaServerBuilderInstrumentation.class.getName() + "$ConstructorAdvice");
+    transformers.put(
+        isMethod().and(isPublic()).and(named("decorator").and(takesArgument(0, Function.class))),
+        ArmeriaServerBuilderInstrumentation.class.getName() + "$SuppressDecoratorAdvice");
+    return transformers;
+  }
+
+  public static class ConstructorAdvice {
+    @Advice.OnMethodExit
+    public static void construct(@Advice.This ServerBuilder builder) {
+      builder.decorator(OpenTelemetryService.newDecorator());
+    }
+  }
+
+  // Intercept calls from app to register decorator and suppress them to avoid registering
+  // multiple decorators, one from user app and one from our auto instrumentation. Otherwise, we
+  // will end up with double telemetry.
+  // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/903
+  public static class SuppressDecoratorAdvice {
+    @Advice.OnMethodEnter(skipOn = Advice.OnNonDefaultValue.class, inline = false)
+    public static boolean suppressDecorator(@Advice.Argument(0) Function<?, ?> decorator) {
+      return decorator != ArmeriaDecorators.SERVER_DECORATOR;
+    }
+
+    @Advice.OnMethodExit
+    public static void handleSuppression(
+        @Advice.This ServerBuilder builder,
+        @Advice.Enter boolean suppressed,
+        @Advice.Return(readOnly = false) ServerBuilder returned) {
+      if (suppressed) {
+        returned = builder;
+      }
+    }
+  }
+}

instrumentation/armeria-1.0/auto/src/main/java/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaServerInstrumentation.java

@@ -24,7 +24,6 @@
 import com.google.auto.service.AutoService;
 import com.linecorp.armeria.server.ServerBuilder;
 import io.opentelemetry.auto.tooling.Instrumenter;
-import io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService;
 import java.util.Collections;
 import java.util.Map;
 import net.bytebuddy.asm.Advice;
@@ -49,7 +48,7 @@ public Map<? extends ElementMatcher<? super MethodDescription>, String> transfor
   public static class AddDecoratorAdvice {
     @Advice.OnMethodExit
     public static void addDecorator(@Advice.Return ServerBuilder sb) {
-      sb.decorator(OpenTelemetryService.newDecorator());
+      sb.decorator(ArmeriaDecorators.SERVER_DECORATOR);
     }
   }
 }

instrumentation/armeria-1.0/auto/src/main/java/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaWebClientBuilderInstrumentation.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.auto.instrumentation.armeria.v1_0;
+
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.isPublic;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import com.google.auto.service.AutoService;
+import com.linecorp.armeria.client.WebClientBuilder;
+import io.opentelemetry.auto.tooling.Instrumenter;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.Function;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.method.MethodDescription;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(Instrumenter.class)
+public class ArmeriaWebClientBuilderInstrumentation extends AbstractArmeriaInstrumentation {
+
+  @Override
+  public ElementMatcher<? super TypeDescription> typeMatcher() {
+    return named("com.linecorp.armeria.client.WebClientBuilder");
+  }
+
+  @Override
+  public Map<? extends ElementMatcher<? super MethodDescription>, String> transformers() {
+    Map<ElementMatcher<MethodDescription>, String> transformers = new HashMap<>();
+    transformers.put(
+        isMethod().and(isPublic()).and(named("decorator").and(takesArgument(0, Function.class))),
+        ArmeriaWebClientBuilderInstrumentation.class.getName() + "$SuppressDecoratorAdvice");
+    transformers.put(
+        isMethod().and(isPublic()).and(named("build")),
+        ArmeriaWebClientBuilderInstrumentation.class.getName() + "$BuildAdvice");
+    return transformers;
+  }
+
+  // Intercept calls from app to register decorator and suppress them to avoid registering
+  // multiple decorators, one from user app and one from our auto instrumentation. Otherwise, we
+  // will end up with double telemetry.
+  // https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/903
+  public static class SuppressDecoratorAdvice {
+    @Advice.OnMethodEnter(skipOn = Advice.OnNonDefaultValue.class)
+    public static boolean suppressDecorator(@Advice.Argument(0) Function<?, ?> decorator) {
+      return decorator != ArmeriaDecorators.CLIENT_DECORATOR;
+    }
+
+    @Advice.OnMethodExit
+    public static void handleSuppression(
+        @Advice.This WebClientBuilder builder,
+        @Advice.Enter boolean suppressed,
+        @Advice.Return(readOnly = false) WebClientBuilder returned) {
+      if (suppressed) {
+        returned = builder;
+      }
+    }
+  }
+
+  public static class BuildAdvice {
+    @Advice.OnMethodEnter
+    public static void build(@Advice.This WebClientBuilder builder) {
+      builder.decorator(ArmeriaDecorators.CLIENT_DECORATOR);
+    }
+  }
+}

instrumentation/armeria-1.0/auto/src/test/groovy/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaNoDuplicateInstrumentationTest.groovy

@@ -0,0 +1,44 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.auto.instrumentation.armeria.v1_0
+
+import com.linecorp.armeria.client.WebClientBuilder
+import com.linecorp.armeria.server.ServerBuilder
+import io.opentelemetry.auto.test.AgentTestTrait
+import io.opentelemetry.instrumentation.armeria.v1_0.AbstractArmeriaTest
+import io.opentelemetry.instrumentation.armeria.v1_0.client.OpenTelemetryClient
+import io.opentelemetry.instrumentation.armeria.v1_0.server.OpenTelemetryService
+
+class ArmeriaNoDuplicateInstrumentationTest extends AbstractArmeriaTest implements AgentTestTrait {
+  @Override
+  ServerBuilder configureServer(ServerBuilder sb) {
+    return sb.decorator(OpenTelemetryService.newDecorator())
+  }
+
+  @Override
+  WebClientBuilder configureClient(WebClientBuilder clientBuilder) {
+    return clientBuilder.decorator(OpenTelemetryClient.newDecorator())
+  }
+
+  def childSetupSpec() {
+    server.before()
+  }
+
+  def childCleanupSpec() {
+    server.after()
+  }
+}

instrumentation/armeria-1.0/auto/src/test/groovy/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaServerTest.groovy renamed to instrumentation/armeria-1.0/auto/src/test/groovy/io/opentelemetry/auto/instrumentation/armeria/v1_0/ArmeriaTest.groovy

@@ -16,13 +16,21 @@
 
 package io.opentelemetry.auto.instrumentation.armeria.v1_0
 
+import com.linecorp.armeria.client.WebClientBuilder
 import com.linecorp.armeria.server.ServerBuilder
 import io.opentelemetry.auto.test.AgentTestTrait
-import io.opentelemetry.instrumentation.armeria.v1_0.AbstractArmeriaServerTest
+import io.opentelemetry.instrumentation.armeria.v1_0.AbstractArmeriaTest
 
-class ArmeriaServerTest extends AbstractArmeriaServerTest implements AgentTestTrait {
+class ArmeriaTest extends AbstractArmeriaTest implements AgentTestTrait {
   @Override
-  void configureServer(ServerBuilder sb) {}
+  ServerBuilder configureServer(ServerBuilder sb) {
+    return sb
+  }
+
+  @Override
+  WebClientBuilder configureClient(WebClientBuilder clientBuilder) {
+    return clientBuilder
+  }
 
   def childSetupSpec() {
     server.before()

instrumentation/armeria-1.0/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_0/client/ArmeriaClientTracer.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.opentelemetry.instrumentation.armeria.v1_0.client;
+
+import com.linecorp.armeria.client.ClientRequestContext;
+import com.linecorp.armeria.common.logging.RequestLog;
+import io.opentelemetry.context.propagation.HttpTextFormat.Setter;
+import io.opentelemetry.instrumentation.api.decorator.HttpClientTracer;
+import io.opentelemetry.trace.Tracer;
+import java.net.URI;
+import java.net.URISyntaxException;
+
+public class ArmeriaClientTracer extends HttpClientTracer<ClientRequestContext, RequestLog> {
+
+  ArmeriaClientTracer() {}
+
+  ArmeriaClientTracer(Tracer tracer) {
+    super(tracer);
+  }
+
+  @Override
+  protected String method(ClientRequestContext ctx) {
+    return ctx.method().name();
+  }
+
+  @Override
+  protected URI url(ClientRequestContext ctx) throws URISyntaxException {
+    return ctx.request().uri();
+  }
+
+  @Override
+  protected Integer status(RequestLog log) {
+    return log.responseHeaders().status().code();
+  }
+
+  @Override
+  protected String requestHeader(ClientRequestContext ctx, String name) {
+    return ctx.request().headers().get(name);
+  }
+
+  @Override
+  protected String responseHeader(RequestLog log, String name) {
+    return log.responseHeaders().get(name);
+  }
+
+  @Override
+  protected Setter<ClientRequestContext> getSetter() {
+    return ArmeriaSetter.INSTANCE;
+  }
+
+  @Override
+  protected String getInstrumentationName() {
+    return "io.opentelemetry.armeria-1.0";
+  }
+
+  private static class ArmeriaSetter implements Setter<ClientRequestContext> {
+
+    private static final ArmeriaSetter INSTANCE = new ArmeriaSetter();
+
+    @Override
+    public void set(ClientRequestContext ctx, String key, String value) {
+      ctx.addAdditionalRequestHeader(key, value);
+    }
+  }
+}