chore(x-goog-spanner-request-id): set span attribute x_goog_spanner_request_id

This sets the span attribute x_goog_spanner_request_id so as to enable
correlation with distributed tracing with OpenTelemetry.

Updates #3537

Author: odeke-em

google-cloud-spanner/src/main/java/com/google/cloud/spanner/XGoogSpannerRequestId.java

@@ -159,4 +159,8 @@ public XGoogSpannerRequestId nextRequestId(long channelId, int attempt) {
       return XGoogSpannerRequestId.of(1, 1, 1, 0);
     }
   }
+
+  public static String getRequestIdFromMetadata(Metadata md) {
+    return md.get(REQUEST_HEADER_KEY);
+  }
 }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/HeaderInterceptor.java

@@ -28,6 +28,7 @@
 import com.google.cloud.spanner.CompositeTracer;
 import com.google.cloud.spanner.SpannerExceptionFactory;
 import com.google.cloud.spanner.SpannerRpcMetrics;
+import com.google.cloud.spanner.XGoogSpannerRequestId;
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
 import com.google.spanner.admin.database.v1.DatabaseName;
@@ -174,6 +175,10 @@ private void processHeader(
         }
         if (span != null) {
           span.setAttribute("gfe_latency", String.valueOf(gfeLatency));
+          String reqId = XGoogSpannerRequestId.getRequestIdFromMetadata(metadata);
+          if (reqId != null) {
+            span.setAttribute("x_goog_spanner_request_id", reqId);
+          }
         }
       } else {
         measureMap.put(SPANNER_GFE_HEADER_MISSING_COUNT, 1L).record(tagContext);

google-cloud-spanner/src/test/java/com/google/cloud/spanner/OpenTelemetrySpanTest.java

@@ -734,7 +734,7 @@ public void testTransactionRunnerWithRetryOnBeginTransaction() {
     assertTrue(
         actualSpanNames,
         finishedSpanNames.contains("CloudSpannerOperation.BatchCreateSessionsRequest"));
-
+    verifyAtLeast1SpanHasXGoogSpannerRequestIdAttribute(finishedSpans);
     assertTrue(actualSpanNames, finishedSpanNames.contains("Spanner.BatchCreateSessions"));
     assertTrue(actualSpanNames, finishedSpanNames.contains("Spanner.BeginTransaction"));
     assertTrue(actualSpanNames, finishedSpanNames.contains("Spanner.Commit"));
@@ -750,6 +750,14 @@ public void testTransactionRunnerWithRetryOnBeginTransaction() {
             .anyMatch(event -> event.getName().equals("Starting RPC retry 1")));
   }
 
+  private void verifyAtLeast1SpanHasXGoogSpannerRequestIdAttribute(List<SpanData> finishedSpans) {
+    AttributeKey<String> attributeKey = AttributeKey.stringKey("x_goog_spanner_request_id");
+    SpanData matchingSpan = finishedSpans.stream()
+            .filter(span -> !span.getAttributes().get(attributeKey).isEmpty())
+            .findAny()
+            .orElseThrow(IllegalStateException::new);
+  }
+
   @Test
   public void testSingleUseRetryOnExecuteStreamingSql() {
     // First get the client to ensure that the BatchCreateSessions request has been executed.
@@ -798,6 +806,7 @@ public void testSingleUseRetryOnExecuteStreamingSql() {
         executeStreamingQuery.toString(),
         executeStreamingQuery.getEvents().stream()
             .anyMatch(event -> event.getName().contains("Stream broken. Safe to retry")));
+    verifyAtLeast1SpanHasXGoogSpannerRequestIdAttribute(finishedSpans);
   }
 
   @Test
@@ -845,6 +854,7 @@ public void testRetryOnExecuteSql() {
         executeSqlSpan.toString(),
         executeSqlSpan.getEvents().stream()
             .anyMatch(event -> event.getName().equals("Starting RPC retry 1")));
+    verifyAtLeast1SpanHasXGoogSpannerRequestIdAttribute(finishedSpans);
   }
 
   @Test