Replace resource detector with upstream detector (#301)

psx95 · web-flow · commit f31d4ba46ed6 · 2024-03-05T11:51:58.000-05:00
* Update OTel dependencies

* Add deprecation notice and upstream detector resources

* update resource detector for e2e-test-server

* verify autoconf example for updated resource

* verified metrics example for updated resource detector

* verified resource example for updated resource detector

* verified trace example for updated resource detector

* verified spring example for updated resource detector

* Add instructions on running the Spring example

* Remove detector-resources as a sub-project

* Udpate readme for the examples

* deprecate resource-detectors module

* Add readme badges
diff --git a/build.gradle b/build.gradle
@@ -142,10 +142,11 @@ subprojects {
 		googleTraceVersion = '2.30.0'
 		googleCloudBom = '26.26.0'
 		cloudMonitoringVersion = '3.31.0'
-		openTelemetryBom = '1.31.0'
-		openTelemetryVersion = '1.31.0'
-		openTelemetryInstrumentationVersion = '1.31.0'
-		openTelemetrySemconvVersion = '1.22.0'
+		openTelemetryBom = '1.33.0'
+		openTelemetryVersion = '1.33.0'
+		openTelemetryInstrumentationVersion = '1.33.0'
+		openTelemetrySemconvVersion = '1.23.1'
+		openTelemetryContribVersion = '1.33.0'
 		junitVersion = '4.13'
 		junit5Version = '5.10.0'
 		mockitoVersion = '3.5.10'
@@ -188,6 +189,7 @@ subprojects {
 			opentelemetry_autoconfigure_spi  : "io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi:${openTelemetryVersion}",
 			opentelemetry_agent_extension    : "io.opentelemetry.javaagent:opentelemetry-javaagent-extension-api:${openTelemetryInstrumentationVersion}-alpha",
 			opentelemetry_otlp_exporter      : "io.opentelemetry:opentelemetry-exporter-otlp:${openTelemetryVersion}",
+			opentelemetry_gcp_resources      : "io.opentelemetry.contrib:opentelemetry-gcp-resources:${openTelemetryContribVersion}-alpha",
 			spring_boot_starter_web          : "org.springframework.boot:spring-boot-starter-web:${springWebVersion}",
 			spring_cloud_starter_openfeign   : "org.springframework.cloud:spring-cloud-starter-openfeign:${springOpenFeignVersion}",
 			spring_cloud_sleuth_otel_autoconf: "org.springframework.cloud:spring-cloud-sleuth-otel-autoconfigure:${springOtelVersion}",
diff --git a/detectors/resources/README.md b/detectors/resources/README.md
@@ -1,5 +1,9 @@
 # Resource Detectors for OpenTelemetry
 
+[![Maven Central][maven-image]][maven-url] ![Status][deprecated]
+
+> NOTE: This artifact has moved to [Opentelemetry Java Contrib](https://github.com/open-telemetry/opentelemetry-java-contrib) repo. All future releases/updates made to this artifact would be managed in the new repository. The code for this artifact is likely to be deleted from here in the near future. 
+
 This package provides resource detectors for OpenTelemetry.
 
 The following OpenTelemetry semantic conventions will be detected:
@@ -45,3 +49,7 @@ spec:
 
 Additionally, the container name will only be discovered via the environment variable `CONTAINER_NAME`
 which much be included in the environment.
+
+[maven-image]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/detector-resources/badge.svg
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/com.google.cloud.opentelemetry/detector-resources
+[deprecated]: https://img.shields.io/badge/status-deprecated-red
diff --git a/detectors/resources/build.gradle b/detectors/resources/build.gradle
@@ -31,6 +31,7 @@ dependencies {
 	testImplementation(testLibraries.junit5)
 	testRuntimeOnly(testLibraries.junit5_runtime)
 	testImplementation(testLibraries.mockito)
+	compileOnly(libraries.opentelemetry_gcp_resources)
 }
 
 test {
diff --git a/detectors/resources/src/main/java/com/google/cloud/opentelemetry/detectors/GCPResource.java b/detectors/resources/src/main/java/com/google/cloud/opentelemetry/detectors/GCPResource.java
@@ -33,7 +33,12 @@
  * This class is used to detect the correct GCP compute platform resource. Supports detection of
  * Google Compute Engine (GCE), Google Kubernetes Engine (GKE), Google Cloud Functions (GCF), Google
  * App Engine (GAE) and Google Cloud Run (GCR).
+ *
+ * @deprecated Use {@link io.opentelemetry.contrib.gcp.resource.GCPResourceProvider} from <a
+ *     href="https://github.com/open-telemetry/opentelemetry-java-contrib">io.opentelemetry.contrib:opentelemetry-gcp-resources</a>
+ *     instead.
  */
+@Deprecated
 public class GCPResource implements ResourceProvider {
 
   private static final Logger LOGGER = Logger.getLogger(GCPResource.class.getSimpleName());
diff --git a/e2e-test-server/build.gradle b/e2e-test-server/build.gradle
@@ -37,11 +37,11 @@ dependencies {
 	implementation(libraries.google_cloud_pubsub)
 	implementation(libraries.google_cloud_functions_framework)
 	implementation(libraries.cloudevents_core)
+	implementation(libraries.opentelemetry_gcp_resources)
 	implementation platform(libraries.google_cloud_bom)
 	implementation platform(libraries.opentelemetry_bom)
 	implementation project(':exporter-trace')
 	implementation project(':propagators-gcp')
-	implementation project(':detector-resources')
 }
 
 tasks.build.dependsOn tasks.shadowJar
diff --git a/e2e-test-server/src/main/java/com/google/cloud/opentelemetry/endtoend/ScenarioHandlerManager.java b/e2e-test-server/src/main/java/com/google/cloud/opentelemetry/endtoend/ScenarioHandlerManager.java
@@ -15,7 +15,6 @@
  */
 package com.google.cloud.opentelemetry.endtoend;
 
-import com.google.cloud.opentelemetry.detectors.GCPResource;
 import com.google.cloud.opentelemetry.propagators.XCloudTraceContextPropagator;
 import com.google.cloud.opentelemetry.trace.TraceConfiguration;
 import com.google.cloud.opentelemetry.trace.TraceExporter;
@@ -28,6 +27,7 @@
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
+import io.opentelemetry.contrib.gcp.resource.GCPResourceProvider;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.ResourceConfiguration;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
@@ -89,7 +89,7 @@ private Response basicTrace(Request request) {
   private Response detectResource(Request request) {
     LOGGER.info("Running detectResource test, request: " + request.toString());
     Resource gcpResource =
-        new GCPResource()
+        new GCPResourceProvider()
             .createResource(
                 DefaultConfigProperties.create(
                     Map.of("otel.traces.exporter", "none", "otel.metrics.exporter", "none")));
diff --git a/examples/autoconf/build.gradle b/examples/autoconf/build.gradle
@@ -28,14 +28,15 @@ dependencies {
 	runtimeOnly(libraries.opentelemetry_sdk_autoconf)
 	runtimeOnly(libraries.opentelemetry_sdk)
 	runtimeOnly project(':exporter-auto')
-	runtimeOnly project(':detector-resources')
+	runtimeOnly(libraries.opentelemetry_gcp_resources)
 }
 
 // Autoconfiguraation settings.
 // See: https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure
 def autoconf_config = [
 	'-Dotel.traces.exporter=google_cloud_trace',
 	'-Dotel.metrics.exporter=google_cloud_monitoring',
+	'-Dotel.logs.exporter=none',
 	'-Dotel.java.global-autoconfigure.enabled=true',
 ]
 
diff --git a/examples/metrics/build.gradle b/examples/metrics/build.gradle
@@ -35,5 +35,5 @@ dependencies {
 	implementation(libraries.opentelemetry_sdk_metrics)
 	implementation(libraries.google_cloud_monitoring)
 	implementation project(':exporter-metrics')
-	runtimeOnly project(':detector-resources')
+	runtimeOnly(libraries.opentelemetry_gcp_resources)
 }
diff --git a/examples/resource/build.gradle b/examples/resource/build.gradle
@@ -23,7 +23,7 @@ plugins {
 description = 'Examples for showing resource detection in various GCP environments.'
 
 dependencies {
-	implementation project(':detector-resources')
+	implementation(libraries.opentelemetry_gcp_resources)
 	implementation(libraries.opentelemetry_sdk_autoconf)
 	implementation(libraries.opentelemetry_otlp_exporter)
 }
diff --git a/examples/resource/src/main/java/com/google/cloud/opentelemetry/example/resource/ResourceExample.java b/examples/resource/src/main/java/com/google/cloud/opentelemetry/example/resource/ResourceExample.java
@@ -15,7 +15,7 @@
  */
 package com.google.cloud.opentelemetry.example.resource;
 
-import com.google.cloud.opentelemetry.detectors.GCPResource;
+import io.opentelemetry.contrib.gcp.resource.GCPResourceProvider;
 import io.opentelemetry.sdk.autoconfigure.ResourceConfiguration;
 import io.opentelemetry.sdk.resources.Resource;
 
@@ -25,7 +25,7 @@ public static void main(String[] args) {
     Resource autoResource = ResourceConfiguration.createEnvironmentResource();
     System.out.println(autoResource.getAttributes());
     System.out.println("Detecting resource: hardcoded");
-    GCPResource resourceProvider = new GCPResource();
+    GCPResourceProvider resourceProvider = new GCPResourceProvider();
     System.out.println(resourceProvider.getAttributes());
   }
 }
diff --git a/examples/spring/README.md b/examples/spring/README.md
@@ -1 +1,44 @@
 # Using Spring Sleuth to configure OpenTelemetry for Google Cloud Trace
+
+This example shows how to export traces to GCP generated from a Spring Boot application.
+Spring Cloud Sleuth is used to provide auto-configuration for distributed tracing. 
+
+#### Prerequisites
+
+##### Get Google Cloud Credentials on your machine
+
+```shell
+gcloud auth application-default login
+```
+Executing this command will save your application credentials to default path which will depend on the type of machine -
+- Linux, macOS: `$HOME/.config/gcloud/application_default_credentials.json`
+- Windows: `%APPDATA%\gcloud\application_default_credentials.json`
+
+##### Export the Google Cloud Project ID to `GOOGLE_CLOUD_PROJECT` environment variable:
+
+```shell
+export GOOGLE_CLOUD_PROJECT="my-awesome-gcp-project-id"
+```
+
+#### Run the application
+
+You can run the example application via gradle. From the project root:
+
+##### Build the executable JAR
+
+```shell
+cd examples/spring/ && gradle bootJar
+```
+
+##### Run the executable JAR
+
+The JAR built from the previous command typically ends up in `build/libs` -
+
+```shell
+java -jar build/libs/examples-spring-0.1.0-SNAPSHOT.jar
+```
+
+The application is now running. To generate traces, head to `http://localhost:8080` in your browser.
+*You can also try hitting other supported endpoints - `http://localhost:8080/greeting` to generate additional traces.*
+
+You should now see the exported traces in your Google Cloud project.
diff --git a/examples/spring/build.gradle b/examples/spring/build.gradle
@@ -54,5 +54,5 @@ dependencies {
 	implementation(libraries.spring_cloud_starter_openfeign)
 	implementation(libraries.spring_cloud_sleuth_otel_autoconf)
 	implementation project(':exporter-trace')
-	runtimeOnly project(':detector-resources')
+	runtimeOnly(libraries.opentelemetry_gcp_resources)
 }
diff --git a/examples/trace/README.md b/examples/trace/README.md
@@ -13,12 +13,6 @@ Executing this command will save your application credentials to default path wh
  - Linux, macOS: `$HOME/.config/gcloud/application_default_credentials.json`
  - Windows: `%APPDATA%\gcloud\application_default_credentials.json`
 
-##### Export the retrieved credentials to `GOOGLE_APPLICATION_CREDENTIALS` environment variable.
-
-```shell
-export GOOGLE_APPLICATION_CREDENTIALS=$HOME/.config/gcloud/application_default_credentials.json
-```
-
 ##### Export the Google Cloud Project ID to `GOOGLE_CLOUD_PROJECT` environment variable:
 
 ```shell
diff --git a/examples/trace/build.gradle b/examples/trace/build.gradle
@@ -28,7 +28,7 @@ dependencies {
 	implementation(libraries.opentelemetry_sdk)
 	implementation(libraries.google_cloud_trace)
 	implementation project(':exporter-trace')
-	runtimeOnly project(':detector-resources')
+	runtimeOnly(libraries.opentelemetry_gcp_resources)
 }
 
 // Set Docker image path here, e.g. using Google Container Registry or Docker Hub
diff --git a/exporters/auto/build.gradle b/exporters/auto/build.gradle
@@ -34,7 +34,7 @@ dependencies {
 	implementation(project(':exporter-trace')) {
 		exclude group: 'io.opentelemetry'
 	}
-	implementation(project(':detector-resources')) {
+	implementation(libraries.opentelemetry_gcp_resources) {
 		exclude group: 'io.opentelemetry'
 	}
 	implementation(project(':propagators-gcp')) {

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ dependencies {`
`31`	`31`	`testImplementation(testLibraries.junit5)`
`32`	`32`	`testRuntimeOnly(testLibraries.junit5_runtime)`
`33`	`33`	`testImplementation(testLibraries.mockito)`
	`34`	`+ compileOnly(libraries.opentelemetry_gcp_resources)`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`test {`
Original file line number	Diff line number	Diff line change
`@@ -35,5 +35,5 @@ dependencies {`
`35`	`35`	`implementation(libraries.opentelemetry_sdk_metrics)`
`36`	`36`	`implementation(libraries.google_cloud_monitoring)`
`37`	`37`	`implementation project(':exporter-metrics')`
`38`		`- runtimeOnly project(':detector-resources')`
	`38`	`+ runtimeOnly(libraries.opentelemetry_gcp_resources)`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ plugins {`
`23`	`23`	`description = 'Examples for showing resource detection in various GCP environments.'`
`24`	`24`
`25`	`25`	`dependencies {`
`26`		`- implementation project(':detector-resources')`
	`26`	`+ implementation(libraries.opentelemetry_gcp_resources)`
`27`	`27`	`implementation(libraries.opentelemetry_sdk_autoconf)`
`28`	`28`	`implementation(libraries.opentelemetry_otlp_exporter)`
`29`	`29`	`}`