Few issues and code optimisations

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

@@ -16,15 +16,16 @@
 
 package com.google.cloud.spanner;
 
+import static com.google.cloud.opentelemetry.detection.GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.CLIENT_NAME_KEY;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.CLIENT_UID_KEY;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.DIRECT_PATH_ENABLED_KEY;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.INSTANCE_CONFIG_ID_KEY;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.LOCATION_ID_KEY;
 import static com.google.cloud.spanner.BuiltInMetricsConstant.PROJECT_ID_KEY;
 
-import com.google.api.gax.core.GaxProperties;
 import com.google.auth.Credentials;
+import com.google.cloud.opentelemetry.detection.AttributeKeys;
 import com.google.cloud.opentelemetry.detection.DetectedPlatform;
 import com.google.cloud.opentelemetry.detection.GCPPlatformDetector;
 import io.opentelemetry.api.OpenTelemetry;
@@ -76,26 +77,28 @@ OpenTelemetry getOrCreateOpenTelemetry(String projectId, @Nullable Credentials c
     }
   }
 
-  Map<String, String> getClientAttributes(String projectId, boolean isDirectPathChannelCreated) {
+  Map<String, String> getClientAttributes(
+      String projectId, boolean isDirectPathChannelCreated, String client_name) {
     Map<String, String> clientAttributes = new HashMap<>();
     clientAttributes.put(LOCATION_ID_KEY.getKey(), detectClientLocation());
     clientAttributes.put(PROJECT_ID_KEY.getKey(), projectId);
     // TODO: Replace this with real value.
     clientAttributes.put(INSTANCE_CONFIG_ID_KEY.getKey(), "unknown");
     clientAttributes.put(
         DIRECT_PATH_ENABLED_KEY.getKey(), String.valueOf(isDirectPathChannelCreated));
-    clientAttributes.put(
-        CLIENT_NAME_KEY.getKey(),
-        "spanner-java/"
-            + GaxProperties.getLibraryVersion(SpannerCloudMonitoringExporterUtils.class));
+    clientAttributes.put(CLIENT_NAME_KEY.getKey(), client_name);
     clientAttributes.put(CLIENT_UID_KEY.getKey(), getDefaultTaskValue());
     return clientAttributes;
   }
 
-  private String detectClientLocation() {
+  static String detectClientLocation() {
     GCPPlatformDetector detector = GCPPlatformDetector.DEFAULT_INSTANCE;
     DetectedPlatform detectedPlatform = detector.detectPlatform();
-    String region = detectedPlatform.getAttributes().get("cloud.region");
+    // All platform except GKE uses "cloud_region" for region attribute.
+    String region = detectedPlatform.getAttributes().get("cloud_region");
+    if (detectedPlatform.getSupportedPlatform() == GOOGLE_KUBERNETES_ENGINE) {
+      region = detectedPlatform.getAttributes().get(AttributeKeys.GKE_LOCATION_TYPE_REGION);
+    }
     return region == null ? "global" : region;
   }
 

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

@@ -1655,23 +1655,24 @@ public OpenTelemetry getOpenTelemetry() {
 
   @Override
   public ApiTracerFactory getApiTracerFactory() {
-    return createApiTracerFactory(false, false);
+    return createApiTracerFactory(false, false, false);
   }
 
   public ApiTracerFactory getApiTracerFactory(
-      boolean isDirectPathChannelCreated, boolean isAdminClient) {
-    return createApiTracerFactory(isDirectPathChannelCreated, isAdminClient);
+      boolean isDirectPathChannelCreated, boolean isAdminClient, boolean isEmulatorEnabled) {
+    return createApiTracerFactory(isDirectPathChannelCreated, isAdminClient, isEmulatorEnabled);
   }
 
   private ApiTracerFactory createApiTracerFactory(
-      boolean isDirectPathChannelCreated, boolean isAdminClient) {
+      boolean isDirectPathChannelCreated, boolean isAdminClient, boolean isEmulatorEnabled) {
     List<ApiTracerFactory> apiTracerFactories = new ArrayList<>();
     // Prefer any direct ApiTracerFactory that might have been set on the builder.
     apiTracerFactories.add(
         MoreObjects.firstNonNull(super.getApiTracerFactory(), getDefaultApiTracerFactory()));
 
-    // Add Metrics Tracer factory if enabled and if data client
-    if (isEnableBuiltInMetrics() && !isAdminClient) {
+    // Add Metrics Tracer factory if built in metrics are enabled and if the client is data client
+    // and if emulator is not enabled.
+    if (isEnableBuiltInMetrics() && !isAdminClient && !isEmulatorEnabled) {
       ApiTracerFactory metricsTracerFactory =
           getMetricsApiTracerFactory(isDirectPathChannelCreated);
       if (metricsTracerFactory != null) {
@@ -1707,7 +1708,9 @@ private ApiTracerFactory getMetricsApiTracerFactory(boolean isDirectPathChannelC
         ? new MetricsTracerFactory(
             new OpenTelemetryMetricsRecorder(openTelemetry, BuiltInMetricsConstant.METER_NAME),
             builtInOpenTelemetryMetricsProvider.getClientAttributes(
-                getDefaultProjectId(), isDirectPathChannelCreated))
+                getDefaultProjectId(),
+                isDirectPathChannelCreated,
+                "spanner-java/" + GaxProperties.getLibraryVersion(getClass())))
         : null;
   }
 

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

@@ -391,6 +391,8 @@ public GapicSpannerRpc(final SpannerOptions options) {
               .withCheckInterval(checkInterval)
               .withClock(NanoClock.getDefaultClock());
 
+      final String emulatorHost = System.getenv("SPANNER_EMULATOR_HOST");
+
       try {
         this.spannerStub =
             GrpcSpannerStub.create(
@@ -401,7 +403,10 @@ public GapicSpannerRpc(final SpannerOptions options) {
                     .setCredentialsProvider(credentialsProvider)
                     .setStreamWatchdogProvider(watchdogProvider)
                     .setTracerFactory(
-                        options.getApiTracerFactory(isDirectPathChannelCreated, false))
+                        options.getApiTracerFactory(
+                            isDirectPathChannelCreated,
+                            false,
+                            isEmulatorEnabled(options, emulatorHost)))
                     .build());
         this.readRetrySettings =
             options.getSpannerStubSettings().streamingReadSettings().getRetrySettings();
@@ -429,7 +434,9 @@ public GapicSpannerRpc(final SpannerOptions options) {
             .setTransportChannelProvider(channelProvider)
             .setCredentialsProvider(credentialsProvider)
             .setStreamWatchdogProvider(watchdogProvider)
-            .setTracerFactory(options.getApiTracerFactory(isDirectPathChannelCreated, false))
+            .setTracerFactory(
+                options.getApiTracerFactory(
+                    isDirectPathChannelCreated, false, isEmulatorEnabled(options, emulatorHost)))
             .executeSqlSettings()
             .setRetrySettings(partitionedDmlRetrySettings);
         pdmlSettings.executeStreamingSqlSettings().setRetrySettings(partitionedDmlRetrySettings);
@@ -456,7 +463,9 @@ public GapicSpannerRpc(final SpannerOptions options) {
                 .setTransportChannelProvider(channelProvider)
                 .setCredentialsProvider(credentialsProvider)
                 .setStreamWatchdogProvider(watchdogProvider)
-                .setTracerFactory(options.getApiTracerFactory(isDirectPathChannelCreated, true))
+                .setTracerFactory(
+                    options.getApiTracerFactory(
+                        isDirectPathChannelCreated, true, isEmulatorEnabled(options, emulatorHost)))
                 .build();
         this.instanceAdminStub = GrpcInstanceAdminStub.create(instanceAdminStubSettings);
 
@@ -467,7 +476,9 @@ public GapicSpannerRpc(final SpannerOptions options) {
                 .setTransportChannelProvider(channelProvider)
                 .setCredentialsProvider(credentialsProvider)
                 .setStreamWatchdogProvider(watchdogProvider)
-                .setTracerFactory(options.getApiTracerFactory(isDirectPathChannelCreated, true))
+                .setTracerFactory(
+                    options.getApiTracerFactory(
+                        isDirectPathChannelCreated, true, isEmulatorEnabled(options, emulatorHost)))
                 .build();
 
         // Automatically retry RESOURCE_EXHAUSTED for GetOperation if auto-throttling of
@@ -511,7 +522,7 @@ public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCalla
 
         // Check whether the SPANNER_EMULATOR_HOST env var has been set, and if so, if the emulator
         // is actually running.
-        checkEmulatorConnection(options, channelProvider, credentialsProvider);
+        checkEmulatorConnection(options, channelProvider, credentialsProvider, emulatorHost);
       } catch (Exception e) {
         throw newSpannerException(e);
       }
@@ -610,15 +621,11 @@ private static HeaderProvider headerProviderWithUserAgentFrom(HeaderProvider hea
   private static void checkEmulatorConnection(
       SpannerOptions options,
       TransportChannelProvider channelProvider,
-      CredentialsProvider credentialsProvider)
+      CredentialsProvider credentialsProvider,
+      String emulatorHost)
       throws IOException {
-    final String emulatorHost = System.getenv("SPANNER_EMULATOR_HOST");
     // Only do the check if the emulator environment variable has been set to localhost.
-    if (options.getChannelProvider() == null
-        && emulatorHost != null
-        && options.getHost() != null
-        && options.getHost().startsWith("http://localhost")
-        && options.getHost().endsWith(emulatorHost)) {
+    if (isEmulatorEnabled(options, emulatorHost)) {
       // Do a quick check to see if the emulator is actually running.
       try {
         InstanceAdminStubSettings.Builder testEmulatorSettings =
@@ -651,6 +658,15 @@ private static void checkEmulatorConnection(
     }
   }
 
+  private static boolean isEmulatorEnabled(SpannerOptions options, String emulatorHost) {
+    // Only do the check if the emulator environment variable has been set to localhost.
+    return options.getChannelProvider() == null
+        && emulatorHost != null
+        && options.getHost() != null
+        && options.getHost().startsWith("http://localhost")
+        && options.getHost().endsWith(emulatorHost);
+  }
+
   private static final RetrySettings ADMIN_REQUESTS_LIMIT_EXCEEDED_RETRY_SETTINGS =
       RetrySettings.newBuilder()
           .setInitialRetryDelay(Duration.ofSeconds(5L))

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

@@ -91,6 +91,7 @@ class HeaderInterceptor implements ClientInterceptor {
   @Override
   public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
       MethodDescriptor<ReqT, RespT> method, CallOptions callOptions, Channel next) {
+    Object tracer = callOptions.getOption(TRACER_KEY);
     return new SimpleForwardingClientCall<ReqT, RespT>(next.newCall(method, callOptions)) {
       @Override
       public void start(Listener<RespT> responseListener, Metadata headers) {
@@ -99,8 +100,8 @@ public void start(Listener<RespT> responseListener, Metadata headers) {
           DatabaseName databaseName = extractDatabaseName(headers);
           String key = databaseName + method.getFullMethodName();
           TagContext tagContext = getTagContext(key, method.getFullMethodName(), databaseName);
-          if (callOptions.getOption(TRACER_KEY) instanceof CompositeTracer) {
-            CompositeTracer compositeTracer = (CompositeTracer) callOptions.getOption(TRACER_KEY);
+          if (tracer instanceof CompositeTracer) {
+            CompositeTracer compositeTracer = (CompositeTracer) tracer;
             addBuiltInMetricAttributes(compositeTracer, databaseName);
           }
           Attributes attributes =

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

@@ -21,7 +21,6 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
-import com.google.api.gax.core.GaxProperties;
 import com.google.api.gax.longrunning.OperationTimedPollAlgorithm;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.api.gax.tracing.ApiTracerFactory;
@@ -87,19 +86,19 @@ public static void setup() {
 
     BuiltInMetricsConstant.getAllViews().forEach(meterProvider::registerView);
 
+    String client_name = "spanner-java/";
     openTelemetry = OpenTelemetrySdk.builder().setMeterProvider(meterProvider.build()).build();
-    attributes = provider.getClientAttributes("test-project", true);
+    attributes = provider.getClientAttributes("test-project", true, client_name);
 
     expectedBaseAttributes =
         Attributes.builder()
             .put(BuiltInMetricsConstant.PROJECT_ID_KEY, "test-project")
             .put(BuiltInMetricsConstant.INSTANCE_CONFIG_ID_KEY, "unknown")
             .put(BuiltInMetricsConstant.DIRECT_PATH_ENABLED_KEY, "true")
-            .put(BuiltInMetricsConstant.LOCATION_ID_KEY, "global")
             .put(
-                BuiltInMetricsConstant.CLIENT_NAME_KEY,
-                "spanner-java/"
-                    + GaxProperties.getLibraryVersion(SpannerCloudMonitoringExporterUtils.class))
+                BuiltInMetricsConstant.LOCATION_ID_KEY,
+                BuiltInOpenTelemetryMetricsProvider.detectClientLocation())
+            .put(BuiltInMetricsConstant.CLIENT_NAME_KEY, client_name)
             .put(BuiltInMetricsConstant.CLIENT_UID_KEY, attributes.get("client_uid"))
             .build();
   }