documentation

Author: surbhigarg92

README.md

@@ -158,6 +158,9 @@ the Cloud Spanner Java client.
 
 ## OpenCensus Metrics
 
+> Note: OpenCensus project is deprecated. See [Sunsetting OpenCensus](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).
+We recommend migrating to OpenTelemetry, the successor project.
+
 Cloud Spanner client supports [Opencensus Metrics](https://opencensus.io/stats/),
 which gives insight into the client internals and aids in debugging/troubleshooting
 production issues. OpenCensus metrics will provide you with enough data to enable you to

google-cloud-spanner/pom.xml

@@ -263,14 +263,14 @@
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk-testing</artifactId>
+      <artifactId>opentelemetry-sdk-trace</artifactId>
       <version>${opentelemetry.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
-      <artifactId>opentelemetry-sdk-metrics-testing</artifactId>
-      <version>1.13.0-alpha</version>
+      <artifactId>opentelemetry-sdk-testing</artifactId>
+      <version>${opentelemetry.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>

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

@@ -91,8 +91,12 @@ public class SpannerRpcViews {
    * measures the latency between Google's network receives an RPC and reads back the first byte of
    * the response. gfe_header_missing_count is a counter of the number of RPC responses without a
    * server-timing header.
+   *
+   * @deprecated The OpenCensus project is deprecated. Use OpeTelemetry to get gfe_latency and
+   *     gfe_header_missing_count metrics.
    */
   @VisibleForTesting
+  @Deprecated
   public static void registerGfeLatencyAndHeaderMissingCountViews() {
     viewManager.registerView(SPANNER_GFE_LATENCY_VIEW);
     viewManager.registerView(SPANNER_GFE_HEADER_MISSING_COUNT_VIEW);
@@ -101,6 +105,9 @@ public static void registerGfeLatencyAndHeaderMissingCountViews() {
   /**
    * Register GFE Latency view. gfe_latency measures the latency between Google's network receives
    * an RPC and reads back the first byte of the response.
+   *
+   * @deprecated The OpenCensus project is deprecated. Use OpeTelemetry to get gfe_latency and
+   *     gfe_header_missing_count metrics.
    */
   @VisibleForTesting
   public static void registerGfeLatencyView() {
@@ -110,6 +117,9 @@ public static void registerGfeLatencyView() {
   /**
    * Register GFE Header Missing Count view. gfe_header_missing_count is a counter of the number of
    * RPC responses without a server-timing header.
+   *
+   * @deprecated The OpenCensus project is deprecated. Use OpeTelemetry to get gfe_latency and
+   *     gfe_header_missing_count metrics.
    */
   @VisibleForTesting
   public static void registerGfeHeaderMissingCountView() {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 Google LLC
+ * Copyright 2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,6 @@
 
 package com.google.cloud.spanner;
 
-import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
@@ -106,8 +105,6 @@ public static void startStaticServer() throws IOException {
     String uniqueName = InProcessServerBuilder.generateName();
     server =
         InProcessServerBuilder.forName(uniqueName)
-            // We need to use a real executor for timeouts to occur.
-            .scheduledExecutorService(new ScheduledThreadPoolExecutor(1))
             .addService(mockSpanner)
             .build()
             .start();
@@ -181,7 +178,7 @@ public void singleUse() {
                           || name.equals("CloudSpanner.ReadOnlyTransaction")
                           || name.equals("SessionPool.WaitForSession"));
       assertTrue(hasSpanData);
-      assertThat(spans.size()).isEqualTo(5);
+      assertEquals(5, spans.size());
     }
   }
 
@@ -209,7 +206,7 @@ public void multiUse() {
                         || name.equals("CloudSpanner.ReadOnlyTransaction")
                         || name.equals("SessionPool.WaitForSession"));
     assertTrue(hasSpanData);
-    assertThat(spans.size()).isEqualTo(5);
+    assertEquals(5, spans.size());
   }
 
   @Test
@@ -231,7 +228,7 @@ public void transactionRunner() {
                         || name.equals("CloudSpanner.ReadWriteTransaction")
                         || name.equals("SessionPool.WaitForSession"));
     assertTrue(hasSpanData);
-    assertThat(spans.size()).isEqualTo(5);
+    assertEquals(5, spans.size());
   }
 
   @Test
@@ -257,6 +254,6 @@ public void transactionRunnerWithError() {
                         || name.equals("CloudSpanner.ReadWriteTransaction")
                         || name.equals("SessionPool.WaitForSession"));
     assertTrue(hasSpanData);
-    assertThat(spans.size()).isEqualTo(4);
+    assertEquals(4, spans.size());
   }
 }

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

@@ -177,6 +177,7 @@ private SessionPool createPool(
         new TestExecutorFactory(),
         client.getSessionClient(db),
         clock,
+        Position.RANDOM,
         metricRegistry,
         labelValues,
         openTelemetry,

samples/snippets/src/main/java/com/example/spanner/TracingSample.java

@@ -32,7 +32,11 @@
 import io.opencensus.trace.samplers.Samplers;
 import java.util.Arrays;
 
-/** This sample demonstrates how to enable opencensus tracing and stats in cloud spanner client. */
+/** This sample demonstrates how to enable opencensus tracing and stats in cloud spanner client. 
+ *
+ * @deprecated The OpenCensus project is deprecated. Use OpenTelemetry to enable metrics 
+ * and stats with cloud spanner client. 
+*/
 public class TracingSample {
 
   private static final String SAMPLE_SPAN = "CloudSpannerSample";