interop: enable OpenTelemetry tracing support in Java interop client and server

Author: AgraVator

gradle/libs.versions.toml

@@ -122,6 +122,7 @@ opencensus-impl = { module = "io.opencensus:opencensus-impl", version.ref = "ope
 opentelemetry-api = "io.opentelemetry:opentelemetry-api:1.63.0"
 opentelemetry-exporter-prometheus = "io.opentelemetry:opentelemetry-exporter-prometheus:1.63.0-alpha"
 opentelemetry-gcp-resources = "io.opentelemetry.contrib:opentelemetry-gcp-resources:1.57.0-alpha"
+opentelemetry-exporter-otlp = "io.opentelemetry:opentelemetry-exporter-otlp:1.63.0"
 opentelemetry-sdk-extension-autoconfigure = "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure:1.63.0"
 opentelemetry-sdk-testing = "io.opentelemetry:opentelemetry-sdk-testing:1.63.0"
 perfmark-api = "io.perfmark:perfmark-api:0.27.0"

interop-testing/build.gradle

@@ -26,6 +26,7 @@ dependencies {
             libraries.opencensus.contrib.grpc.metrics,
             libraries.google.auth.oauth2Http,
             libraries.opentelemetry.sdk.extension.autoconfigure,
+            libraries.opentelemetry.exporter.otlp,
             libraries.guava.jre // Fix checkUpperBoundDeps using -android
     api project(':grpc-api'),
             project(':grpc-stub'),

interop-testing/src/main/java/io/grpc/testing/integration/TestServiceClient.java

@@ -54,6 +54,12 @@
 import io.grpc.internal.JsonParser;
 import io.grpc.netty.InsecureFromHttp1ChannelCredentials;
 import io.grpc.netty.InternalNettyChannelBuilder;
+import io.grpc.opentelemetry.GrpcOpenTelemetry;
+import io.grpc.opentelemetry.GrpcTraceBinContextPropagator;
+import io.grpc.opentelemetry.InternalGrpcOpenTelemetry;
+import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import io.grpc.netty.NettyChannelBuilder;
 import io.grpc.okhttp.InternalOkHttpChannelBuilder;
 import io.grpc.okhttp.OkHttpChannelBuilder;
@@ -118,6 +124,8 @@ public static void main(String[] args) throws Exception {
   private boolean useTls = true;
   private boolean useAlts = false;
   private boolean useH2cUpgrade = false;
+  private boolean enableOpentelemetry = false;
+  private OpenTelemetrySdk openTelemetrySdk;
   private String customCredentialsType;
   private boolean useTestCa;
   private boolean useOkHttp;
@@ -219,6 +227,8 @@ void parseArgs(String[] args) throws Exception {
         numThreads = Integer.parseInt(value);
       } else if ("additional_metadata".equals(key)) {
         additionalMetadata = value;
+      } else if ("enable_opentelemetry".equals(key)) {
+        enableOpentelemetry = Boolean.parseBoolean(value);
       } else {
         System.err.println("Unknown argument: " + key);
         usage = true;
@@ -307,20 +317,34 @@ void parseArgs(String[] args) throws Exception {
 
   @VisibleForTesting
   void setUp() {
+    if (enableOpentelemetry) {
+      AutoConfiguredOpenTelemetrySdk autoSdk = AutoConfiguredOpenTelemetrySdk.builder()
+          .addPropagatorCustomizer(
+              (previous, config) ->
+                  TextMapPropagator.composite(
+                      previous, GrpcTraceBinContextPropagator.defaultInstance()))
+          .build();
+      this.openTelemetrySdk = autoSdk.getOpenTelemetrySdk();
+      GrpcOpenTelemetry.Builder grpcOpentelemetryBuilder = GrpcOpenTelemetry.newBuilder()
+          .sdk(openTelemetrySdk);
+      InternalGrpcOpenTelemetry.enableTracing(grpcOpentelemetryBuilder, true);
+      GrpcOpenTelemetry grpcOpenTelemetry = grpcOpentelemetryBuilder.build();
+      grpcOpenTelemetry.registerGlobal();
+    }
     tester.setUp();
   }
 
   private synchronized void tearDown() {
     try {
       tester.tearDown();
+    } finally {
       if (customBackendMetricsLoadBalancerProvider != null) {
         LoadBalancerRegistry.getDefaultRegistry()
             .deregister(customBackendMetricsLoadBalancerProvider);
       }
-    } catch (RuntimeException ex) {
-      throw ex;
-    } catch (Exception ex) {
-      throw new RuntimeException(ex);
+      if (openTelemetrySdk != null) {
+        openTelemetrySdk.close();
+      }
     }
   }
 

interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java

@@ -28,10 +28,16 @@
 import io.grpc.TlsServerCredentials;
 import io.grpc.alts.AltsServerCredentials;
 import io.grpc.netty.NettyServerBuilder;
+import io.grpc.opentelemetry.GrpcOpenTelemetry;
+import io.grpc.opentelemetry.GrpcTraceBinContextPropagator;
+import io.grpc.opentelemetry.InternalGrpcOpenTelemetry;
 import io.grpc.services.MetricRecorder;
 import io.grpc.testing.TlsTesting;
 import io.grpc.xds.orca.OrcaMetricReportingServerInterceptor;
 import io.grpc.xds.orca.OrcaServiceImpl;
+import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
 import java.util.List;
@@ -76,6 +82,8 @@ public void run() {
   private boolean useTls = true;
   private boolean useAlts = false;
   private int mcsLimit = -1;
+  private boolean enableOpentelemetry = false;
+  private OpenTelemetrySdk openTelemetrySdk;
 
   private ScheduledExecutorService executor;
   private Server server;
@@ -123,6 +131,8 @@ void parseArgs(String[] args) {
         mcsLimit = Integer.parseInt(value);
         // TODO: Make Netty server builder usable for IPV6 as well (not limited to MCS handling)
         addressType = Util.AddressType.IPV4; // To use NettyServerBuilder
+      } else if ("enable_opentelemetry".equals(key)) {
+        enableOpentelemetry = Boolean.parseBoolean(value);
       } else {
         System.err.println("Unknown argument: " + key);
         usage = true;
@@ -156,6 +166,20 @@ void parseArgs(String[] args) {
   @SuppressWarnings("AddressSelection")
   @VisibleForTesting
   void start() throws Exception {
+    if (enableOpentelemetry) {
+      AutoConfiguredOpenTelemetrySdk autoSdk = AutoConfiguredOpenTelemetrySdk.builder()
+          .addPropagatorCustomizer(
+              (previous, config) ->
+                  TextMapPropagator.composite(
+                      previous, GrpcTraceBinContextPropagator.defaultInstance()))
+          .build();
+      this.openTelemetrySdk = autoSdk.getOpenTelemetrySdk();
+      GrpcOpenTelemetry.Builder grpcOpentelemetryBuilder = GrpcOpenTelemetry.newBuilder()
+          .sdk(openTelemetrySdk);
+      InternalGrpcOpenTelemetry.enableTracing(grpcOpentelemetryBuilder, true);
+      GrpcOpenTelemetry grpcOpenTelemetry = grpcOpentelemetryBuilder.build();
+      grpcOpenTelemetry.registerGlobal();
+    }
     executor = Executors.newSingleThreadScheduledExecutor();
     ServerCredentials serverCreds;
     if (useAlts) {
@@ -224,11 +248,17 @@ void start() throws Exception {
 
   @VisibleForTesting
   void stop() throws Exception {
-    server.shutdownNow();
-    if (!server.awaitTermination(5, TimeUnit.SECONDS)) {
-      System.err.println("Timed out waiting for server shutdown");
+    try {
+      server.shutdownNow();
+      if (!server.awaitTermination(5, TimeUnit.SECONDS)) {
+        System.err.println("Timed out waiting for server shutdown");
+      }
+      MoreExecutors.shutdownAndAwaitTermination(executor, 5, TimeUnit.SECONDS);
+    } finally {
+      if (openTelemetrySdk != null) {
+        openTelemetrySdk.close();
+      }
     }
-    MoreExecutors.shutdownAndAwaitTermination(executor, 5, TimeUnit.SECONDS);
   }
 
   @VisibleForTesting