Capture gRPC UNKNOWN requests

Author: trask

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcAttributesGetter.java

@@ -51,6 +51,17 @@ default String getRpcMethod(REQUEST request) {
     return null;
   }
 
+  /**
+   * Returns the original method name when the method reported via {@link #getRpcMethod(REQUEST)} is
+   * {@code _OTHER}. This is used to populate the {@code rpc.method_original} attribute.
+   *
+   * @return the original method name, or null if the method was not replaced with {@code _OTHER}
+   */
+  @Nullable
+  default String getRpcMethodOriginal(REQUEST request) {
+    return null;
+  }
+
   /**
    * Returns a description of a class of error the operation ended with.
    *

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/rpc/RpcCommonAttributesExtractor.java

@@ -16,6 +16,8 @@ abstract class RpcCommonAttributesExtractor<REQUEST, RESPONSE>
 
   // copied from RpcIncubatingAttributes
   static final AttributeKey<String> RPC_METHOD = AttributeKey.stringKey("rpc.method");
+  static final AttributeKey<String> RPC_METHOD_ORIGINAL =
+      AttributeKey.stringKey("rpc.method_original");
   static final AttributeKey<String> RPC_SERVICE = AttributeKey.stringKey("rpc.service");
   static final AttributeKey<String> RPC_SYSTEM = AttributeKey.stringKey("rpc.system");
 
@@ -31,6 +33,7 @@ public final void onStart(AttributesBuilder attributes, Context parentContext, R
     attributes.put(RPC_SYSTEM, getter.getSystem(request));
     attributes.put(RPC_SERVICE, getter.getService(request));
     attributes.put(RPC_METHOD, getter.getMethod(request));
+    attributes.put(RPC_METHOD_ORIGINAL, getter.getRpcMethodOriginal(request));
   }
 
   @Override

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

@@ -50,7 +50,7 @@ public static CallDepth onEnter(@Advice.This ServerBuilder<?> serverBuilder) {
         return callDepth;
       }
       if (!Boolean.TRUE.equals(SERVER_BUILDER_INSTRUMENTED.get(serverBuilder))) {
-        serverBuilder.intercept(GrpcSingletons.SERVER_INTERCEPTOR);
+        GrpcSingletons.configureServerBuilder(serverBuilder);
         SERVER_BUILDER_INSTRUMENTED.set(serverBuilder, true);
       }
       return callDepth;

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

@@ -11,7 +11,6 @@
 import io.grpc.Context;
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.ServerBuilder;
-import io.grpc.ServerInterceptor;
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties;
 import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil;
@@ -33,7 +32,7 @@ public final class GrpcSingletons {
 
   public static final ClientInterceptor CLIENT_INTERCEPTOR;
 
-  public static final ServerInterceptor SERVER_INTERCEPTOR;
+  private static final GrpcTelemetry GRPC_TELEMETRY;
 
   private static final AtomicReference<Context.Storage> STORAGE_REFERENCE = new AtomicReference<>();
 
@@ -56,16 +55,15 @@ public final class GrpcSingletons {
             .get("server")
             .getScalarList("request", String.class, emptyList());
 
-    GrpcTelemetry telemetry =
+    GRPC_TELEMETRY =
         GrpcTelemetry.builder(GlobalOpenTelemetry.get())
             .setEmitMessageEvents(emitMessageEvents)
             .setCaptureExperimentalSpanAttributes(experimentalSpanAttributes)
             .setCapturedClientRequestMetadata(clientRequestMetadata)
             .setCapturedServerRequestMetadata(serverRequestMetadata)
             .build();
 
-    CLIENT_INTERCEPTOR = telemetry.createClientInterceptor();
-    SERVER_INTERCEPTOR = telemetry.createServerInterceptor();
+    CLIENT_INTERCEPTOR = GRPC_TELEMETRY.createClientInterceptor();
   }
 
   public static Context.Storage getStorage() {
@@ -77,5 +75,9 @@ public static Context.Storage setStorage(Context.Storage storage) {
     return getStorage();
   }
 
+  public static void configureServerBuilder(ServerBuilder<?> serverBuilder) {
+    GRPC_TELEMETRY.configureServerBuilder(serverBuilder);
+  }
+
   private GrpcSingletons() {}
 }

instrumentation/grpc-1.6/library/README.md

@@ -37,9 +37,9 @@ void configureClientInterceptor(OpenTelemetry openTelemetry, NettyChannelBuilder
   nettyChannelBuilder.intercept(grpcTelemetry.createClientInterceptor());
 }
 
-// For server-side, attatch the interceptor to your service.
-ServerServiceDefinition configureServerInterceptor(OpenTelemetry openTelemetry, ServerServiceDefinition serviceDefinition) {
+// For server-side, configure the server builder.
+void configureServer(OpenTelemetry openTelemetry, ServerBuilder<?> serverBuilder) {
   GrpcTelemetry grpcTelemetry = GrpcTelemetry.create(openTelemetry);
-  return ServerInterceptors.intercept(serviceDefinition, grpcTelemetry.createServerInterceptor());
+  grpcTelemetry.configureServerBuilder(serverBuilder);
 }
 ```

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

@@ -33,7 +33,7 @@ final class GrpcAttributesExtractor implements AttributesExtractor<GrpcRequest,
 
   @Override
   public void onStart(AttributesBuilder attributes, Context parentContext, GrpcRequest request) {
-    // Request attributes captured on request end.
+    // Attributes captured on request end.
   }
 
   @Override

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

@@ -12,7 +12,9 @@
 
 public final class GrpcRequest {
 
-  private final MethodDescriptor<?, ?> method;
+  @Nullable private volatile MethodDescriptor<?, ?> method;
+  private final String fullMethodName;
+  @Nullable private final String originalFullMethodName;
 
   @Nullable private volatile Metadata metadata;
 
@@ -29,11 +31,19 @@ public final class GrpcRequest {
       @Nullable SocketAddress peerSocketAddress,
       @Nullable String authority) {
     this.method = method;
+    this.fullMethodName = method.getFullMethodName();
+    this.originalFullMethodName = null;
     this.metadata = metadata;
     this.peerSocketAddress = peerSocketAddress;
     setLogicalAddress(authority);
   }
 
+  GrpcRequest(String fullMethodName, @Nullable String originalFullMethodName, Metadata metadata) {
+    this.fullMethodName = fullMethodName;
+    this.originalFullMethodName = originalFullMethodName;
+    this.metadata = metadata;
+  }
+
   private void setLogicalAddress(@Nullable String authority) {
     if (authority == null) {
       return;
@@ -51,10 +61,20 @@ private void setLogicalAddress(@Nullable String authority) {
     }
   }
 
+  @Nullable
   public MethodDescriptor<?, ?> getMethod() {
     return method;
   }
 
+  String getFullMethodName() {
+    return fullMethodName;
+  }
+
+  @Nullable
+  String getOriginalFullMethodName() {
+    return originalFullMethodName;
+  }
+
   @Nullable
   public Metadata getMetadata() {
     return metadata;

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

@@ -26,7 +26,7 @@ public String getSystem(GrpcRequest request) {
   @Override
   @Nullable
   public String getService(GrpcRequest request) {
-    String fullMethodName = request.getMethod().getFullMethodName();
+    String fullMethodName = request.getFullMethodName();
     int slashIndex = fullMethodName.lastIndexOf('/');
     if (slashIndex == -1) {
       return null;
@@ -38,10 +38,10 @@ public String getService(GrpcRequest request) {
   @Override
   @Nullable
   public String getMethod(GrpcRequest request) {
-    String fullMethodName = request.getMethod().getFullMethodName();
+    String fullMethodName = request.getFullMethodName();
     int slashIndex = fullMethodName.lastIndexOf('/');
     if (slashIndex == -1) {
-      return null;
+      return fullMethodName;
     }
     return fullMethodName.substring(slashIndex + 1);
   }
@@ -58,6 +58,12 @@ public Long getResponseSize(GrpcRequest request) {
     return request.getResponseSize();
   }
 
+  @Override
+  @Nullable
+  public String getRpcMethodOriginal(GrpcRequest request) {
+    return request.getOriginalFullMethodName();
+  }
+
   List<String> metadataValue(GrpcRequest request, String key) {
     if (request.getMetadata() == null) {
       return emptyList();

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

@@ -11,6 +11,6 @@
 final class GrpcSpanNameExtractor implements SpanNameExtractor<GrpcRequest> {
   @Override
   public String extract(GrpcRequest request) {
-    return request.getMethod().getFullMethodName();
+    return request.getFullMethodName();
   }
 }

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

@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.grpc.v1_6;
 
 import io.grpc.ClientInterceptor;
+import io.grpc.ServerBuilder;
 import io.grpc.ServerInterceptor;
 import io.grpc.Status;
 import io.opentelemetry.api.OpenTelemetry;
@@ -53,10 +54,25 @@ public ClientInterceptor createClientInterceptor() {
         clientInstrumenter, propagators, captureExperimentalSpanAttributes, emitMessageEvents);
   }
 
+  /**
+   * Configures a {@link ServerBuilder} with both the server interceptor and the stream tracer
+   * factory. The interceptor handles registered service methods, while the stream tracer factory
+   * creates spans for requests to unregistered services that are not seen by server interceptors.
+   */
+  public void configureServerBuilder(ServerBuilder<?> serverBuilder) {
+    serverBuilder.intercept(createServerInterceptor());
+    serverBuilder.addStreamTracerFactory(
+        new TracingServerStreamTracerFactory(serverInstrumenter, propagators));
+  }
+
   /**
    * Returns a new {@link ServerInterceptor} for use with methods like {@link
    * io.grpc.ServerBuilder#intercept(ServerInterceptor)}.
+   *
+   * @deprecated Use {@link #configureServerBuilder(ServerBuilder)} instead, which also registers
+   *     the stream tracer factory needed to capture requests to unregistered services.
    */
+  @Deprecated
   public ServerInterceptor createServerInterceptor() {
     return new TracingServerInterceptor(
         serverInstrumenter, captureExperimentalSpanAttributes, emitMessageEvents);