Skip to content

fix: do a quick check if the application runs on GCP #4163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 13, 2025
Merged

fix: do a quick check if the application runs on GCP #4163

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
29240b1
fix: do a quick check if the application runs on GCP
olavloite Oct 10, 2025
7194be6
make location static and fetch it only once
surbhigarg92 Oct 13, 2025
60a681c
Merge branch 'main' into quick-check-is-running-on-gcp
surbhigarg92 Oct 13, 2025
9729cba
chore: generate libraries at Mon Oct 13 07:06:03 UTC 2025
cloud-java-bot Oct 13, 2025
09d5bd4
changing the timeout to 5 sec
surbhigarg92 Oct 13, 2025
cd29121
review comments
surbhigarg92 Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 42 additions & 3 deletions google-cloud-spanner/src/main/java/com/google/cloud/spanner/BuiltInMetricsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import com.google.cloud.opentelemetry.detection.AttributeKeys;
import com.google.cloud.opentelemetry.detection.DetectedPlatform;
import com.google.cloud.opentelemetry.detection.GCPPlatformDetector;
import com.google.common.base.Strings;
import com.google.common.hash.HashFunction;
import com.google.common.hash.Hashing;
import io.grpc.ManagedChannelBuilder;
Expand All @@ -43,11 +44,17 @@
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder;
import io.opentelemetry.sdk.resources.Resource;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.management.ManagementFactory;
import java.lang.reflect.Method;
import java.net.HttpURLConnection;
import java.net.InetAddress;
import java.net.URL;
import java.net.UnknownHostException;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
Expand Down Expand Up @@ -79,7 +86,9 @@ OpenTelemetry getOrCreateOpenTelemetry(
SpannerCloudMonitoringExporter.create(
projectId, credentials, monitoringHost, universeDomain),
sdkMeterProviderBuilder);
sdkMeterProviderBuilder.setResource(Resource.create(createResourceAttributes(projectId)));
String location = quickCheckIsRunningOnGcp() ? null : "global";
sdkMeterProviderBuilder.setResource(
Resource.create(createResourceAttributes(projectId, location)));
SdkMeterProvider sdkMeterProvider = sdkMeterProviderBuilder.build();
this.openTelemetry = OpenTelemetrySdk.builder().setMeterProvider(sdkMeterProvider).build();
Runtime.getRuntime().addShutdownHook(new Thread(sdkMeterProvider::close));
Expand All @@ -95,6 +104,36 @@ OpenTelemetry getOrCreateOpenTelemetry(
}
}

// TODO: Remove when
// https://github.com/GoogleCloudPlatform/opentelemetry-operations-java/issues/421
// has been fixed.
static boolean quickCheckIsRunningOnGcp() {
int timeout = 500;
try {
timeout =
Integer.parseInt(System.getProperty("spanner.check_is_running_on_gcp_timeout", "500"));
} catch (NumberFormatException ignore) {
// ignore
}
try {
URL url = new URL("http://metadata.google.internal/computeMetadata/v1/project/project-id");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setConnectTimeout(timeout);
connection.setRequestProperty("Metadata-Flavor", "Google");
if (connection.getResponseCode() == 200
&& ("Google").equals(connection.getHeaderField("Metadata-Flavor"))) {
InputStream input = connection.getInputStream();
try (BufferedReader reader =
new BufferedReader(new InputStreamReader(input, StandardCharsets.UTF_8))) {
return !Strings.isNullOrEmpty(reader.readLine());
}
}
} catch (IOException ignore) {
// ignore
}
return false;
}

void enableGrpcMetrics(
InstantiatingGrpcChannelProvider.Builder channelProviderBuilder,
String projectId,
Expand Down Expand Up @@ -122,14 +161,14 @@ void enableGrpcMetrics(
});
}

Attributes createResourceAttributes(String projectId) {
Attributes createResourceAttributes(String projectId, String location) {
AttributesBuilder attributesBuilder =
Attributes.builder()
.put(PROJECT_ID_KEY.getKey(), projectId)
.put(INSTANCE_CONFIG_ID_KEY.getKey(), "unknown")
.put(CLIENT_HASH_KEY.getKey(), generateClientHash(getDefaultTaskValue()))
.put(INSTANCE_ID_KEY.getKey(), "unknown")
.put(LOCATION_ID_KEY.getKey(), detectClientLocation());
.put(LOCATION_ID_KEY.getKey(), location == null ? detectClientLocation() : location);

return attributesBuilder.build();
}
Expand Down