Update auto-instrumentation sample (#397)

* Use OTLP for trace export

* Fix otlp auth in cloud-run

* Fix k8s deployment for sample

* Update Cloud Run deployment to use no-throttling

* Update examples/autoinstrument/deployment.yaml

Co-authored-by: David Ashpole <[email protected]>

---------

Co-authored-by: David Ashpole <[email protected]>

Author: psx95

examples/autoinstrument/README.md

@@ -32,15 +32,18 @@ export GOOGLE_CLOUD_PROJECT="my-awesome-gcp-project-id"
 
 To spin it up on your own GKE cluster, run the following:
 ```bash
-./gradlew :examples-autoinstrument:jib --image="gcr.io/$GOOGLE_CLOUD_PROJECT/hello-autoinstrument-java"
+# Create an artifact repository to upload the containerized application image.
+# Skip this step if you wish to re-use an existing artifact repository.
+gcloud artifacts repositories create opentelemetry-sample-apps --repository-format=docker --location=us-central1 --description="OpenTelemetry auto-instrumentation sample applications"
+
+./gradlew :examples-autoinstrument:jib --image="us-central1-docker.pkg.dev/${GOOGLE_CLOUD_PROJECT}/opentelemetry-sample-apps/hello-autoinstrument-java"
 
 sed s/%GOOGLE_CLOUD_PROJECT%/$GOOGLE_CLOUD_PROJECT/g \
  examples/autoinstrument/deployment.yaml | kubectl apply -f -
 
 kubectl expose deployment  hello-autoinstrument-java --type LoadBalancer --port 80 --target-port 8080
 ```
 
-
 This will expose the simple http server at port 80.   You can try out the tracing instrumentation via:
 
 ```bash
@@ -53,6 +56,9 @@ Or, if you'd like to synthesize a parent trace:
 curl -H "traceparent:  00-ff000000000000000000000000000041-ff00000000000041-01" ${cluster_ip}
 ```
 
+> ![IMPORTANT]
+> Make sure that your cluster has the necessary permissions to write metrics and traces to your selected project.
+
 ## Running in Google Cloud Run
 
 To run this example in Google Cloud Run, you need to run the convenience script provided. After following the prerequisites, 

examples/autoinstrument/build.gradle

@@ -29,11 +29,13 @@ configurations {
 	agent
 }
 
-mainClassName = 'com.google.example.TestMain'
+// the shaded variant name for gcp auth extension is an empty string
+def gcp_auth_extension_shaded_classifier = ''
 
 dependencies {
 	agent agentLibraries.agent
 	agent project(path: ':exporter-auto', configuration: 'shadow')
+	agent "${libraries.opentelemetry_gcp_auth_extension}:${gcp_auth_extension_shaded_classifier}"
 
 	implementation(libraries.spring_boot_starter_web)
 	implementation(libraries.spring_cloud_starter_openfeign)
@@ -46,7 +48,8 @@ task copyAgent(type: Copy) {
 	into layout.buildDirectory.dir("otelagent")
 	from configurations.agent {
 		rename "opentelemetry-javaagent(.*).jar", "otel_agent.jar"
-		rename "exporter-auto(.*).jar", "gcp_ext.jar"
+		rename "exporter-auto(.*).jar", "gcp_exporter_ext.jar"
+		rename "opentelemetry-gcp-auth-extension(.*).jar", "gcp_auth_ext.jar"
 	}
 }
 
@@ -67,15 +70,24 @@ jib {
 		// Use the downloaded java agent.
 		'-javaagent:/otelagent/otel_agent.jar',
 		// Use the GCP exporter extensions.
-		'-Dotel.javaagent.extensions=/otelagent/gcp_ext.jar',
+		'-Dotel.javaagent.extensions=/otelagent/gcp_exporter_ext.jar,/otelagent/gcp_auth_ext.jar',
 		// Configure auto instrumentation.
-		'-Dotel.traces.exporter=google_cloud_trace',
+		// Configure traces to be exported via OTLP exporters
+		'-Dotel.traces.exporter=otlp',
+		'-Dotel.exporter.otlp.endpoint=https://telemetry.googleapis.com',
+		'-Dotel.exporter.otlp.traces.protocol=http/protobuf',
+		// Configure metrics to be exported via Google cloud exporters
 		'-Dotel.metrics.exporter=google_cloud_monitoring',
 		'-Dotel.logs.exporter=none',
+		'-Dotel.service.name=gcp-autoinstrument-spring-demo',
 		'-Dotel.resource.providers.gcp.enabled=true'
 	]
 }
 
+application {
+	mainClassName = 'com.google.example.TestMain'
+}
+
 tasks.named('jib').configure {
 	dependsOn copyAgent
 }

examples/autoinstrument/deployment.yaml

@@ -29,14 +29,20 @@ spec:
     spec:
       containers:
         - name: hello-autoinstrument-java
-          image: gcr.io/%GOOGLE_CLOUD_PROJECT%/hello-autoinstrument-java:latest
+          image: us-central1-docker.pkg.dev/%GOOGLE_CLOUD_PROJECT%/opentelemetry-sample-apps/hello-autoinstrument-java:latest
           # required for resource detection in GKE environment
           env:
-            - name: NAMESPACE
+            - name: GOOGLE_CLOUD_PROJECT
+              value: %GOOGLE_CLOUD_PROJECT%
+            - name: POD_NAME
               valueFrom:
                 fieldRef:
-                  fieldPath: metadata.namespace
-            - name: CONTAINER_NAME
+                  fieldPath: metadata.name
+            - name: NAMESPACE_NAME
               valueFrom:
                 fieldRef:
-                  fieldPath: metadata.name
+                  fieldPath: metadata.namespace
+            - name: CONTAINER_NAME
+              value: hello-autoinstrument-java
+            - name: OTEL_RESOURCE_ATTRIBUTES
+              value: k8s.pod.name=$(POD_NAME),k8s.namespace.name=$(NAMESPACE_NAME),k8s.container.name=$(CONTAINER_NAME)

examples/autoinstrument/run_in_cloud-run.sh

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-CONTAINER_REGISTRY=cloud-run-applications
+CONTAINER_REGISTRY=opentelemetry-sample-apps
 REGISTRY_LOCATION=us-central1
 IMAGE_NAME="${REGISTRY_LOCATION}-docker.pkg.dev/${GOOGLE_CLOUD_PROJECT}/${CONTAINER_REGISTRY}/hello-autoinstrument-java"
 
@@ -36,13 +36,17 @@ fi
 echo "ENVIRONMENT VARIABLES VERIFIED"
 
 echo "CREATING CLOUD ARTIFACT REPOSITORY"
-gcloud artifacts repositories create ${CONTAINER_REGISTRY} --repository-format=docker --location=${REGISTRY_LOCATION} --description="Sample applications to run on Google Cloud Run"
+gcloud artifacts repositories create ${CONTAINER_REGISTRY} --repository-format=docker --location=${REGISTRY_LOCATION} --description="OpenTelemetry auto-instrumentation sample applications"
 echo "CREATED ${CONTAINER_REGISTRY} in ${REGISTRY_LOCATION}"
 
 echo "BUILDING SAMPLE APP IMAGE"
 gradle clean jib --image "${IMAGE_NAME}"
 
 echo "RUNNING SAMPLE APP ON PORT 8080"
+# We use --no-cpu-throttling for the sample to ensure that traces can be exported in the background.
+# See https://cloud.google.com/sdk/gcloud/reference/run/deploy#--[no-]cpu-throttling for details.
 gcloud run deploy hello-autoinstrument-cloud-run \
+        --set-env-vars="GOOGLE_CLOUD_PROJECT=${GOOGLE_CLOUD_PROJECT}" \
         --image="${IMAGE_NAME}" \
-        --region="${GOOGLE_CLOUD_RUN_REGION}"
+        --region="${GOOGLE_CLOUD_RUN_REGION}" \
+        --no-cpu-throttling