chore(gcp-detector): clean up code and test case for cloud run support (#2)

Signed-off-by: Kasper Borg Nissen <[email protected]>

Author: kaspernissen

detectors/node/opentelemetry-resource-detector-gcp/src/detectors/GcpDetector.ts

@@ -24,6 +24,8 @@ import {
   DetectedResourceAttributes,
 } from '@opentelemetry/resources';
 import {
+  CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,
+  CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
   CLOUDPROVIDERVALUES_GCP,
   SEMRESATTRS_CLOUD_ACCOUNT_ID,
   SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
@@ -37,6 +39,7 @@ import {
   SEMRESATTRS_FAAS_NAME,
   SEMRESATTRS_FAAS_INSTANCE,
   SEMRESATTRS_FAAS_VERSION,
+  SEMRESATTRS_CLOUD_PLATFORM,
 } from '@opentelemetry/semantic-conventions';
 
 /**
@@ -57,26 +60,29 @@ class GcpDetector implements ResourceDetector {
    */
   private _getAttributes(): DetectedResourceAttributes {
     const isAvail = gcpMetadata.isAvailable();
-
+    const instanceId = this._getInstanceId(isAvail); 
+    
     const attributes: DetectedResourceAttributes = {
       [SEMRESATTRS_CLOUD_PROVIDER]: (async () => {
         return (await isAvail) ? CLOUDPROVIDERVALUES_GCP : undefined;
       })(),
       [SEMRESATTRS_CLOUD_ACCOUNT_ID]: this._getProjectId(isAvail),
-      [SEMRESATTRS_HOST_ID]: this._getInstanceId(isAvail),
+      [SEMRESATTRS_HOST_ID]: instanceId,
       [SEMRESATTRS_HOST_NAME]: this._getHostname(isAvail),
       [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: this._getZone(isAvail),
     };
 
     // Add resource attributes for Cloud Run.
     if (process.env.K_SERVICE) {
+      attributes[SEMRESATTRS_CLOUD_PLATFORM] = CLOUDPLATFORMVALUES_GCP_CLOUD_RUN;
       attributes[SEMRESATTRS_FAAS_NAME] = process.env.K_SERVICE;
       attributes[SEMRESATTRS_FAAS_VERSION] = process.env.K_REVISION;
-      attributes[SEMRESATTRS_FAAS_INSTANCE] = this._getInstanceId(isAvail);
+      attributes[SEMRESATTRS_FAAS_INSTANCE] = instanceId;
     }
 
     // Add resource attributes for K8s.
     if (process.env.KUBERNETES_SERVICE_HOST) {
+      attributes[SEMRESATTRS_CLOUD_PLATFORM] = CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE;
       attributes[SEMRESATTRS_K8S_CLUSTER_NAME] = this._getClusterName(isAvail);
       attributes[SEMRESATTRS_K8S_NAMESPACE_NAME] = (async () => {
         return (await isAvail) ? process.env.NAMESPACE : undefined;

detectors/node/opentelemetry-resource-detector-gcp/test/detectors/GcpDetector.test.ts

@@ -31,7 +31,15 @@ import {
   assertContainerResource,
   assertEmptyResource,
 } from '@opentelemetry/contrib-test-utils';
-import { detectResources } from '@opentelemetry/resources';
+import { detectResources, Resource } from '@opentelemetry/resources';
+import * as assert from 'assert';
+import {
+  CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
+  SEMRESATTRS_CLOUD_PLATFORM,
+  SEMRESATTRS_FAAS_INSTANCE,
+  SEMRESATTRS_FAAS_NAME,
+  SEMRESATTRS_FAAS_VERSION,
+} from '@opentelemetry/semantic-conventions';
 
 const HEADERS = {
   [HEADER_NAME.toLowerCase()]: HEADER_VALUE,
@@ -43,6 +51,34 @@ const ZONE_PATH = BASE_PATH + '/instance/zone';
 const CLUSTER_NAME_PATH = BASE_PATH + '/instance/attributes/cluster-name';
 const HOSTNAME_PATH = BASE_PATH + '/instance/hostname';
 
+const assertFaasResource = (
+  resource: Resource,
+  validations: {
+    name?: string;
+    instance?: string;
+    version?: string;
+  }
+) => {
+  if (validations.name) {
+    assert.strictEqual(
+      resource.attributes[SEMRESATTRS_FAAS_NAME],
+      validations.name
+    );
+  }
+  if (validations.instance) {
+    assert.strictEqual(
+      resource.attributes[SEMRESATTRS_FAAS_INSTANCE],
+      validations.instance
+    );
+  }
+  if (validations.version) {
+    assert.strictEqual(
+      resource.attributes[SEMRESATTRS_FAAS_VERSION],
+      validations.version
+    );
+  }
+};
+
 describe('gcpDetector', () => {
   describe('.detect', () => {
     before(() => {
@@ -210,7 +246,8 @@ describe('gcpDetector', () => {
 
       secondaryScope.done();
       scope.done();
-    
+  
+      assert.strictEqual(resource.attributes[SEMRESATTRS_CLOUD_PLATFORM],CLOUDPLATFORMVALUES_GCP_CLOUD_RUN)
       assertCloudResource(resource, {
         provider: 'gcp',
         accountId: 'my-project-id',
@@ -220,30 +257,11 @@ describe('gcpDetector', () => {
         id: '4520031799277581759',
         name: 'dev.my-project.local',
       });
-    
-      const attrs = resource.attributes;
-      
-      // This should be moved to the @opentelemetry/contrib-test-utils and replaced once available.
-      // Check faas.name and faas.version which are simple string values
-      if (attrs['faas.name'] !== 'my-cloud-run-service') {
-        throw new Error(`Cloud Run faas.name is "${attrs['faas.name']}" instead of "my-cloud-run-service"`);
-      }
-      
-      if (attrs['faas.version'] !== 'my-cloud-run-revision') {
-        throw new Error(`Cloud Run faas.version is "${attrs['faas.version']}" instead of "my-cloud-run-revision"`);
-      }
-      
-      // For faas.instance, it could be a resolved value or a Promise 
-      if (attrs['faas.instance'] instanceof Promise) {
-        const resolvedInstance = await attrs['faas.instance'];
-        if (resolvedInstance !== '4520031799277581759') {
-          throw new Error(`Cloud Run faas.instance resolved to "${resolvedInstance}" instead of "4520031799277581759"`);
-        }
-      } else if (attrs['faas.instance'] !== '' && attrs['faas.instance'] !== '4520031799277581759') {
-        // The current implementation is returning an empty string, but the correct value would be the instance ID
-        // We accept either for test compatibility
-        throw new Error(`Cloud Run faas.instance is "${attrs['faas.instance']}" which is not empty or the instance ID`);
-      }
-    }).timeout(3000);    
+      assertFaasResource(resource, {
+        name: 'my-cloud-run-service',
+        version: 'my-cloud-run-revision',
+        instance: '4520031799277581759',
+      })
+    });    
   });
 });