feat(bigquery): Add OpenTelemetry Samples (#3899)

whuffman36 · web-flow · commit e3d9ed92ca5d · 2025-07-23T10:46:24.000-07:00
* feat(bigquery): Add OpenTelemetry Samples

* Add dependencies to pom files

* fix style

* Fix dependencies, clean up sample

* Add sample without parent span

* Fix copy/paste error

* Remove reference to global otel object

* Replace custom exporter with logging exporter

* Add logging exporter dep to snapshot and without-bom

* Generate random strings for ds names

* feat(bigquery): Add custom console exporter to samples

* fix style, remove comments
diff --git a/samples/install-without-bom/pom.xml b/samples/install-without-bom/pom.xml
@@ -59,6 +59,37 @@
       <artifactId>google-oauth-client-jetty</artifactId>
       <version>1.39.0</version>
     </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-api</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-context</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-common</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-trace</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-exporter-logging</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+
     <!-- Test dependencies -->
     <dependency>
       <groupId>com.google.cloud</groupId>
diff --git a/samples/snapshot/pom.xml b/samples/snapshot/pom.xml
@@ -39,6 +39,18 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
 
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>io.opentelemetry</groupId>
+        <artifactId>opentelemetry-bom</artifactId>
+        <version>1.48.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
   <dependencies>
     <!-- {x-version-update-start:google-cloud-bigquery:current} -->
     <dependency>
@@ -82,6 +94,36 @@
       <version>1.4.4</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-api</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-context</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-common</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-trace</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-exporter-logging</artifactId>
+      <version>1.48.0</version>
+    </dependency>
   </dependencies>
 
   <!-- compile and run all snippet tests -->
diff --git a/samples/snippets/pom.xml b/samples/snippets/pom.xml
@@ -51,6 +51,13 @@
         <type>pom</type>
         <scope>import</scope>
       </dependency>
+      <dependency>
+        <groupId>io.opentelemetry</groupId>
+        <artifactId>opentelemetry-bom</artifactId>
+        <version>1.48.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
     </dependencies>
   </dependencyManagement>
 
@@ -59,6 +66,36 @@
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-bigquery</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-api</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-context</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-common</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-sdk-trace</artifactId>
+      <version>1.48.0</version>
+    </dependency>
+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-exporter-logging</artifactId>
+      <version>1.48.0</version>
+    </dependency>
     <!-- [END bigquery_java_dependencies] -->
     <!-- [END bigquery_install_with_bom] -->
 
diff --git a/samples/snippets/src/main/java/com/example/bigquery/EnableOpenTelemetryTracing.java b/samples/snippets/src/main/java/com/example/bigquery/EnableOpenTelemetryTracing.java
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.bigquery;
+
+// [START bigquery_enable_otel_tracing]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.Dataset;
+import com.google.cloud.bigquery.DatasetInfo;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.trace.Tracer;
+import io.opentelemetry.exporter.logging.LoggingSpanExporter;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.trace.SdkTracerProvider;
+import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
+import io.opentelemetry.sdk.trace.samplers.Sampler;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Logger;
+
+public class EnableOpenTelemetryTracing {
+  private static final Logger log = Logger.getLogger(EnableOpenTelemetryTracing.class.getName());
+
+  public static void main(String[] args) {
+    // Set logging to System.err.
+    ConsoleHandler ch = new ConsoleHandler();
+    log.addHandler(ch);
+
+    // TODO(developer): Replace values before running the sample.
+    final String tracerName = "Sample Tracer";
+    final String datasetId = "sampleDatasetId";
+
+    // Create TracerProvider that exports to a logger.
+    SdkTracerProvider tracerProvider =
+        SdkTracerProvider.builder()
+            .addSpanProcessor(SimpleSpanProcessor.builder(LoggingSpanExporter.create()).build())
+            .setSampler(Sampler.alwaysOn())
+            .build();
+
+    // Create global OpenTelemetry instance using the TracerProvider.
+    OpenTelemetry otel = OpenTelemetrySdk.builder().setTracerProvider(tracerProvider).build();
+
+    // Create Tracer instance from the OpenTelemetry object. Tracers are used to create
+    // Spans. There can be multiple Tracers in an OpenTelemetry instance.
+    Tracer tracer = otel.getTracer(tracerName);
+
+    enableOpenTelemetry(tracer, datasetId);
+  }
+
+  public static void enableOpenTelemetry(Tracer tracer, String datasetId) {
+    // Create BigQuery client to trace. EnableOpenTelemetryTracing and OpenTelemetryTracer must
+    // be set to enable tracing.
+    BigQueryOptions otelOptions =
+        BigQueryOptions.newBuilder()
+            .setEnableOpenTelemetryTracing(true)
+            .setOpenTelemetryTracer(tracer)
+            .build();
+    BigQuery bigquery = otelOptions.getService();
+
+    try {
+      // Create dataset.
+      DatasetInfo info = DatasetInfo.newBuilder(datasetId).build();
+      Dataset dataset = bigquery.create(info);
+    } catch (Exception e) {
+      System.out.println(
+          String.format("Failed to create dataset: %s: %s", e.toString(), e.getMessage()));
+    } finally {
+      bigquery.delete(datasetId);
+    }
+  }
+}
+// [END bigquery_enable_otel_tracing]
diff --git a/samples/snippets/src/main/java/com/example/bigquery/EnableOpenTelemetryTracingWithParentSpan.java b/samples/snippets/src/main/java/com/example/bigquery/EnableOpenTelemetryTracingWithParentSpan.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.bigquery;
+
+// [START bigquery_enable_otel_tracing_with_parent_span]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.Dataset;
+import com.google.cloud.bigquery.DatasetInfo;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.Tracer;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.exporter.logging.LoggingSpanExporter;
+import io.opentelemetry.sdk.OpenTelemetrySdk;
+import io.opentelemetry.sdk.trace.SdkTracerProvider;
+import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
+import io.opentelemetry.sdk.trace.samplers.Sampler;
+import java.time.LocalDate;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Logger;
+
+public class EnableOpenTelemetryTracingWithParentSpan {
+  private static final Logger log =
+      Logger.getLogger(EnableOpenTelemetryTracingWithParentSpan.class.getName());
+
+  public static void main(String[] args) {
+    // Set logging to System.err.
+    ConsoleHandler ch = new ConsoleHandler();
+    log.addHandler(ch);
+
+    // TODO(developer): Replace values before running the sample.
+    final String tracerName = "Sample Tracer";
+    final String parentSpanName = "Sample Parent Span";
+    final String datasetId = "sampleDatasetId";
+
+    // Create TracerProvider that exports to a logger.
+    SdkTracerProvider tracerProvider =
+        SdkTracerProvider.builder()
+            .addSpanProcessor(SimpleSpanProcessor.builder(LoggingSpanExporter.create()).build())
+            .setSampler(Sampler.alwaysOn())
+            .build();
+
+    // Create OpenTelemetry instance using the TracerProvider.
+    OpenTelemetry otel = OpenTelemetrySdk.builder().setTracerProvider(tracerProvider).build();
+
+    // Create Tracer instance from the global OpenTelemetry object. Tracers are used to create
+    // Spans. There can be multiple Tracers in a global OpenTelemetry instance.
+    final Tracer tracer = otel.getTracer(tracerName);
+    enableOpenTelemetryWithParentSpan(tracer, parentSpanName, datasetId);
+  }
+
+  public static void enableOpenTelemetryWithParentSpan(
+      Tracer tracer, String parentSpanName, String datasetId) {
+    // Create BigQuery client to trace. EnableOpenTelemetryTracing and OpenTelemetryTracer must
+    // be set to enable tracing.
+    BigQueryOptions otelOptions =
+        BigQueryOptions.newBuilder()
+            .setEnableOpenTelemetryTracing(true)
+            .setOpenTelemetryTracer(tracer)
+            .build();
+    BigQuery bigquery = otelOptions.getService();
+
+    LocalDate currentDate = LocalDate.now();
+
+    // Create the root parent Span. setNoParent() ensures that it is a parent Span with a Span ID
+    // of 0.
+    Span parentSpan =
+        tracer
+            .spanBuilder(parentSpanName)
+            .setNoParent()
+            .setAttribute("current_date", currentDate.toString())
+            .startSpan();
+
+    // The Span Context is automatically passed on to any functions called within the scope of the
+    // try block. parentSpan.makeCurrent() sets parentSpan to be the parent of any Spans created in
+    // this scope, or the scope of any functions called within this scope.
+    try (Scope parentScope = parentSpan.makeCurrent()) {
+      DatasetInfo info = DatasetInfo.newBuilder(datasetId).build();
+      Dataset dataset = bigquery.create(info);
+    } catch (Exception e) {
+      System.out.println(
+          String.format("Failed to create dataset: %s: %s", e.toString(), e.getMessage()));
+    } finally {
+      // finally block ensures that Spans are cleaned up properly.
+      parentSpan.end();
+      bigquery.delete(datasetId);
+    }
+  }
+}
+// [END bigquery_enable_otel_tracing_with_parent_span]
diff --git a/samples/snippets/src/test/java/com/example/bigquery/EnableOpenTelemetryTracingIT.java b/samples/snippets/src/test/java/com/example/bigquery/EnableOpenTelemetryTracingIT.java
diff --git a/samples/snippets/src/test/java/com/example/bigquery/EnableOpenTelemetryTracingWithParentSpanIT.java b/samples/snippets/src/test/java/com/example/bigquery/EnableOpenTelemetryTracingWithParentSpanIT.java
