test: verify destinationResourceId tracing in showcase tests

Author: blakeli0

java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITOtelTracing.java

@@ -45,6 +45,8 @@
 import com.google.showcase.v1beta1.EchoClient;
 import com.google.showcase.v1beta1.EchoRequest;
 import com.google.showcase.v1beta1.EchoSettings;
+import com.google.showcase.v1beta1.GetUserRequest;
+import com.google.showcase.v1beta1.IdentityClient;
 import com.google.showcase.v1beta1.it.util.TestClientInitializer;
 import com.google.showcase.v1beta1.stub.EchoStub;
 import com.google.showcase.v1beta1.stub.EchoStubSettings;
@@ -92,20 +94,24 @@ void tearDown() {
   }
 
   @Test
-  void testTracing_successfulEcho_grpc() throws Exception {
+  void testTracing_successfulIdentityGetUser_grpc() throws Exception {
     SpanTracerFactory tracingFactory = new SpanTracerFactory(openTelemetrySdk);
 
-    try (EchoClient client =
-        TestClientInitializer.createGrpcEchoClientOpentelemetry(tracingFactory)) {
+    try (IdentityClient client =
+        TestClientInitializer.createGrpcIdentityClientOpentelemetry(tracingFactory)) {
 
-      client.echo(EchoRequest.newBuilder().setContent("tracing-test").build());
+      try {
+        client.getUser(GetUserRequest.newBuilder().setName("users/test-user").build());
+      } catch (Exception e) {
+        // Ignored, the showcase server may not have this user, but trace is still generated.
+      }
 
       List<SpanData> spans = spanExporter.getFinishedSpanItems();
       assertThat(spans).isNotEmpty();
 
       SpanData attemptSpan =
           spans.stream()
-              .filter(span -> span.getName().equals("google.showcase.v1beta1.Echo/Echo"))
+              .filter(span -> span.getName().equals("google.showcase.v1beta1.Identity/GetUser"))
               .findFirst()
               .orElseThrow(() -> new AssertionError("Incorrect span name"));
       assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
@@ -143,35 +149,46 @@ void testTracing_successfulEcho_grpc() throws Exception {
               attemptSpan
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.GRPC_RPC_METHOD_ATTRIBUTE)))
-          .isEqualTo("google.showcase.v1beta1.Echo/Echo");
+          .isEqualTo("google.showcase.v1beta1.Identity/GetUser");
       // {x-version-update-start:gapic-showcase:current}
       assertThat(
               attemptSpan
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.VERSION_ATTRIBUTE)))
           .isEqualTo("0.0.0-SNAPSHOT");
       // {x-version-update-end}
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(
+                      AttributeKey.stringKey(
+                          ObservabilityAttributes.DESTINATION_RESOURCE_ID_ATTRIBUTE)))
+          .isEqualTo("users/test-user");
     }
   }
 
   @Test
-  void testTracing_successfulEcho_httpjson() throws Exception {
+  void testTracing_successfulIdentityGetUser_httpjson() throws Exception {
     SpanTracerFactory tracingFactory = new SpanTracerFactory(openTelemetrySdk);
 
-    try (EchoClient client =
-        TestClientInitializer.createHttpJsonEchoClientOpentelemetry(tracingFactory)) {
+    try (IdentityClient client =
+        TestClientInitializer.createHttpJsonIdentityClientOpentelemetry(tracingFactory)) {
 
-      client.echo(EchoRequest.newBuilder().setContent("tracing-test").build());
+      try {
+        client.getUser(GetUserRequest.newBuilder().setName("users/test-user").build());
+      } catch (Exception e) {
+        // Ignored, the showcase server may not have this user, but trace is still generated.
+      }
 
       List<SpanData> spans = spanExporter.getFinishedSpanItems();
       assertThat(spans).isNotEmpty();
 
       SpanData attemptSpan =
           spans.stream()
-              .filter(span -> span.getName().equals("POST v1beta1/echo:echo"))
+              .filter(span -> span.getName().equals("GET v1beta1/{name=users/*}"))
               .findFirst()
               .orElseThrow(
-                  () -> new AssertionError("Attempt span 'POST v1beta1/echo:echo' not found"));
+                  () -> new AssertionError("Attempt span 'GET v1beta1/{name=users/*}' not found"));
       assertThat(attemptSpan.getKind()).isEqualTo(SpanKind.CLIENT);
       assertThat(
               attemptSpan
@@ -202,12 +219,19 @@ void testTracing_successfulEcho_httpjson() throws Exception {
               attemptSpan
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.HTTP_METHOD_ATTRIBUTE)))
-          .isEqualTo("POST");
+          .isEqualTo("GET");
       assertThat(
               attemptSpan
                   .getAttributes()
                   .get(AttributeKey.stringKey(ObservabilityAttributes.HTTP_URL_TEMPLATE_ATTRIBUTE)))
-          .isEqualTo("v1beta1/echo:echo");
+          .isEqualTo("v1beta1/{name=users/*}");
+      assertThat(
+              attemptSpan
+                  .getAttributes()
+                  .get(
+                      AttributeKey.stringKey(
+                          ObservabilityAttributes.DESTINATION_RESOURCE_ID_ATTRIBUTE)))
+          .isEqualTo("users/test-user");
     }
   }
 

java-showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/util/TestClientInitializer.java

@@ -340,4 +340,44 @@ public static EchoClient createHttpJsonEchoClientOpentelemetry(
 
     return EchoClient.create(stub);
   }
+
+  public static IdentityClient createGrpcIdentityClientOpentelemetry(ApiTracerFactory tracerFactory)
+      throws Exception {
+    IdentitySettings grpcIdentitySettings =
+        IdentitySettings.newBuilder()
+            .setCredentialsProvider(NoCredentialsProvider.create())
+            .setTransportChannelProvider(
+                IdentitySettings.defaultGrpcTransportProviderBuilder()
+                    .setChannelConfigurator(ManagedChannelBuilder::usePlaintext)
+                    .build())
+            .setEndpoint(DEFAULT_GRPC_ENDPOINT)
+            .build();
+
+    com.google.showcase.v1beta1.stub.IdentityStubSettings identityStubSettings =
+        (com.google.showcase.v1beta1.stub.IdentityStubSettings)
+            grpcIdentitySettings.getStubSettings().toBuilder()
+                .setTracerFactory(tracerFactory)
+                .build();
+    return IdentityClient.create(identityStubSettings.createStub());
+  }
+
+  public static IdentityClient createHttpJsonIdentityClientOpentelemetry(ApiTracerFactory tracerFactory)
+      throws Exception {
+    IdentitySettings httpJsonIdentitySettings =
+        IdentitySettings.newHttpJsonBuilder()
+            .setCredentialsProvider(NoCredentialsProvider.create())
+            .setTransportChannelProvider(
+                IdentitySettings.defaultHttpJsonTransportProviderBuilder()
+                    .setHttpTransport(new NetHttpTransport.Builder().doNotValidateCertificate().build())
+                    .setEndpoint(DEFAULT_HTTPJSON_ENDPOINT)
+                    .build())
+            .build();
+
+    com.google.showcase.v1beta1.stub.IdentityStubSettings identityStubSettings =
+        (com.google.showcase.v1beta1.stub.IdentityStubSettings)
+            httpJsonIdentitySettings.getStubSettings().toBuilder()
+                .setTracerFactory(tracerFactory)
+                .build();
+    return IdentityClient.create(identityStubSettings.createStub());
+  }
 }