Retrieve gRPC server.address/server.port from target

Author: trask

instrumentation/armeria/armeria-grpc-1.14/javaagent/build.gradle.kts

@@ -63,6 +63,20 @@ tasks.test {
   systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
 }
 
+tasks {
+  val testStableSemconv by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.semconv-stability.opt-in=rpc")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=rpc")
+  }
+
+  check {
+    dependsOn(testStableSemconv)
+  }
+}
+
 if (findProperty("denyUnsafe") as Boolean) {
   tasks.withType<Test>().configureEach {
     enabled = false

instrumentation/armeria/armeria-grpc-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/armeria/grpc/v1_14/ArmeriaGrpcClientBuilderInstrumentation.java

@@ -11,9 +11,13 @@
 
 import com.linecorp.armeria.client.grpc.GrpcClientBuilder;
 import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.internal.SemconvStability;
 import io.opentelemetry.instrumentation.grpc.v1_6.GrpcTelemetry;
+import io.opentelemetry.instrumentation.grpc.v1_6.internal.Internal;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import java.net.URI;
+import javax.annotation.Nullable;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;
@@ -36,8 +40,14 @@ public void transform(TypeTransformer transformer) {
   public static class BuildAdvice {
 
     @Advice.OnMethodEnter
-    public static void onEnter(@Advice.This GrpcClientBuilder builder) {
-      builder.intercept(GrpcTelemetry.create(GlobalOpenTelemetry.get()).createClientInterceptor());
+    public static void onEnter(
+        @Advice.This GrpcClientBuilder builder, @Advice.FieldValue("uri") @Nullable URI uri) {
+      String target = null;
+      if (SemconvStability.emitStableRpcSemconv() && uri != null) {
+        target = uri.getAuthority();
+      }
+      GrpcTelemetry telemetry = GrpcTelemetry.create(GlobalOpenTelemetry.get());
+      builder.intercept(Internal.createClientInterceptor(telemetry, target));
     }
   }
 }

instrumentation/grpc-1.6/javaagent/build.gradle.kts

@@ -31,7 +31,7 @@ dependencies {
 val collectMetadata = findProperty("collectMetadata")?.toString() ?: "false"
 
 tasks {
-  test {
+  withType<Test>().configureEach {
     systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
     // The agent context debug mechanism isn't compatible with the bridge approach which may add a
     // gRPC context to the root.
@@ -56,26 +56,20 @@ tasks {
     testClassesDirs = sourceSets.test.get().output.classesDirs
     classpath = sourceSets.test.get().runtimeClasspath
 
-    // replicated base config from standard test task
-    systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
-    jvmArgs("-Dotel.javaagent.experimental.thread-propagation-debugger.enabled=false")
-    jvmArgs("-Dotel.instrumentation.grpc.capture-metadata.client.request=some-client-key")
-    jvmArgs("-Dotel.instrumentation.grpc.capture-metadata.server.request=some-server-key")
-    jvmArgs("-Dotel.instrumentation.common.experimental.controller-telemetry.enabled=true")
-
-    // exclude our grpc library instrumentation, the ContextStorageOverride contained within it
-    // breaks the tests
-    classpath = classpath.filter {
-      !it.absolutePath.contains("opentelemetry-grpc-1.6")
-    }
-
-    systemProperty("collectMetadata", collectMetadata)
     systemProperty("metadataConfig", "otel.instrumentation.grpc.experimental-span-attributes=true")
     jvmArgs("-Dotel.instrumentation.grpc.experimental-span-attributes=true")
   }
 
+  val testStableSemconv by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.semconv-stability.opt-in=rpc")
+    systemProperty("metadataConfig", "otel.semconv-stability.opt-in=rpc")
+  }
+
   check {
-    dependsOn(testExperimental)
+    dependsOn(testExperimental, testStableSemconv)
   }
 }
 

instrumentation/grpc-1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/grpc/v1_6/GrpcClientBuilderBuildInstrumentation.java

@@ -14,6 +14,7 @@
 
 import io.grpc.ClientInterceptor;
 import io.grpc.ManagedChannelBuilder;
+import io.opentelemetry.instrumentation.api.internal.SemconvStability;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import java.util.List;
@@ -30,7 +31,8 @@ public ElementMatcher<ClassLoader> classLoaderOptimization() {
   @Override
   public ElementMatcher<TypeDescription> typeMatcher() {
     return extendsClass(named("io.grpc.ManagedChannelBuilder"))
-        .and(declaresField(named("interceptors")));
+        .and(declaresField(named("interceptors")))
+        .and(declaresField(named("target")));
   }
 
   @Override
@@ -46,9 +48,11 @@ public static class AddInterceptorAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static void addInterceptor(
         @Advice.This ManagedChannelBuilder<?> builder,
-        @Advice.FieldValue("interceptors") List<ClientInterceptor> interceptors) {
+        @Advice.FieldValue("interceptors") List<ClientInterceptor> interceptors,
+        @Advice.FieldValue("target") String target) {
       if (!Boolean.TRUE.equals(MANAGED_CHANNEL_BUILDER_INSTRUMENTED.get(builder))) {
-        interceptors.add(0, GrpcSingletons.CLIENT_INTERCEPTOR);
+        String effectiveTarget = SemconvStability.emitStableRpcSemconv() ? target : null;
+        interceptors.add(0, GrpcSingletons.createClientInterceptor(effectiveTarget));
         MANAGED_CHANNEL_BUILDER_INSTRUMENTED.set(builder, true);
       }
     }

instrumentation/grpc-1.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/grpc/v1_6/GrpcSingletons.java

@@ -18,8 +18,10 @@
 import io.opentelemetry.instrumentation.api.util.VirtualField;
 import io.opentelemetry.instrumentation.grpc.v1_6.GrpcTelemetry;
 import io.opentelemetry.instrumentation.grpc.v1_6.internal.ContextStorageBridge;
+import io.opentelemetry.instrumentation.grpc.v1_6.internal.Internal;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicReference;
+import javax.annotation.Nullable;
 
 // Holds singleton references.
 public final class GrpcSingletons {
@@ -31,7 +33,7 @@ public final class GrpcSingletons {
   public static final VirtualField<ServerBuilder<?>, Boolean> SERVER_BUILDER_INSTRUMENTED =
       VirtualField.find(ServerBuilder.class, Boolean.class);
 
-  public static final ClientInterceptor CLIENT_INTERCEPTOR;
+  private static final GrpcTelemetry TELEMETRY;
 
   public static final ServerInterceptor SERVER_INTERCEPTOR;
 
@@ -64,10 +66,14 @@ public final class GrpcSingletons {
             .setCapturedServerRequestMetadata(serverRequestMetadata)
             .build();
 
-    CLIENT_INTERCEPTOR = telemetry.createClientInterceptor();
+    TELEMETRY = telemetry;
     SERVER_INTERCEPTOR = telemetry.createServerInterceptor();
   }
 
+  public static ClientInterceptor createClientInterceptor(@Nullable String target) {
+    return Internal.createClientInterceptor(TELEMETRY, target);
+  }
+
   public static Context.Storage getStorage() {
     return STORAGE_REFERENCE.get();
   }

instrumentation/grpc-1.6/library/README.md

@@ -34,7 +34,7 @@ The instrumentation library provides the implementation of `ClientInterceptor` a
 // For client-side, attach the interceptor to your channel builder.
 void configureClientInterceptor(OpenTelemetry openTelemetry, NettyChannelBuilder nettyChannelBuilder) {
   GrpcTelemetry grpcTelemetry = GrpcTelemetry.create(openTelemetry);
-  nettyChannelBuilder.intercept(grpcTelemetry.createClientInterceptor());
+  grpcTelemetry.addClientInterceptor(nettyChannelBuilder);
 }
 
 // For server-side, attatch the interceptor to your service.

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcNetworkServerAttributesGetter.java

@@ -18,12 +18,12 @@ final class GrpcNetworkServerAttributesGetter
   @Nullable
   @Override
   public String getServerAddress(GrpcRequest grpcRequest) {
-    return grpcRequest.getLogicalHost();
+    return grpcRequest.getServerAddress();
   }
 
   @Override
   public Integer getServerPort(GrpcRequest grpcRequest) {
-    return grpcRequest.getLogicalPort();
+    return grpcRequest.getServerPort();
   }
 
   @Nullable

instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcRequest.java

@@ -7,6 +7,7 @@
 
 import io.grpc.Metadata;
 import io.grpc.MethodDescriptor;
+import io.opentelemetry.instrumentation.grpc.v1_6.internal.ParsedTarget;
 import java.net.SocketAddress;
 import javax.annotation.Nullable;
 
@@ -15,40 +16,65 @@ public final class GrpcRequest {
   private final MethodDescriptor<?, ?> method;
 
   @Nullable private volatile Metadata metadata;
-
-  @Nullable private volatile String logicalHost;
-  private volatile int logicalPort = -1;
+  @Nullable private final String serverAddress;
+  @Nullable private final Integer serverPort;
   @Nullable private volatile SocketAddress peerSocketAddress;
 
   private Long requestSize;
   private Long responseSize;
 
-  GrpcRequest(
+  /**
+   * Creates a client-side gRPC request.
+   *
+   * @param method the gRPC method descriptor
+   * @param authority the channel authority (host:port)
+   * @param parsedTarget the pre-parsed gRPC target (from {@link
+   *     io.opentelemetry.instrumentation.grpc.v1_6.internal.GrpcTargetParser#parse}), or {@code
+   *     null} if unavailable
+   */
+  public static GrpcRequest createClientRequest(
+      MethodDescriptor<?, ?> method,
+      @Nullable String authority,
+      @Nullable ParsedTarget parsedTarget) {
+    if (parsedTarget != null) {
+      return new GrpcRequest(method, null, null, parsedTarget.getAddress(), parsedTarget.getPort());
+    }
+    return new GrpcRequest(
+        method, null, null, hostFromAuthority(authority), portFromAuthority(authority));
+  }
+
+  /**
+   * Creates a server-side gRPC request.
+   *
+   * @param method the gRPC method descriptor
+   * @param metadata the request metadata
+   * @param peerSocketAddress the peer socket address
+   * @param authority the request authority
+   */
+  public static GrpcRequest createServerRequest(
       MethodDescriptor<?, ?> method,
       @Nullable Metadata metadata,
       @Nullable SocketAddress peerSocketAddress,
       @Nullable String authority) {
+    return new GrpcRequest(
+        method,
+        metadata,
+        peerSocketAddress,
+        hostFromAuthority(authority),
+        portFromAuthority(authority));
+  }
+
+  private GrpcRequest(
+      MethodDescriptor<?, ?> method,
+      @Nullable Metadata metadata,
+      @Nullable SocketAddress peerSocketAddress,
+      @Nullable String serverAddress,
+      @Nullable Integer serverPort) {
     this.method = method;
     this.metadata = metadata;
     this.peerSocketAddress = peerSocketAddress;
-    setLogicalAddress(authority);
-  }
-
-  private void setLogicalAddress(@Nullable String authority) {
-    if (authority == null) {
-      return;
-    }
-    int index = authority.indexOf(':');
-    if (index == -1) {
-      logicalHost = authority;
-    } else {
-      logicalHost = authority.substring(0, index);
-      try {
-        logicalPort = Integer.parseInt(authority.substring(index + 1));
-      } catch (NumberFormatException e) {
-        // ignore
-      }
-    }
+    this.serverAddress = serverAddress;
+    this.serverPort = serverPort;
   }
 
   public MethodDescriptor<?, ?> getMethod() {
@@ -64,13 +90,45 @@ void setMetadata(Metadata metadata) {
     this.metadata = metadata;
   }
 
+  /**
+   * Returns the server address.
+   *
+   * <p>When a target string is available (from gRPC channel configuration), the server address is
+   * extracted per the <a href="https://grpc.github.io/grpc/core/md_doc_naming.html">gRPC Name
+   * Resolution spec</a>. Otherwise, falls back to the authority (host portion).
+   */
+  @Nullable
+  public String getServerAddress() {
+    return serverAddress;
+  }
+
+  /**
+   * Returns the server port.
+   *
+   * <p>When a target string is available (from gRPC channel configuration), the server port is
+   * extracted per the <a href="https://grpc.github.io/grpc/core/md_doc_naming.html">gRPC Name
+   * Resolution spec</a>. Otherwise, falls back to the authority (port portion).
+   */
+  @Nullable
+  public Integer getServerPort() {
+    return serverPort;
+  }
+
+  /**
+   * @deprecated Use {@link #getServerAddress()} instead.
+   */
+  @Deprecated
   @Nullable
   public String getLogicalHost() {
-    return logicalHost;
+    return serverAddress;
   }
 
+  /**
+   * @deprecated Use {@link #getServerPort()} instead.
+   */
+  @Deprecated
   public int getLogicalPort() {
-    return logicalPort;
+    return serverPort != null ? serverPort : -1;
   }
 
   @Nullable
@@ -97,4 +155,32 @@ public Long getResponseSize() {
   public void setResponseSize(Long responseSize) {
     this.responseSize = responseSize;
   }
+
+  @Nullable
+  private static String hostFromAuthority(@Nullable String authority) {
+    if (authority == null) {
+      return null;
+    }
+    int index = authority.indexOf(':');
+    if (index == -1) {
+      return authority;
+    }
+    return authority.substring(0, index);
+  }
+
+  @Nullable
+  private static Integer portFromAuthority(@Nullable String authority) {
+    if (authority == null) {
+      return null;
+    }
+    int index = authority.indexOf(':');
+    if (index == -1) {
+      return null;
+    }
+    try {
+      return Integer.parseInt(authority.substring(index + 1));
+    } catch (NumberFormatException e) {
+      return null;
+    }
+  }
 }