feat(bigquery): Integrate Otel in client lib

whuffman36 · whuffman36 · commit 165bb24e9842 · 2025-04-08T11:56:28.000-07:00
diff --git a/google-cloud-bigquery/pom.xml b/google-cloud-bigquery/pom.xml
@@ -202,6 +202,19 @@
       <artifactId>proto-google-cloud-datacatalog-v1</artifactId>
       <scope>test</scope>
     </dependency>
+    <!-- OpenTelemetry -->
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-extension-autoconfigure-spi</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-exporter-logging</artifactId>
+    </dependency>
   </dependencies>
 
   <build>
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryOptions.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryOptions.java
@@ -25,6 +25,7 @@
 import com.google.cloud.http.HttpTransportOptions;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableSet;
+import io.opentelemetry.api.trace.Tracer;
 import java.util.Set;
 
 public class BigQueryOptions extends ServiceOptions<BigQuery, BigQueryOptions> {
@@ -39,6 +40,8 @@ public class BigQueryOptions extends ServiceOptions<BigQuery, BigQueryOptions> {
   private boolean setThrowNotFound;
   private boolean useInt64Timestamps;
   private String queryPreviewEnabled = System.getenv("QUERY_PREVIEW_ENABLED");
+  private boolean enableOpenTelemetryTracing;
+  private Tracer openTelemetryTracer;
 
   public static class DefaultBigQueryFactory implements BigQueryFactory {
 
@@ -64,6 +67,8 @@ public static class Builder extends ServiceOptions.Builder<BigQuery, BigQueryOpt
 
     private String location;
     private boolean useInt64Timestamps;
+    private boolean enableOpenTelemetryTracing;
+    private Tracer openTelemetryTracer;
 
     private Builder() {}
 
@@ -90,6 +95,16 @@ public Builder setUseInt64Timestamps(boolean useInt64Timestamps) {
       return this;
     }
 
+    public Builder setEnableOpenTelemetryTracing(boolean enableOpenTelemetryTracing) {
+      this.enableOpenTelemetryTracing = enableOpenTelemetryTracing;
+      return this;
+    }
+
+    public Builder setOpenTelemetryTracer(Tracer tracer) {
+      this.openTelemetryTracer = tracer;
+      return this;
+    }
+
     @Override
     public BigQueryOptions build() {
       return new BigQueryOptions(this);
@@ -100,6 +115,8 @@ private BigQueryOptions(Builder builder) {
     super(BigQueryFactory.class, BigQueryRpcFactory.class, builder, new BigQueryDefaults());
     this.location = builder.location;
     this.useInt64Timestamps = builder.useInt64Timestamps;
+    this.enableOpenTelemetryTracing = builder.enableOpenTelemetryTracing;
+    this.openTelemetryTracer = builder.openTelemetryTracer;
   }
 
   private static class BigQueryDefaults implements ServiceDefaults<BigQuery, BigQueryOptions> {
@@ -164,6 +181,14 @@ public boolean getUseInt64Timestamps() {
     return useInt64Timestamps;
   }
 
+  public boolean isOpenTelemetryTracingEnabled() {
+    return enableOpenTelemetryTracing;
+  }
+
+  public Tracer getOpenTelemetryTracer() {
+    return openTelemetryTracer;
+  }
+
   @SuppressWarnings("unchecked")
   @Override
   public Builder toBuilder() {
diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/OpenTelemetryTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/OpenTelemetryTest.java
@@ -0,0 +1,58 @@
+package com.google.cloud.bigquery;
+
+import io.opentelemetry.api.common.AttributeKey;
+import io.opentelemetry.api.trace.SpanKind;
+import io.opentelemetry.api.trace.Tracer;
+import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.trace.SdkTracerProvider;
+import io.opentelemetry.sdk.trace.samplers.Sampler;
+import io.opentelemetry.context.Scope;
+import java.util.logging.Logger;
+import java.time.Instant;
+import org.junit.Test;
+
+public class OpenTelemetryTest {
+  private static final Logger log = Logger.getLogger(OpenTelemetryTest.class.getName());
+  private static OpenTelemetrySdk sdk = null;
+
+  private void fillInSpanData(Tracer tracer) {
+    Span childSpan = tracer.spanBuilder("childSpan").setSpanKind(SpanKind.INTERNAL).setAttribute(AttributeKey.stringKey("fillInSpanData-key"), "running fillInSpanData()").startSpan();
+    try {
+      int result = 0;
+      for (int i = 0; i < 5000; ++i) {
+        if (i % 2 == 0) {
+          result += i;
+        }
+      }
+      childSpan.addEvent("finished loop at: ", Instant.now());
+    } finally {
+      childSpan.end();
+      log.info(childSpan.toString());
+    }
+  }
+
+  @Test
+  public void testOtel() {
+    Sampler alwaysOn = Sampler.alwaysOn();
+    sdk =
+        OpenTelemetrySdk.builder()
+            .setTracerProvider(
+                SdkTracerProvider.builder()
+                    .setSampler(alwaysOn)
+                    .build())
+            .build();
+
+    Tracer tracer = sdk.getTracer("TracerExample");
+    Span parentSpan = tracer.spanBuilder("parentSpan").setNoParent().setSpanKind(SpanKind.INTERNAL).setAttribute(
+        AttributeKey.longKey("long-key"), 25L).setAttribute(AttributeKey.booleanKey("bool-key"), true).setAttribute(AttributeKey.stringKey("string-key"), "qwerty").startSpan();
+
+    try (Scope parentScope = parentSpan.makeCurrent()) {
+      fillInSpanData(tracer);
+    }
+    finally {
+      parentSpan.end();
+      log.info(parentSpan.toString());
+    }
+  }
+}
diff --git a/pom.xml b/pom.xml
@@ -59,6 +59,15 @@
 
   <dependencyManagement>
     <dependencies>
+      <!-- OpenTelemetry -->
+      <dependency>
+        <groupId>io.opentelemetry</groupId>
+        <artifactId>opentelemetry-bom</artifactId>
+        <version>1.48.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+
       <dependency>
         <groupId>com.google.cloud</groupId>
         <artifactId>google-cloud-shared-dependencies</artifactId>
