@opentelemetry/resource-detector-gcp 0.39.0 → 0.40.0

package/build/esm/detectors/gce.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2022 Google LLC
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gce.go
+ */
+import { diag } from '@opentelemetry/api';
+import * as metadata from 'gcp-metadata';
+const MACHINE_TYPE_METADATA_ATTR = 'machine-type';
+const ID_METADATA_ATTR = 'id';
+const HOST_NAME_METADATA_ATTR = 'name';
+const ZONE_METADATA_ATTR = 'zone';
+export async function onGce() {
+    try {
+        await metadata.instance(MACHINE_TYPE_METADATA_ATTR);
+        return true;
+    }
+    catch (err) {
+        diag.debug('Could not fetch metadata attribute %s, assuming not on GCE. Error was %s', MACHINE_TYPE_METADATA_ATTR, err);
+        return false;
+    }
+}
+/**
+ * The machine type of the instance on which this program is running. Check that {@link
+ * onGce()} is true before calling this, or it may throw exceptions.
+ */
+export async function hostType() {
+    return metadata.instance(MACHINE_TYPE_METADATA_ATTR);
+}
+/**
+ * The instance ID of the instance on which this program is running. Check that {@link onGce()}
+ * is true before calling this, or it may throw exceptions.
+ */
+export async function hostId() {
+    // May be a bignumber.js BigNumber which can just be converted with toString(). See
+    // https://github.com/googleapis/gcp-metadata#take-care-with-large-number-valued-properties
+    const id = await metadata.instance(ID_METADATA_ATTR);
+    return id.toString();
+}
+/**
+ * The instance ID of the instance on which this program is running. Check that {@link onGce()}
+ * is true before calling this, or it may throw exceptions.
+ */
+export async function hostName() {
+    return metadata.instance(HOST_NAME_METADATA_ATTR);
+}
+/**
+ * The zone and region in which this program is running. Check that {@link onGce()} is true
+ * before calling this, or it may throw exceptions.
+ */
+export async function availabilityZoneAndRegion() {
+    const fullZone = await metadata.instance(ZONE_METADATA_ATTR);
+    // Format described in
+    // https://cloud.google.com/compute/docs/metadata/default-metadata-values#vm_instance_metadata
+    const re = /projects\/\d+\/zones\/(?<zone>(?<region>\w+-\w+)-\w+)/;
+    const { zone, region } = fullZone.match(re)?.groups ?? {};
+    if (!zone || !region) {
+        throw new Error(`zone was not in the expected format: projects/PROJECT_NUM/zones/COUNTRY-REGION-ZONE. Got ${fullZone}`);
+    }
+    return { zone, region };
+}
+//# sourceMappingURL=gce.js.map

