feat(bigguery): add url.domain to span tracing (#12208)

This adds the url.domain attribute to http span tracing. This field
should matching the proto domain if not overridden by user, otherwise it
should match the user set value.

[default domain](https://screenshot.googleplex.com/6k7r32jK4fu9x4E.png)
[user set
example](https://screenshot.googleplex.com/BLgGfV7hLTgaDME.png)

Author: ldetmer

java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/spi/v2/HttpBigQueryRpc.java

@@ -96,6 +96,7 @@ public class HttpBigQueryRpc implements BigQueryRpc {
   private static final int HTTP_RESUME_INCOMPLETE = 308;
   private final BigQueryOptions options;
   private final Bigquery bigquery;
+  private final String urlDomain;
 
   @InternalApi("Visible for testing")
   static final Function<DatasetList.Datasets, Dataset> LIST_TO_DATASET =
@@ -117,6 +118,7 @@ public HttpBigQueryRpc(BigQueryOptions options) {
     HttpTransport transport = transportOptions.getHttpTransportFactory().create();
     HttpRequestInitializer initializer = transportOptions.getHttpRequestInitializer(options);
     this.options = options;
+    this.urlDomain = new GenericUrl(options.getResolvedApiaryHost("bigquery")).getHost();
 
     if (options.isOpenTelemetryTracingEnabled()
         && options.getOpenTelemetryTracer() != null
@@ -2149,7 +2151,8 @@ private Span createRpcTracingSpan(
       builder
           .setAttribute(
               BigQueryTelemetryTracer.GCP_RESOURCE_DESTINATION_ID, gcpResourceDestinationId)
-          .setAttribute(BigQueryTelemetryTracer.URL_TEMPLATE, urlTemplate);
+          .setAttribute(BigQueryTelemetryTracer.URL_TEMPLATE, urlTemplate)
+          .setAttribute(BigQueryTelemetryTracer.URL_DOMAIN, this.urlDomain);
     }
 
     if (options != null) {

java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/telemetry/BigQueryTelemetryTracer.java

@@ -66,6 +66,7 @@ private BigQueryTelemetryTracer() {}
       AttributeKey.stringKey("server.address");
   public static final AttributeKey<Long> SERVER_PORT = AttributeKey.longKey("server.port");
   public static final AttributeKey<String> URL_TEMPLATE = AttributeKey.stringKey("url.template");
+  public static final AttributeKey<String> URL_DOMAIN = AttributeKey.stringKey("url.domain");
 
   public static void addCommonAttributeToSpan(Span span) {
     span.setAttribute(GCP_CLIENT_SERVICE, BQ_GCP_CLIENT_SERVICE)

java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/telemetry/HttpTracingRequestInitializer.java

@@ -39,7 +39,6 @@ public class HttpTracingRequestInitializer implements HttpRequestInitializer {
   public static final AttributeKey<String> HTTP_REQUEST_METHOD =
       AttributeKey.stringKey("http.request.method");
   public static final AttributeKey<String> URL_FULL = AttributeKey.stringKey("url.full");
-  public static final AttributeKey<String> URL_DOMAIN = AttributeKey.stringKey("url.domain");
   public static final AttributeKey<Long> HTTP_RESPONSE_STATUS_CODE =
       AttributeKey.longKey("http.response.status_code");
   public static final AttributeKey<Long> HTTP_REQUEST_RESEND_COUNT =

java-bigquery/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/spi/v2/HttpBigQueryRpcTest.java

@@ -1140,6 +1140,59 @@ public void testGetUriTemplateValueTelemetry() throws Exception {
           "projects/{+projectId}/datasets/{+datasetId}",
           rpcSpan.getAttributes().get(BigQueryTelemetryTracer.URL_TEMPLATE));
     }
+
+    @Test
+    public void testUrlDomain_DefaultValue() throws Exception {
+      setMockResponse(
+          "{\"kind\":\"bigquery#dataset\",\"id\":\"" + PROJECT_ID + ":" + DATASET_ID + "\"}");
+
+      rpc.getDatasetSkipExceptionTranslation(PROJECT_ID, DATASET_ID, new HashMap<>());
+
+      List<io.opentelemetry.sdk.trace.data.SpanData> spans = spanExporter.getFinishedSpanItems();
+      io.opentelemetry.sdk.trace.data.SpanData rpcSpan =
+          spans.stream()
+              .filter(
+                  span -> span.getName().equals("com.google.cloud.bigquery.BigQueryRpc.getDataset"))
+              .findFirst()
+              .orElse(null);
+      assertNotNull(rpcSpan);
+      assertEquals(
+          "bigquery.googleapis.com",
+          rpcSpan.getAttributes().get(BigQueryTelemetryTracer.URL_DOMAIN));
+    }
+
+    @Test
+    public void testUrlDomain_OverriddenValue() throws Exception {
+      setMockResponse(
+          "{\"kind\":\"bigquery#dataset\",\"id\":\"" + PROJECT_ID + ":" + DATASET_ID + "\"}");
+
+      BigQueryOptions customOptions =
+          BigQueryOptions.newBuilder()
+              .setProjectId(PROJECT_ID)
+              .setCredentials(NoCredentials.getInstance())
+              .setEnableOpenTelemetryTracing(true)
+              .setOpenTelemetryTracer(tracer)
+              .setTransportOptions(
+                  BigQueryOptions.getDefaultHttpTransportOptions().toBuilder()
+                      .setHttpTransportFactory(() -> mockTransport)
+                      .build())
+              .setHost("https://custom.googleapis.com")
+              .build();
+      HttpBigQueryRpc customRpc = new HttpBigQueryRpc(customOptions);
+
+      customRpc.getDatasetSkipExceptionTranslation(PROJECT_ID, DATASET_ID, new HashMap<>());
+
+      List<io.opentelemetry.sdk.trace.data.SpanData> spans = spanExporter.getFinishedSpanItems();
+      io.opentelemetry.sdk.trace.data.SpanData rpcSpan =
+          spans.stream()
+              .filter(
+                  span -> span.getName().equals("com.google.cloud.bigquery.BigQueryRpc.getDataset"))
+              .findFirst()
+              .orElse(null);
+      assertNotNull(rpcSpan);
+      assertEquals(
+          "custom.googleapis.com", rpcSpan.getAttributes().get(BigQueryTelemetryTracer.URL_DOMAIN));
+    }
   }
 
   @Nested
@@ -1190,8 +1243,8 @@ public void testHttpTracingDisabledDoesNotAddAdditionalAttributes() throws Excep
       assertNull(
           rpcSpan.getAttributes().get(AttributeKey.stringKey("url.template")),
           "url.template attribute should not be set");
-
       assertNull(rpcSpan.getAttributes().get(BigQueryTelemetryTracer.GCP_RESOURCE_DESTINATION_ID));
+      assertNull(rpcSpan.getAttributes().get(BigQueryTelemetryTracer.URL_DOMAIN));
     }
 
     @Test