Skip to content

Remove dependency on deprecated OTel GCP resource detector #369

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

Open
psx95 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove dependency on deprecated OTel GCP resource detector #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e8d710
chrore: update GCP resource detection process
psx95 Jul 22, 2026
c87e32b
Merge branch 'main' into udpate-resource-detection
ath-08 Jul 23, 2026
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
8 changes: 6 additions & 2 deletions google-cloud-spanner-cassandra/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,12 @@
<artifactId>opentelemetry-sdk</artifactId>
</dependency>
<dependency>
<groupId>com.google.cloud.opentelemetry</groupId>
<artifactId>detector-resources-support</artifactId>
<groupId>io.opentelemetry.contrib</groupId>
<artifactId>opentelemetry-gcp-resources</artifactId>
</dependency>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-sdk-extension-autoconfigure-spi</artifactId>
</dependency>
<dependency>
<groupId>com.google.cloud.opentelemetry</groupId>
Expand Down
33 changes: 19 additions & 14 deletions ...sandra/src/main/java/com/google/cloud/spanner/adapter/metrics/BuiltInMetricsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*/
package com.google.cloud.spanner.adapter.metrics;

import static com.google.cloud.opentelemetry.detection.GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE;
import static com.google.cloud.spanner.adapter.metrics.BuiltInMetricsConstant.CLIENT_HASH_KEY;
import static com.google.cloud.spanner.adapter.metrics.BuiltInMetricsConstant.CLIENT_NAME_KEY;
import static com.google.cloud.spanner.adapter.metrics.BuiltInMetricsConstant.CLIENT_UID_KEY;
Expand All @@ -28,18 +27,17 @@
import static com.google.cloud.spanner.adapter.metrics.BuiltInMetricsConstant.STATUS_KEY;

import com.google.api.gax.core.GaxProperties;
import com.google.cloud.opentelemetry.detection.AttributeKeys;
import com.google.cloud.opentelemetry.detection.DetectedPlatform;
import com.google.cloud.opentelemetry.detection.GCPPlatformDetector;
import com.google.cloud.opentelemetry.metric.GoogleCloudMetricExporter;
import com.google.cloud.opentelemetry.metric.MetricConfiguration;
import com.google.cloud.opentelemetry.metric.MonitoredResourceDescription;
import com.google.common.collect.ImmutableSet;
import com.google.common.hash.HashFunction;
import com.google.common.hash.Hashing;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.contrib.gcp.resource.GCPResourceProvider;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder;
Expand Down Expand Up @@ -92,12 +90,17 @@ public OpenTelemetry getOrCreateOpenTelemetry(String projectId, String instanceI
.setResourceAttributesFilter(MetricConfiguration.NO_RESOURCE_ATTRIBUTES)
.build());

GCPResourceProvider gcpResourceProvider = new GCPResourceProvider();

sdkMeterProviderBuilder
.registerMetricReader(
PeriodicMetricReader.builder(metricExporter)
.setInterval(java.time.Duration.ofSeconds(60))
.build())
.addResource(Resource.create(createResourceAttributes(projectId, instanceId)));
.addResource(
Resource.create(
createResourceAttributes(
projectId, instanceId, gcpResourceProvider.getAttributes())));

// Register built-in metrics.
BuiltInMetricsConstant.getAllViews().forEach(sdkMeterProviderBuilder::registerView);
Expand All @@ -108,14 +111,15 @@ public OpenTelemetry getOrCreateOpenTelemetry(String projectId, String instanceI
return this.openTelemetry;
}

Attributes createResourceAttributes(String projectId, String instanceId) {
Attributes createResourceAttributes(
String projectId, String instanceId, Attributes detectedAttributes) {
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(), instanceId)
.put(LOCATION_ID_KEY.getKey(), detectClientLocation())
.put(LOCATION_ID_KEY.getKey(), detectClientLocation(detectedAttributes))
.put("gcp.resource_type", BuiltInMetricsConstant.SPANNER_RESOURCE_TYPE);
return attributesBuilder.build();
}
Expand Down Expand Up @@ -161,13 +165,14 @@ static String generateClientHash(String clientUid) {
return String.format("%06x", shiftedValue);
}

private static String detectClientLocation() {
GCPPlatformDetector detector = GCPPlatformDetector.DEFAULT_INSTANCE;
DetectedPlatform detectedPlatform = detector.detectPlatform();
// 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_CLUSTER_LOCATION);
private static String detectClientLocation(Attributes detectedResourceAttributes) {
// All platform except GKE uses "cloud.region" for region attribute.
// GKE could either use "cloud.region" or "cloud.availability_zone" for region attribute.
String region = detectedResourceAttributes.get(AttributeKey.stringKey("cloud.region"));
String gkeZonalClusterLocation =
detectedResourceAttributes.get(AttributeKey.stringKey("cloud.availability_zone"));
if (region == null && gkeZonalClusterLocation != null) {
region = gkeZonalClusterLocation;
}
return region == null ? "global" : region;
}
Expand Down
21 changes: 20 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,29 @@
<name>Apache-2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>
</licenses>

<properties>
<jackson.version>2.18.3</jackson.version>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-shared-dependencies</artifactId>
Expand Down
Loading