package/build/esm/detectors/gce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gce.js","sourceRoot":"","sources":["../../../src/detectors/gce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,cAAc,CAAC;AAEzC,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,uBAAuB,GAAG,MAAM,CAAC;AACvC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAElC,MAAM,CAAC,KAAK,UAAU,KAAK;IACzB,IAAI;QACF,MAAM,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;KACb;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,CAAC,KAAK,CACR,0EAA0E,EAC1E,0BAA0B,EAC1B,GAAG,CACJ,CAAC;QACF,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,OAAO,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,mFAAmF;IACnF,2FAA2F;IAC3F,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAkB,gBAAgB,CAAC,CAAC;IACtE,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,OAAO,QAAQ,CAAC,QAAQ,CAAS,uBAAuB,CAAC,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB;IAI7C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAS,kBAAkB,CAAC,CAAC;IAErE,sBAAsB;IACtB,8FAA8F;IAC9F,MAAM,EAAE,GAAG,uDAAuD,CAAC;IACnE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;IAC1D,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;QACpB,MAAM,IAAI,KAAK,CACb,4FAA4F,QAAQ,EAAE,CACvG,CAAC;KACH;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1B,CAAC","sourcesContent":["/*\n * Copyright 2022 Google LLC\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Implementation in this file copied from\n * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gce.go\n */\n\nimport { diag } from '@opentelemetry/api';\nimport * as metadata from 'gcp-metadata';\n\nconst MACHINE_TYPE_METADATA_ATTR = 'machine-type';\nconst ID_METADATA_ATTR = 'id';\nconst HOST_NAME_METADATA_ATTR = 'name';\nconst ZONE_METADATA_ATTR = 'zone';\n\nexport async function onGce(): Promise<boolean> {\n  try {\n    await metadata.instance<string>(MACHINE_TYPE_METADATA_ATTR);\n    return true;\n  } catch (err) {\n    diag.debug(\n      'Could not fetch metadata attribute %s, assuming not on GCE. Error was %s',\n      MACHINE_TYPE_METADATA_ATTR,\n      err\n    );\n    return false;\n  }\n}\n\n/**\n * The machine type of the instance on which this program is running. Check that {@link\n * onGce()} is true before calling this, or it may throw exceptions.\n */\nexport async function hostType(): Promise<string> {\n  return metadata.instance<string>(MACHINE_TYPE_METADATA_ATTR);\n}\n\n/**\n * The instance ID of the instance on which this program is running. Check that {@link onGce()}\n * is true before calling this, or it may throw exceptions.\n */\nexport async function hostId(): Promise<string> {\n  // May be a bignumber.js BigNumber which can just be converted with toString(). See\n  // https://github.com/googleapis/gcp-metadata#take-care-with-large-number-valued-properties\n  const id = await metadata.instance<number | object>(ID_METADATA_ATTR);\n  return id.toString();\n}\n\n/**\n * The instance ID of the instance on which this program is running. Check that {@link onGce()}\n * is true before calling this, or it may throw exceptions.\n */\nexport async function hostName(): Promise<string> {\n  return metadata.instance<string>(HOST_NAME_METADATA_ATTR);\n}\n\n/**\n * The zone and region in which this program is running. Check that {@link onGce()} is true\n * before calling this, or it may throw exceptions.\n */\nexport async function availabilityZoneAndRegion(): Promise<{\n  zone: string;\n  region: string;\n}> {\n  const fullZone = await metadata.instance<string>(ZONE_METADATA_ATTR);\n\n  // Format described in\n  // https://cloud.google.com/compute/docs/metadata/default-metadata-values#vm_instance_metadata\n  const re = /projects\\/\\d+\\/zones\\/(?<zone>(?<region>\\w+-\\w+)-\\w+)/;\n  const { zone, region } = fullZone.match(re)?.groups ?? {};\n  if (!zone || !region) {\n    throw new Error(\n      `zone was not in the expected format: projects/PROJECT_NUM/zones/COUNTRY-REGION-ZONE. Got ${fullZone}`\n    );\n  }\n\n  return { zone, region };\n}\n"]}

package/build/esm/detectors/gke.d.ts

@@ -0,0 +1,20 @@
+export declare function onGke(): Promise<boolean>;
+/**
+ * The instance ID of the instance on which this program is running. Check that {@link onGke()}
+ * is true before calling this, or it may throw exceptions.
+ */
+export declare function hostId(): Promise<string>;
+/**
+ * The name of the GKE cluster in which this program is running. Check that {@link onGke()} is
+ * true before calling this, or it may throw exceptions.
+ */
+export declare function clusterName(): Promise<string>;
+/**
+ * The location of the cluster and whether the cluster is zonal or regional. Check that {@link
+ * onGke()} is true before calling this, or it may throw exceptions.
+ */
+export declare function availabilityZoneOrRegion(): Promise<{
+    type: 'zone' | 'region';
+    value: string;
+}>;
+//# sourceMappingURL=gke.d.ts.map

package/build/esm/detectors/gke.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2022 Google LLC
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gke.go
+ */
+import * as metadata from 'gcp-metadata';
+import * as gce from './gce';
+const KUBERNETES_SERVICE_HOST_ENV = 'KUBERNETES_SERVICE_HOST';
+const CLUSTER_NAME_METADATA_ATTR = 'attributes/cluster-name';
+const CLUSTER_LOCATION_METADATA_ATTR = 'attributes/cluster-location';
+export async function onGke() {
+    return process.env[KUBERNETES_SERVICE_HOST_ENV] !== undefined;
+}
+/**
+ * The instance ID of the instance on which this program is running. Check that {@link onGke()}
+ * is true before calling this, or it may throw exceptions.
+ */
+export async function hostId() {
+    return await gce.hostId();
+}
+/**
+ * The name of the GKE cluster in which this program is running. Check that {@link onGke()} is
+ * true before calling this, or it may throw exceptions.
+ */
+export async function clusterName() {
+    return metadata.instance(CLUSTER_NAME_METADATA_ATTR);
+}
+/**
+ * The location of the cluster and whether the cluster is zonal or regional. Check that {@link
+ * onGke()} is true before calling this, or it may throw exceptions.
+ */
+export async function availabilityZoneOrRegion() {
+    const clusterLocation = await metadata.instance(CLUSTER_LOCATION_METADATA_ATTR);
+    switch (countChar(clusterLocation, '-')) {
+        case 1:
+            return { type: 'region', value: clusterLocation };
+        case 2:
+            return { type: 'zone', value: clusterLocation };
+        default:
+            throw new Error(`unrecognized format for cluster location: ${clusterLocation}`);
+    }
+}
+function countChar(s, char) {
+    let count = 0;
+    for (let i = 0; i < s.length; i++) {
+        if (s[i] === char) {
+            count += 1;
+        }
+    }
+    return count;
+}
+//# sourceMappingURL=gke.js.map

package/build/esm/detectors/gke.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gke.js","sourceRoot":"","sources":["../../../src/detectors/gke.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH;;;GAGG;AAEH,OAAO,KAAK,QAAQ,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AAC9D,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAC7D,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;AAErE,MAAM,CAAC,KAAK,UAAU,KAAK;IACzB,OAAO,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,KAAK,SAAS,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,OAAO,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW;IAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB;IAI5C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAC7C,8BAA8B,CAC/B,CAAC;IACF,QAAQ,SAAS,CAAC,eAAe,EAAE,GAAG,CAAC,EAAE;QACvC,KAAK,CAAC;YACJ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;QACpD,KAAK,CAAC;YACJ,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;QAClD;YACE,MAAM,IAAI,KAAK,CACb,6CAA6C,eAAe,EAAE,CAC/D,CAAC;KACL;AACH,CAAC;AAED,SAAS,SAAS,CAAC,CAAS,EAAE,IAAY;IACxC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACjC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;YACjB,KAAK,IAAI,CAAC,CAAC;SACZ;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*\n * Copyright 2022 Google LLC\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Implementation in this file copied from\n * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gke.go\n */\n\nimport * as metadata from 'gcp-metadata';\nimport * as gce from './gce';\n\nconst KUBERNETES_SERVICE_HOST_ENV = 'KUBERNETES_SERVICE_HOST';\nconst CLUSTER_NAME_METADATA_ATTR = 'attributes/cluster-name';\nconst CLUSTER_LOCATION_METADATA_ATTR = 'attributes/cluster-location';\n\nexport async function onGke(): Promise<boolean> {\n  return process.env[KUBERNETES_SERVICE_HOST_ENV] !== undefined;\n}\n\n/**\n * The instance ID of the instance on which this program is running. Check that {@link onGke()}\n * is true before calling this, or it may throw exceptions.\n */\nexport async function hostId(): Promise<string> {\n  return await gce.hostId();\n}\n\n/**\n * The name of the GKE cluster in which this program is running. Check that {@link onGke()} is\n * true before calling this, or it may throw exceptions.\n */\nexport async function clusterName(): Promise<string> {\n  return metadata.instance<string>(CLUSTER_NAME_METADATA_ATTR);\n}\n\n/**\n * The location of the cluster and whether the cluster is zonal or regional. Check that {@link\n * onGke()} is true before calling this, or it may throw exceptions.\n */\nexport async function availabilityZoneOrRegion(): Promise<{\n  type: 'zone' | 'region';\n  value: string;\n}> {\n  const clusterLocation = await metadata.instance<string>(\n    CLUSTER_LOCATION_METADATA_ATTR\n  );\n  switch (countChar(clusterLocation, '-')) {\n    case 1:\n      return { type: 'region', value: clusterLocation };\n    case 2:\n      return { type: 'zone', value: clusterLocation };\n    default:\n      throw new Error(\n        `unrecognized format for cluster location: ${clusterLocation}`\n      );\n  }\n}\n\nfunction countChar(s: string, char: string): number {\n  let count = 0;\n  for (let i = 0; i < s.length; i++) {\n    if (s[i] === char) {\n      count += 1;\n    }\n  }\n  return count;\n}\n"]}

package/build/src/detectors/GcpDetector.d.ts

@@ -1,26 +1,11 @@
-import { ResourceDetectionConfig, ResourceDetector, DetectedResource } from '@opentelemetry/resources';
+import { DetectedResource, ResourceDetector } from '@opentelemetry/resources';
 /**
- * The GcpDetector can be used to detect if a process is running in the Google
- * Cloud Platform and return a {@link Resource} populated with metadata about
- * the instance. Returns an empty Resource if detection fails.
+ * Google Cloud resource detector which populates attributes based on the environment this
+ * process is running in. If not on GCP, returns an empty resource.
  */
-declare class GcpDetector implements ResourceDetector {
-    detect(_config?: ResourceDetectionConfig): DetectedResource;
-    /**
-     * Asynchronously gather GCP cloud metadata.
-     */
-    private _getAttributes;
-    /** Gets project id from GCP project metadata. */
-    private _getProjectId;
-    /** Gets instance id from GCP instance metadata. */
-    private _getInstanceId;
-    /** Gets zone from GCP instance metadata. */
-    private _getZone;
-    /** Gets cluster name from GCP instance metadata. */
-    private _getClusterName;
-    /** Gets hostname from GCP instance metadata. */
-    private _getHostname;
+export declare class GcpDetector implements ResourceDetector {
+    private _asyncAttributes;
+    detect(): DetectedResource;
 }
 export declare const gcpDetector: GcpDetector;
-export {};
 //# sourceMappingURL=GcpDetector.d.ts.map

package/build/src/detectors/GcpDetector.js

@@ -1,5 +1,6 @@
 "use strict";
 /*
+ * Copyright 2022 Google LLC
  * Copyright The OpenTelemetry Authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,115 +16,166 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gcpDetector = void 0;
-const gcpMetadata = require("gcp-metadata");
+exports.gcpDetector = exports.GcpDetector = void 0;
 const api_1 = require("@opentelemetry/api");
 const core_1 = require("@opentelemetry/core");
 const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
-/**
- * The GcpDetector can be used to detect if a process is running in the Google
- * Cloud Platform and return a {@link Resource} populated with metadata about
- * the instance. Returns an empty Resource if detection fails.
- */
-class GcpDetector {
-    detect(_config) {
-        const attributes = api_1.context.with((0, core_1.suppressTracing)(api_1.context.active()), () => this._getAttributes());
-        return { attributes };
+const resources_1 = require("@opentelemetry/resources");
+const metadata = require("gcp-metadata");
+const faas = require("./faas");
+const gae = require("./gae");
+const gce = require("./gce");
+const gke = require("./gke");
+const ATTRIBUTE_NAMES = [
+    semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM,
+    semantic_conventions_1.SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
+    semantic_conventions_1.SEMRESATTRS_CLOUD_REGION,
+    semantic_conventions_1.SEMRESATTRS_K8S_CLUSTER_NAME,
+    semantic_conventions_1.SEMRESATTRS_HOST_TYPE,
+    semantic_conventions_1.SEMRESATTRS_HOST_ID,
+    semantic_conventions_1.SEMRESATTRS_HOST_NAME,
+    semantic_conventions_1.SEMRESATTRS_CLOUD_PROVIDER,
+    semantic_conventions_1.SEMRESATTRS_CLOUD_ACCOUNT_ID,
+    semantic_conventions_1.SEMRESATTRS_FAAS_NAME,
+    semantic_conventions_1.SEMRESATTRS_FAAS_VERSION,
+    semantic_conventions_1.SEMRESATTRS_FAAS_INSTANCE,
+];
+async function detect() {
+    if (!(await metadata.isAvailable())) {
+        return (0, resources_1.emptyResource)();
+    }
+    // Note the order of these if checks is significant with more specific resources coming
+    // first. E.g. Cloud Functions gen2 are executed in Cloud Run so it must be checked first.
+    if (await gke.onGke()) {
+        return await gkeResource();
     }
-    /**
-     * Asynchronously gather GCP cloud metadata.
-     */
-    _getAttributes() {
-        const isAvail = gcpMetadata.isAvailable();
-        const attributes = {
-            [semantic_conventions_1.SEMRESATTRS_CLOUD_PROVIDER]: (async () => {
-                return (await isAvail) ? semantic_conventions_1.CLOUDPROVIDERVALUES_GCP : undefined;
-            })(),
-            [semantic_conventions_1.SEMRESATTRS_CLOUD_ACCOUNT_ID]: this._getProjectId(isAvail),
-            [semantic_conventions_1.SEMRESATTRS_HOST_ID]: this._getInstanceId(isAvail),
-            [semantic_conventions_1.SEMRESATTRS_HOST_NAME]: this._getHostname(isAvail),
-            [semantic_conventions_1.SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: this._getZone(isAvail),
-        };
-        // Add resource attributes for K8s.
-        if (process.env.KUBERNETES_SERVICE_HOST) {
-            attributes[semantic_conventions_1.SEMRESATTRS_K8S_CLUSTER_NAME] = this._getClusterName(isAvail);
-            attributes[semantic_conventions_1.SEMRESATTRS_K8S_NAMESPACE_NAME] = (async () => {
-                return (await isAvail) ? process.env.NAMESPACE : undefined;
-            })();
-            attributes[semantic_conventions_1.SEMRESATTRS_K8S_POD_NAME] = (async () => {
-                return (await isAvail) ? process.env.HOSTNAME : undefined;
-            })();
-            attributes[semantic_conventions_1.SEMRESATTRS_CONTAINER_NAME] = (async () => {
-                return (await isAvail) ? process.env.CONTAINER_NAME : undefined;
-            })();
-        }
-        return attributes;
+    else if (await faas.onCloudFunctions()) {
+        return await cloudFunctionsResource();
     }
-    /** Gets project id from GCP project metadata. */
-    async _getProjectId(isAvail) {
-        if (!(await isAvail)) {
-            return undefined;
-        }
-        try {
-            return await gcpMetadata.project('project-id');
-        }
-        catch {
-            return '';
-        }
+    else if (await faas.onCloudRun()) {
+        return await cloudRunResource();
     }
-    /** Gets instance id from GCP instance metadata. */
-    async _getInstanceId(isAvail) {
-        if (!(await isAvail)) {
-            return undefined;
-        }
-        try {
-            const id = await gcpMetadata.instance('id');
-            return id.toString();
-        }
-        catch {
-            return '';
-        }
+    else if (await gae.onAppEngine()) {
+        return await gaeResource();
+    }
+    else if (await gce.onGce()) {
+        return await gceResource();
+    }
+    return (0, resources_1.emptyResource)();
+}
+async function gkeResource() {
+    const [zoneOrRegion, k8sClusterName, hostId] = await Promise.all([
+        gke.availabilityZoneOrRegion(),
+        gke.clusterName(),
+        gke.hostId(),
+    ]);
+    return await makeResource({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM]: semantic_conventions_1.CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,
+        [zoneOrRegion.type === 'zone'
+            ? semantic_conventions_1.SEMRESATTRS_CLOUD_AVAILABILITY_ZONE
+            : semantic_conventions_1.SEMRESATTRS_CLOUD_REGION]: zoneOrRegion.value,
+        [semantic_conventions_1.SEMRESATTRS_K8S_CLUSTER_NAME]: k8sClusterName,
+        [semantic_conventions_1.SEMRESATTRS_HOST_ID]: hostId,
+    });
+}
+async function cloudRunResource() {
+    const [faasName, faasVersion, faasInstance, faasCloudRegion] = await Promise.all([
+        faas.faasName(),
+        faas.faasVersion(),
+        faas.faasInstance(),
+        faas.faasCloudRegion(),
+    ]);
+    return await makeResource({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM]: semantic_conventions_1.CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_NAME]: faasName,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_VERSION]: faasVersion,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,
+    });
+}
+async function cloudFunctionsResource() {
+    const [faasName, faasVersion, faasInstance, faasCloudRegion] = await Promise.all([
+        faas.faasName(),
+        faas.faasVersion(),
+        faas.faasInstance(),
+        faas.faasCloudRegion(),
+    ]);
+    return await makeResource({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM]: semantic_conventions_1.CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_NAME]: faasName,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_VERSION]: faasVersion,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,
+    });
+}
+async function gaeResource() {
+    let zone, region;
+    if (await gae.onAppEngineStandard()) {
+        [zone, region] = await Promise.all([
+            gae.standardAvailabilityZone(),
+            gae.standardCloudRegion(),
+        ]);
     }
-    /** Gets zone from GCP instance metadata. */
-    async _getZone(isAvail) {
-        if (!(await isAvail)) {
-            return undefined;
-        }
-        try {
-            const zoneId = await gcpMetadata.instance('zone');
-            if (zoneId) {
-                return zoneId.split('/').pop();
-            }
-            return '';
-        }
-        catch {
-            return '';
-        }
+    else {
+        ({ zone, region } = await gce.availabilityZoneAndRegion());
     }
-    /** Gets cluster name from GCP instance metadata. */
-    async _getClusterName(isAvail) {
-        if (!(await isAvail)) {
-            return undefined;
-        }
-        try {
-            return await gcpMetadata.instance('attributes/cluster-name');
-        }
-        catch {
-            return '';
-        }
+    const [faasName, faasVersion, faasInstance] = await Promise.all([
+        gae.serviceName(),
+        gae.serviceVersion(),
+        gae.serviceInstance(),
+    ]);
+    return await makeResource({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM]: semantic_conventions_1.CLOUDPLATFORMVALUES_GCP_APP_ENGINE,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_NAME]: faasName,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_VERSION]: faasVersion,
+        [semantic_conventions_1.SEMRESATTRS_FAAS_INSTANCE]: faasInstance,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zone,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_REGION]: region,
+    });
+}
+async function gceResource() {
+    const [zoneAndRegion, hostType, hostId, hostName] = await Promise.all([
+        gce.availabilityZoneAndRegion(),
+        gce.hostType(),
+        gce.hostId(),
+        gce.hostName(),
+    ]);
+    return await makeResource({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PLATFORM]: semantic_conventions_1.CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zoneAndRegion.zone,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_REGION]: zoneAndRegion.region,
+        [semantic_conventions_1.SEMRESATTRS_HOST_TYPE]: hostType,
+        [semantic_conventions_1.SEMRESATTRS_HOST_ID]: hostId,
+        [semantic_conventions_1.SEMRESATTRS_HOST_NAME]: hostName,
+    });
+}
+async function makeResource(attrs) {
+    const project = await metadata.project('project-id');
+    return (0, resources_1.resourceFromAttributes)({
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_PROVIDER]: semantic_conventions_1.CLOUDPROVIDERVALUES_GCP,
+        [semantic_conventions_1.SEMRESATTRS_CLOUD_ACCOUNT_ID]: project,
+        ...attrs,
+    });
+}
+/**
+ * Google Cloud resource detector which populates attributes based on the environment this
+ * process is running in. If not on GCP, returns an empty resource.
+ */
+class GcpDetector {
+    async _asyncAttributes() {
+        const resource = await api_1.context.with((0, core_1.suppressTracing)(api_1.context.active()), detect);
+        return resource.attributes;
     }
-    /** Gets hostname from GCP instance metadata. */
-    async _getHostname(isAvail) {
-        if (!(await isAvail)) {
-            return undefined;
-        }
-        try {
-            return await gcpMetadata.instance('hostname');
-        }
-        catch {
-            return '';
-        }
+    detect() {
+        const asyncAttributes = this._asyncAttributes();
+        const attributes = {};
+        ATTRIBUTE_NAMES.forEach(name => {
+            // Each resource attribute is determined asynchronously in _gatherData().
+            attributes[name] = asyncAttributes.then(data => data[name]);
+        });
+        return { attributes };
     }
 }
+exports.GcpDetector = GcpDetector;
 exports.gcpDetector = new GcpDetector();
 //# sourceMappingURL=GcpDetector.js.map

package/build/src/detectors/GcpDetector.js.map

@@ -1 +1 @@
-{"version":3,"file":"GcpDetector.js","sourceRoot":"","sources":["../../../src/detectors/GcpDetector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4CAA4C;AAC5C,4CAA6C;AAC7C,8CAAsD;AAOtD,8EAW6C;AAE7C;;;;GAIG;AACH,MAAM,WAAW;IACf,MAAM,CAAC,OAAiC;QACtC,MAAM,UAAU,GAAG,aAAO,CAAC,IAAI,CAAC,IAAA,sBAAe,EAAC,aAAO,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,CACtE,IAAI,CAAC,cAAc,EAAE,CACtB,CAAC;QACF,OAAO,EAAE,UAAU,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,MAAM,OAAO,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;QAE1C,MAAM,UAAU,GAA+B;YAC7C,CAAC,iDAA0B,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE;gBACxC,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,8CAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/D,CAAC,CAAC,EAAE;YACJ,CAAC,mDAA4B,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;YAC3D,CAAC,0CAAmB,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;YACnD,CAAC,4CAAqB,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;YACnD,CAAC,0DAAmC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;SAC9D,CAAC;QAEF,mCAAmC;QACnC,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;YACvC,UAAU,CAAC,mDAA4B,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACzE,UAAU,CAAC,qDAA8B,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACvD,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7D,CAAC,CAAC,EAAE,CAAC;YACL,UAAU,CAAC,+CAAwB,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACjD,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,CAAC,CAAC,EAAE,CAAC;YACL,UAAU,CAAC,iDAA0B,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACnD,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,CAAC,CAAC,EAAE,CAAC;SACN;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,iDAAiD;IACzC,KAAK,CAAC,aAAa,CACzB,OAAyB;QAEzB,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI;YACF,OAAO,MAAM,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;SAChD;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,mDAAmD;IAC3C,KAAK,CAAC,cAAc,CAC1B,OAAyB;QAEzB,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI;YACF,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;SACtB;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,4CAA4C;IACpC,KAAK,CAAC,QAAQ,CACpB,OAAyB;QAEzB,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAClD,IAAI,MAAM,EAAE;gBACV,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;aAChC;YACD,OAAO,EAAE,CAAC;SACX;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,oDAAoD;IAC5C,KAAK,CAAC,eAAe,CAC3B,OAAyB;QAEzB,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI;YACF,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;SAC9D;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,gDAAgD;IACxC,KAAK,CAAC,YAAY,CACxB,OAAyB;QAEzB,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI;YACF,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SAC/C;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;IACH,CAAC;CACF;AAEY,QAAA,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport * as gcpMetadata from 'gcp-metadata';\nimport { context } from '@opentelemetry/api';\nimport { suppressTracing } from '@opentelemetry/core';\nimport {\n  ResourceDetectionConfig,\n  ResourceDetector,\n  DetectedResource,\n  DetectedResourceAttributes,\n} from '@opentelemetry/resources';\nimport {\n  CLOUDPROVIDERVALUES_GCP,\n  SEMRESATTRS_CLOUD_ACCOUNT_ID,\n  SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,\n  SEMRESATTRS_CLOUD_PROVIDER,\n  SEMRESATTRS_CONTAINER_NAME,\n  SEMRESATTRS_HOST_ID,\n  SEMRESATTRS_HOST_NAME,\n  SEMRESATTRS_K8S_CLUSTER_NAME,\n  SEMRESATTRS_K8S_NAMESPACE_NAME,\n  SEMRESATTRS_K8S_POD_NAME,\n} from '@opentelemetry/semantic-conventions';\n\n/**\n * The GcpDetector can be used to detect if a process is running in the Google\n * Cloud Platform and return a {@link Resource} populated with metadata about\n * the instance. Returns an empty Resource if detection fails.\n */\nclass GcpDetector implements ResourceDetector {\n  detect(_config?: ResourceDetectionConfig): DetectedResource {\n    const attributes = context.with(suppressTracing(context.active()), () =>\n      this._getAttributes()\n    );\n    return { attributes };\n  }\n\n  /**\n   * Asynchronously gather GCP cloud metadata.\n   */\n  private _getAttributes(): DetectedResourceAttributes {\n    const isAvail = gcpMetadata.isAvailable();\n\n    const attributes: DetectedResourceAttributes = {\n      [SEMRESATTRS_CLOUD_PROVIDER]: (async () => {\n        return (await isAvail) ? CLOUDPROVIDERVALUES_GCP : undefined;\n      })(),\n      [SEMRESATTRS_CLOUD_ACCOUNT_ID]: this._getProjectId(isAvail),\n      [SEMRESATTRS_HOST_ID]: this._getInstanceId(isAvail),\n      [SEMRESATTRS_HOST_NAME]: this._getHostname(isAvail),\n      [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: this._getZone(isAvail),\n    };\n\n    // Add resource attributes for K8s.\n    if (process.env.KUBERNETES_SERVICE_HOST) {\n      attributes[SEMRESATTRS_K8S_CLUSTER_NAME] = this._getClusterName(isAvail);\n      attributes[SEMRESATTRS_K8S_NAMESPACE_NAME] = (async () => {\n        return (await isAvail) ? process.env.NAMESPACE : undefined;\n      })();\n      attributes[SEMRESATTRS_K8S_POD_NAME] = (async () => {\n        return (await isAvail) ? process.env.HOSTNAME : undefined;\n      })();\n      attributes[SEMRESATTRS_CONTAINER_NAME] = (async () => {\n        return (await isAvail) ? process.env.CONTAINER_NAME : undefined;\n      })();\n    }\n\n    return attributes;\n  }\n\n  /** Gets project id from GCP project metadata. */\n  private async _getProjectId(\n    isAvail: Promise<boolean>\n  ): Promise<string | undefined> {\n    if (!(await isAvail)) {\n      return undefined;\n    }\n    try {\n      return await gcpMetadata.project('project-id');\n    } catch {\n      return '';\n    }\n  }\n\n  /** Gets instance id from GCP instance metadata. */\n  private async _getInstanceId(\n    isAvail: Promise<boolean>\n  ): Promise<string | undefined> {\n    if (!(await isAvail)) {\n      return undefined;\n    }\n    try {\n      const id = await gcpMetadata.instance('id');\n      return id.toString();\n    } catch {\n      return '';\n    }\n  }\n\n  /** Gets zone from GCP instance metadata. */\n  private async _getZone(\n    isAvail: Promise<boolean>\n  ): Promise<string | undefined> {\n    if (!(await isAvail)) {\n      return undefined;\n    }\n    try {\n      const zoneId = await gcpMetadata.instance('zone');\n      if (zoneId) {\n        return zoneId.split('/').pop();\n      }\n      return '';\n    } catch {\n      return '';\n    }\n  }\n\n  /** Gets cluster name from GCP instance metadata. */\n  private async _getClusterName(\n    isAvail: Promise<boolean>\n  ): Promise<string | undefined> {\n    if (!(await isAvail)) {\n      return undefined;\n    }\n    try {\n      return await gcpMetadata.instance('attributes/cluster-name');\n    } catch {\n      return '';\n    }\n  }\n\n  /** Gets hostname from GCP instance metadata. */\n  private async _getHostname(\n    isAvail: Promise<boolean>\n  ): Promise<string | undefined> {\n    if (!(await isAvail)) {\n      return undefined;\n    }\n    try {\n      return await gcpMetadata.instance('hostname');\n    } catch {\n      return '';\n    }\n  }\n}\n\nexport const gcpDetector = new GcpDetector();\n"]}
+{"version":3,"file":"GcpDetector.js","sourceRoot":"","sources":["../../../src/detectors/GcpDetector.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH,4CAA6C;AAC7C,8CAAsD;AACtD,8EAmB6C;AAG7C,wDAOkC;AAClC,yCAAyC;AACzC,+BAA+B;AAC/B,6BAA6B;AAC7B,6BAA6B;AAC7B,6BAA6B;AAE7B,MAAM,eAAe,GAAG;IACtB,iDAA0B;IAC1B,0DAAmC;IACnC,+CAAwB;IACxB,mDAA4B;IAC5B,4CAAqB;IACrB,0CAAmB;IACnB,4CAAqB;IACrB,iDAA0B;IAC1B,mDAA4B;IAC5B,4CAAqB;IACrB,+CAAwB;IACxB,gDAAyB;CACjB,CAAC;AAQX,KAAK,UAAU,MAAM;IACnB,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE;QACnC,OAAO,IAAA,yBAAa,GAAE,CAAC;KACxB;IAED,uFAAuF;IACvF,0FAA0F;IAC1F,IAAI,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE;QACrB,OAAO,MAAM,WAAW,EAAE,CAAC;KAC5B;SAAM,IAAI,MAAM,IAAI,CAAC,gBAAgB,EAAE,EAAE;QACxC,OAAO,MAAM,sBAAsB,EAAE,CAAC;KACvC;SAAM,IAAI,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE;QAClC,OAAO,MAAM,gBAAgB,EAAE,CAAC;KACjC;SAAM,IAAI,MAAM,GAAG,CAAC,WAAW,EAAE,EAAE;QAClC,OAAO,MAAM,WAAW,EAAE,CAAC;KAC5B;SAAM,IAAI,MAAM,GAAG,CAAC,KAAK,EAAE,EAAE;QAC5B,OAAO,MAAM,WAAW,EAAE,CAAC;KAC5B;IAED,OAAO,IAAA,yBAAa,GAAE,CAAC;AACzB,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,CAAC,YAAY,EAAE,cAAc,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/D,GAAG,CAAC,wBAAwB,EAAE;QAC9B,GAAG,CAAC,WAAW,EAAE;QACjB,GAAG,CAAC,MAAM,EAAE;KACb,CAAC,CAAC;IAEH,OAAO,MAAM,YAAY,CAAC;QACxB,CAAC,iDAA0B,CAAC,EAAE,gEAAyC;QACvE,CAAC,YAAY,CAAC,IAAI,KAAK,MAAM;YAC3B,CAAC,CAAC,0DAAmC;YACrC,CAAC,CAAC,+CAAwB,CAAC,EAAE,YAAY,CAAC,KAAK;QACjD,CAAC,mDAA4B,CAAC,EAAE,cAAc;QAC9C,CAAC,0CAAmB,CAAC,EAAE,MAAM;KAC9B,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,gBAAgB;IAC7B,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,GAC1D,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAI,CAAC,QAAQ,EAAE;QACf,IAAI,CAAC,WAAW,EAAE;QAClB,IAAI,CAAC,YAAY,EAAE;QACnB,IAAI,CAAC,eAAe,EAAE;KACvB,CAAC,CAAC;IAEL,OAAO,MAAM,YAAY,CAAC;QACxB,CAAC,iDAA0B,CAAC,EAAE,wDAAiC;QAC/D,CAAC,4CAAqB,CAAC,EAAE,QAAQ;QACjC,CAAC,+CAAwB,CAAC,EAAE,WAAW;QACvC,CAAC,gDAAyB,CAAC,EAAE,YAAY;QACzC,CAAC,+CAAwB,CAAC,EAAE,eAAe;KAC5C,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,sBAAsB;IACnC,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,eAAe,CAAC,GAC1D,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAI,CAAC,QAAQ,EAAE;QACf,IAAI,CAAC,WAAW,EAAE;QAClB,IAAI,CAAC,YAAY,EAAE;QACnB,IAAI,CAAC,eAAe,EAAE;KACvB,CAAC,CAAC;IAEL,OAAO,MAAM,YAAY,CAAC;QACxB,CAAC,iDAA0B,CAAC,EAAE,8DAAuC;QACrE,CAAC,4CAAqB,CAAC,EAAE,QAAQ;QACjC,CAAC,+CAAwB,CAAC,EAAE,WAAW;QACvC,CAAC,gDAAyB,CAAC,EAAE,YAAY;QACzC,CAAC,+CAAwB,CAAC,EAAE,eAAe;KAC5C,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,IAAI,IAAI,EAAE,MAAM,CAAC;IACjB,IAAI,MAAM,GAAG,CAAC,mBAAmB,EAAE,EAAE;QACnC,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACjC,GAAG,CAAC,wBAAwB,EAAE;YAC9B,GAAG,CAAC,mBAAmB,EAAE;SAC1B,CAAC,CAAC;KACJ;SAAM;QACL,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,yBAAyB,EAAE,CAAC,CAAC;KAC5D;IACD,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC9D,GAAG,CAAC,WAAW,EAAE;QACjB,GAAG,CAAC,cAAc,EAAE;QACpB,GAAG,CAAC,eAAe,EAAE;KACtB,CAAC,CAAC;IAEH,OAAO,MAAM,YAAY,CAAC;QACxB,CAAC,iDAA0B,CAAC,EAAE,yDAAkC;QAChE,CAAC,4CAAqB,CAAC,EAAE,QAAQ;QACjC,CAAC,+CAAwB,CAAC,EAAE,WAAW;QACvC,CAAC,gDAAyB,CAAC,EAAE,YAAY;QACzC,CAAC,0DAAmC,CAAC,EAAE,IAAI;QAC3C,CAAC,+CAAwB,CAAC,EAAE,MAAM;KACnC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW;IACxB,MAAM,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpE,GAAG,CAAC,yBAAyB,EAAE;QAC/B,GAAG,CAAC,QAAQ,EAAE;QACd,GAAG,CAAC,MAAM,EAAE;QACZ,GAAG,CAAC,QAAQ,EAAE;KACf,CAAC,CAAC;IAEH,OAAO,MAAM,YAAY,CAAC;QACxB,CAAC,iDAA0B,CAAC,EAAE,6DAAsC;QACpE,CAAC,0DAAmC,CAAC,EAAE,aAAa,CAAC,IAAI;QACzD,CAAC,+CAAwB,CAAC,EAAE,aAAa,CAAC,MAAM;QAChD,CAAC,4CAAqB,CAAC,EAAE,QAAQ;QACjC,CAAC,0CAAmB,CAAC,EAAE,MAAM;QAC7B,CAAC,4CAAqB,CAAC,EAAE,QAAQ;KAClC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,KAA4B;IACtD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAS,YAAY,CAAC,CAAC;IAE7D,OAAO,IAAA,kCAAsB,EAAC;QAC5B,CAAC,iDAA0B,CAAC,EAAE,8CAAuB;QACrD,CAAC,mDAA4B,CAAC,EAAE,OAAO;QACvC,GAAG,KAAK;KACuB,CAAC,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAa,WAAW;IACd,KAAK,CAAC,gBAAgB;QAC5B,MAAM,QAAQ,GAAG,MAAM,aAAO,CAAC,IAAI,CACjC,IAAA,sBAAe,EAAC,aAAO,CAAC,MAAM,EAAE,CAAC,EACjC,MAAM,CACP,CAAC;QACF,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC;IAED,MAAM;QACJ,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,EAAgC,CAAC;QACpD,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7B,yEAAyE;YACzE,UAAU,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,OAAO,EAAE,UAAU,EAAE,CAAC;IACxB,CAAC;CACF;AAnBD,kCAmBC;AAEY,QAAA,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC","sourcesContent":["/*\n * Copyright 2022 Google LLC\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { context } from '@opentelemetry/api';\nimport { suppressTracing } from '@opentelemetry/core';\nimport {\n  CLOUDPLATFORMVALUES_GCP_APP_ENGINE,\n  CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,\n  CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,\n  CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,\n  CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,\n  CLOUDPROVIDERVALUES_GCP,\n  SEMRESATTRS_CLOUD_ACCOUNT_ID,\n  SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,\n  SEMRESATTRS_CLOUD_PLATFORM,\n  SEMRESATTRS_CLOUD_PROVIDER,\n  SEMRESATTRS_CLOUD_REGION,\n  SEMRESATTRS_FAAS_INSTANCE,\n  SEMRESATTRS_FAAS_NAME,\n  SEMRESATTRS_FAAS_VERSION,\n  SEMRESATTRS_HOST_ID,\n  SEMRESATTRS_HOST_NAME,\n  SEMRESATTRS_HOST_TYPE,\n  SEMRESATTRS_K8S_CLUSTER_NAME,\n} from '@opentelemetry/semantic-conventions';\n\nimport { AttributeValue, Attributes } from '@opentelemetry/api';\nimport {\n  DetectedResource,\n  DetectedResourceAttributes,\n  emptyResource,\n  Resource,\n  ResourceDetector,\n  resourceFromAttributes,\n} from '@opentelemetry/resources';\nimport * as metadata from 'gcp-metadata';\nimport * as faas from './faas';\nimport * as gae from './gae';\nimport * as gce from './gce';\nimport * as gke from './gke';\n\nconst ATTRIBUTE_NAMES = [\n  SEMRESATTRS_CLOUD_PLATFORM,\n  SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,\n  SEMRESATTRS_CLOUD_REGION,\n  SEMRESATTRS_K8S_CLUSTER_NAME,\n  SEMRESATTRS_HOST_TYPE,\n  SEMRESATTRS_HOST_ID,\n  SEMRESATTRS_HOST_NAME,\n  SEMRESATTRS_CLOUD_PROVIDER,\n  SEMRESATTRS_CLOUD_ACCOUNT_ID,\n  SEMRESATTRS_FAAS_NAME,\n  SEMRESATTRS_FAAS_VERSION,\n  SEMRESATTRS_FAAS_INSTANCE,\n] as const;\n\n// Ensure that all resource keys are accounted for in ATTRIBUTE_NAMES\ntype GcpResourceAttributeName = (typeof ATTRIBUTE_NAMES)[number];\ntype GcpResourceAttributes = Partial<\n  Record<GcpResourceAttributeName, AttributeValue>\n>;\n\nasync function detect(): Promise<Resource> {\n  if (!(await metadata.isAvailable())) {\n    return emptyResource();\n  }\n\n  // Note the order of these if checks is significant with more specific resources coming\n  // first. E.g. Cloud Functions gen2 are executed in Cloud Run so it must be checked first.\n  if (await gke.onGke()) {\n    return await gkeResource();\n  } else if (await faas.onCloudFunctions()) {\n    return await cloudFunctionsResource();\n  } else if (await faas.onCloudRun()) {\n    return await cloudRunResource();\n  } else if (await gae.onAppEngine()) {\n    return await gaeResource();\n  } else if (await gce.onGce()) {\n    return await gceResource();\n  }\n\n  return emptyResource();\n}\n\nasync function gkeResource(): Promise<Resource> {\n  const [zoneOrRegion, k8sClusterName, hostId] = await Promise.all([\n    gke.availabilityZoneOrRegion(),\n    gke.clusterName(),\n    gke.hostId(),\n  ]);\n\n  return await makeResource({\n    [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_KUBERNETES_ENGINE,\n    [zoneOrRegion.type === 'zone'\n      ? SEMRESATTRS_CLOUD_AVAILABILITY_ZONE\n      : SEMRESATTRS_CLOUD_REGION]: zoneOrRegion.value,\n    [SEMRESATTRS_K8S_CLUSTER_NAME]: k8sClusterName,\n    [SEMRESATTRS_HOST_ID]: hostId,\n  });\n}\n\nasync function cloudRunResource(): Promise<Resource> {\n  const [faasName, faasVersion, faasInstance, faasCloudRegion] =\n    await Promise.all([\n      faas.faasName(),\n      faas.faasVersion(),\n      faas.faasInstance(),\n      faas.faasCloudRegion(),\n    ]);\n\n  return await makeResource({\n    [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,\n    [SEMRESATTRS_FAAS_NAME]: faasName,\n    [SEMRESATTRS_FAAS_VERSION]: faasVersion,\n    [SEMRESATTRS_FAAS_INSTANCE]: faasInstance,\n    [SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,\n  });\n}\n\nasync function cloudFunctionsResource(): Promise<Resource> {\n  const [faasName, faasVersion, faasInstance, faasCloudRegion] =\n    await Promise.all([\n      faas.faasName(),\n      faas.faasVersion(),\n      faas.faasInstance(),\n      faas.faasCloudRegion(),\n    ]);\n\n  return await makeResource({\n    [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,\n    [SEMRESATTRS_FAAS_NAME]: faasName,\n    [SEMRESATTRS_FAAS_VERSION]: faasVersion,\n    [SEMRESATTRS_FAAS_INSTANCE]: faasInstance,\n    [SEMRESATTRS_CLOUD_REGION]: faasCloudRegion,\n  });\n}\n\nasync function gaeResource(): Promise<Resource> {\n  let zone, region;\n  if (await gae.onAppEngineStandard()) {\n    [zone, region] = await Promise.all([\n      gae.standardAvailabilityZone(),\n      gae.standardCloudRegion(),\n    ]);\n  } else {\n    ({ zone, region } = await gce.availabilityZoneAndRegion());\n  }\n  const [faasName, faasVersion, faasInstance] = await Promise.all([\n    gae.serviceName(),\n    gae.serviceVersion(),\n    gae.serviceInstance(),\n  ]);\n\n  return await makeResource({\n    [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_APP_ENGINE,\n    [SEMRESATTRS_FAAS_NAME]: faasName,\n    [SEMRESATTRS_FAAS_VERSION]: faasVersion,\n    [SEMRESATTRS_FAAS_INSTANCE]: faasInstance,\n    [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zone,\n    [SEMRESATTRS_CLOUD_REGION]: region,\n  });\n}\n\nasync function gceResource(): Promise<Resource> {\n  const [zoneAndRegion, hostType, hostId, hostName] = await Promise.all([\n    gce.availabilityZoneAndRegion(),\n    gce.hostType(),\n    gce.hostId(),\n    gce.hostName(),\n  ]);\n\n  return await makeResource({\n    [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,\n    [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: zoneAndRegion.zone,\n    [SEMRESATTRS_CLOUD_REGION]: zoneAndRegion.region,\n    [SEMRESATTRS_HOST_TYPE]: hostType,\n    [SEMRESATTRS_HOST_ID]: hostId,\n    [SEMRESATTRS_HOST_NAME]: hostName,\n  });\n}\n\nasync function makeResource(attrs: GcpResourceAttributes): Promise<Resource> {\n  const project = await metadata.project<string>('project-id');\n\n  return resourceFromAttributes({\n    [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_GCP,\n    [SEMRESATTRS_CLOUD_ACCOUNT_ID]: project,\n    ...attrs,\n  } satisfies GcpResourceAttributes);\n}\n\n/**\n * Google Cloud resource detector which populates attributes based on the environment this\n * process is running in. If not on GCP, returns an empty resource.\n */\nexport class GcpDetector implements ResourceDetector {\n  private async _asyncAttributes(): Promise<Attributes> {\n    const resource = await context.with(\n      suppressTracing(context.active()),\n      detect\n    );\n    return resource.attributes;\n  }\n\n  detect(): DetectedResource {\n    const asyncAttributes = this._asyncAttributes();\n    const attributes = {} as DetectedResourceAttributes;\n    ATTRIBUTE_NAMES.forEach(name => {\n      // Each resource attribute is determined asynchronously in _gatherData().\n      attributes[name] = asyncAttributes.then(data => data[name]);\n    });\n\n    return { attributes };\n  }\n}\n\nexport const gcpDetector = new GcpDetector();\n"]}

package/build/src/detectors/faas.d.ts

@@ -0,0 +1,25 @@
+export declare function onCloudRun(): Promise<boolean>;
+export declare function onCloudFunctions(): Promise<boolean>;
+/**
+ * The name of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or {@link
+ * onCloudFunctions()} is true before calling this, or it may throw exceptions.
+ */
+export declare function faasName(): Promise<string>;
+/**
+ * The version/revision of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or
+ * {@link onCloudFunctions()} is true before calling this, or it may throw exceptions.
+ */
+export declare function faasVersion(): Promise<string>;
+/**
+ * The ID for the running instance of a Cloud Run or Cloud Function. Check that {@link
+ * onCloudRun()} or {@link onCloudFunctions()} is true before calling this, or it may throw
+ * exceptions.
+ */
+export declare function faasInstance(): Promise<string>;
+/**
+ * The cloud region where the running instance of a Cloud Run or Cloud Function is located.
+ * Check that {@link onCloudRun()} or {@link onCloudFunctions()} is true before calling this,
+ * or it may throw exceptions.
+ */
+export declare function faasCloudRegion(): Promise<string>;
+//# sourceMappingURL=faas.d.ts.map

package/build/src/detectors/faas.js

@@ -0,0 +1,84 @@
+"use strict";
+/*
+ * Copyright 2023 Google LLC
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.faasCloudRegion = exports.faasInstance = exports.faasVersion = exports.faasName = exports.onCloudFunctions = exports.onCloudRun = void 0;
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/faas.go
+ */
+const metadata = require("gcp-metadata");
+const ID_METADATA_ATTR = 'id';
+const CLOUD_RUN_CONFIG_ENV = 'K_CONFIGURATION';
+const CLOUD_FUNCTION_TARGET_ENV = 'FUNCTION_TARGET';
+const FAAS_SERVICE_ENV = 'K_SERVICE';
+const FAAS_REVISION_ENV = 'K_REVISION';
+const REGION_METADATA_ATTR = 'region';
+async function onCloudRun() {
+    return process.env[CLOUD_RUN_CONFIG_ENV] !== undefined;
+}
+exports.onCloudRun = onCloudRun;
+async function onCloudFunctions() {
+    return process.env[CLOUD_FUNCTION_TARGET_ENV] !== undefined;
+}
+exports.onCloudFunctions = onCloudFunctions;
+/**
+ * The name of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or {@link
+ * onCloudFunctions()} is true before calling this, or it may throw exceptions.
+ */
+async function faasName() {
+    return lookupEnv(FAAS_SERVICE_ENV);
+}
+exports.faasName = faasName;
+/**
+ * The version/revision of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or
+ * {@link onCloudFunctions()} is true before calling this, or it may throw exceptions.
+ */
+async function faasVersion() {
+    return lookupEnv(FAAS_REVISION_ENV);
+}
+exports.faasVersion = faasVersion;
+/**
+ * The ID for the running instance of a Cloud Run or Cloud Function. Check that {@link
+ * onCloudRun()} or {@link onCloudFunctions()} is true before calling this, or it may throw
+ * exceptions.
+ */
+async function faasInstance() {
+    // May be a bignumber.js BigNumber which can just be converted with toString(). See
+    // https://github.com/googleapis/gcp-metadata#take-care-with-large-number-valued-properties
+    const id = await metadata.instance(ID_METADATA_ATTR);
+    return id.toString();
+}
+exports.faasInstance = faasInstance;
+/**
+ * The cloud region where the running instance of a Cloud Run or Cloud Function is located.
+ * Check that {@link onCloudRun()} or {@link onCloudFunctions()} is true before calling this,
+ * or it may throw exceptions.
+ */
+async function faasCloudRegion() {
+    const region = await metadata.instance(REGION_METADATA_ATTR);
+    return region.slice(region.lastIndexOf('/') + 1);
+}
+exports.faasCloudRegion = faasCloudRegion;
+function lookupEnv(key) {
+    const val = process.env[key];
+    if (val === undefined) {
+        throw new Error(`Environment variable ${key} not found`);
+    }
+    return val;
+}
+//# sourceMappingURL=faas.js.map