@opentelemetry/resource-detector-gcp 0.38.0 → 0.40.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"faas.js","sourceRoot":"","sources":["../../../src/detectors/faas.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH;;;GAGG;AAEH,yCAAyC;AAEzC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAC/C,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AACpD,MAAM,gBAAgB,GAAG,WAAW,CAAC;AACrC,MAAM,iBAAiB,GAAG,YAAY,CAAC;AACvC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAE/B,KAAK,UAAU,UAAU;IAC9B,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,SAAS,CAAC;AACzD,CAAC;AAFD,gCAEC;AAEM,KAAK,UAAU,gBAAgB;IACpC,OAAO,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,KAAK,SAAS,CAAC;AAC9D,CAAC;AAFD,4CAEC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,SAAS,CAAC,gBAAgB,CAAC,CAAC;AACrC,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACI,KAAK,UAAU,WAAW;IAC/B,OAAO,SAAS,CAAC,iBAAiB,CAAC,CAAC;AACtC,CAAC;AAFD,kCAEC;AAED;;;;GAIG;AACI,KAAK,UAAU,YAAY;IAChC,mFAAmF;IACnF,2FAA2F;IAC3F,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAkB,gBAAgB,CAAC,CAAC;IACtE,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;AACvB,CAAC;AALD,oCAKC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe;IACnC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAS,oBAAoB,CAAC,CAAC;IACrE,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AACnD,CAAC;AAHD,0CAGC;AAED,SAAS,SAAS,CAAC,GAAW;IAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,YAAY,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["/*\n * Copyright 2023 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/faas.go\n */\n\nimport * as metadata from 'gcp-metadata';\n\nconst ID_METADATA_ATTR = 'id';\nconst CLOUD_RUN_CONFIG_ENV = 'K_CONFIGURATION';\nconst CLOUD_FUNCTION_TARGET_ENV = 'FUNCTION_TARGET';\nconst FAAS_SERVICE_ENV = 'K_SERVICE';\nconst FAAS_REVISION_ENV = 'K_REVISION';\nconst REGION_METADATA_ATTR = 'region';\n\nexport async function onCloudRun(): Promise<boolean> {\n  return process.env[CLOUD_RUN_CONFIG_ENV] !== undefined;\n}\n\nexport async function onCloudFunctions(): Promise<boolean> {\n  return process.env[CLOUD_FUNCTION_TARGET_ENV] !== undefined;\n}\n\n/**\n * The name of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or {@link\n * onCloudFunctions()} is true before calling this, or it may throw exceptions.\n */\nexport async function faasName(): Promise<string> {\n  return lookupEnv(FAAS_SERVICE_ENV);\n}\n\n/**\n * The version/revision of the Cloud Run or Cloud Function. Check that {@link onCloudRun()} or\n * {@link onCloudFunctions()} is true before calling this, or it may throw exceptions.\n */\nexport async function faasVersion(): Promise<string> {\n  return lookupEnv(FAAS_REVISION_ENV);\n}\n\n/**\n * The ID for the running instance of a Cloud Run or Cloud Function. Check that {@link\n * onCloudRun()} or {@link onCloudFunctions()} is true before calling this, or it may throw\n * exceptions.\n */\nexport async function faasInstance(): 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 cloud region where the running instance of a Cloud Run or Cloud Function is located.\n * Check that {@link onCloudRun()} or {@link onCloudFunctions()} is true before calling this,\n * or it may throw exceptions.\n */\nexport async function faasCloudRegion(): Promise<string> {\n  const region = await metadata.instance<string>(REGION_METADATA_ATTR);\n  return region.slice(region.lastIndexOf('/') + 1);\n}\n\nfunction lookupEnv(key: string): string {\n  const val = process.env[key];\n  if (val === undefined) {\n    throw new Error(`Environment variable ${key} not found`);\n  }\n  return val;\n}\n"]}

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

@@ -0,0 +1,36 @@
+export declare function onAppEngineStandard(): Promise<boolean>;
+export declare function onAppEngine(): Promise<boolean>;
+/**
+ * The service name of the app engine service. Check that {@link onAppEngine()} is true before
+ * calling this, or it may throw exceptions.
+ */
+export declare function serviceName(): Promise<string>;
+/**
+ * The service version of the app engine service. Check that {@link onAppEngine()} is true
+ * before calling this, or it may throw exceptions.
+ */
+export declare function serviceVersion(): Promise<string>;
+/**
+ * The service instance of the app engine service. Check that {@link onAppEngine()} is true
+ * before calling this, or it may throw exceptions.
+ */
+export declare function serviceInstance(): Promise<string>;
+/**
+ * The zone and region in which this program is running. Check that {@link onAppEngine()} is
+ * true before calling this, or it may throw exceptions.
+ */
+export declare function flexAvailabilityZoneAndRegion(): Promise<{
+    zone: string;
+    region: string;
+}>;
+/**
+ * The zone the app engine service is running in. Check that {@link onAppEngineStandard()} is
+ * true before calling this, or it may throw exceptions.
+ */
+export declare function standardAvailabilityZone(): Promise<string>;
+/**
+ * The region the app engine service is running in. Check that {@link onAppEngineStandard()} is
+ * true before calling this, or it may throw exceptions.
+ */
+export declare function standardCloudRegion(): Promise<string>;
+//# sourceMappingURL=gae.d.ts.map

package/build/src/detectors/gae.js

@@ -0,0 +1,98 @@
+"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.standardCloudRegion = exports.standardAvailabilityZone = exports.flexAvailabilityZoneAndRegion = exports.serviceInstance = exports.serviceVersion = exports.serviceName = exports.onAppEngine = exports.onAppEngineStandard = void 0;
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/app_engine.go
+ */
+const metadata = require("gcp-metadata");
+const gce = require("./gce");
+const faas = require("./faas");
+const GAE_SERVICE_ENV = 'GAE_SERVICE';
+const GAE_VERSION_ENV = 'GAE_VERSION';
+const GAE_INSTANCE_ENV = 'GAE_INSTANCE';
+const GAE_ENV = 'GAE_ENV';
+const GAE_STANDARD = 'standard';
+const ZONE_METADATA_ATTR = 'zone';
+async function onAppEngineStandard() {
+    return process.env[GAE_ENV] === GAE_STANDARD;
+}
+exports.onAppEngineStandard = onAppEngineStandard;
+async function onAppEngine() {
+    return process.env[GAE_SERVICE_ENV] !== undefined;
+}
+exports.onAppEngine = onAppEngine;
+/**
+ * The service name of the app engine service. Check that {@link onAppEngine()} is true before
+ * calling this, or it may throw exceptions.
+ */
+async function serviceName() {
+    return lookupEnv(GAE_SERVICE_ENV);
+}
+exports.serviceName = serviceName;
+/**
+ * The service version of the app engine service. Check that {@link onAppEngine()} is true
+ * before calling this, or it may throw exceptions.
+ */
+async function serviceVersion() {
+    return lookupEnv(GAE_VERSION_ENV);
+}
+exports.serviceVersion = serviceVersion;
+/**
+ * The service instance of the app engine service. Check that {@link onAppEngine()} is true
+ * before calling this, or it may throw exceptions.
+ */
+async function serviceInstance() {
+    return lookupEnv(GAE_INSTANCE_ENV);
+}
+exports.serviceInstance = serviceInstance;
+/**
+ * The zone and region in which this program is running. Check that {@link onAppEngine()} is
+ * true before calling this, or it may throw exceptions.
+ */
+async function flexAvailabilityZoneAndRegion() {
+    return await gce.availabilityZoneAndRegion();
+}
+exports.flexAvailabilityZoneAndRegion = flexAvailabilityZoneAndRegion;
+/**
+ * The zone the app engine service is running in. Check that {@link onAppEngineStandard()} is
+ * true before calling this, or it may throw exceptions.
+ */
+async function standardAvailabilityZone() {
+    const zone = await metadata.instance(ZONE_METADATA_ATTR);
+    // zone is of the form "projects/233510669999/zones/us15"
+    return zone.slice(zone.lastIndexOf('/') + 1);
+}
+exports.standardAvailabilityZone = standardAvailabilityZone;
+/**
+ * The region the app engine service is running in. Check that {@link onAppEngineStandard()} is
+ * true before calling this, or it may throw exceptions.
+ */
+async function standardCloudRegion() {
+    return await faas.faasCloudRegion();
+}
+exports.standardCloudRegion = standardCloudRegion;
+function lookupEnv(key) {
+    const val = process.env[key];
+    if (val === undefined) {
+        throw new Error(`Environment variable ${key} not found`);
+    }
+    return val;
+}
+//# sourceMappingURL=gae.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gae.js","sourceRoot":"","sources":["../../../src/detectors/gae.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAEH;;;GAGG;AAEH,yCAAyC;AACzC,6BAA6B;AAC7B,+BAA+B;AAE/B,MAAM,eAAe,GAAG,aAAa,CAAC;AACtC,MAAM,eAAe,GAAG,aAAa,CAAC;AACtC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AACxC,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,YAAY,GAAG,UAAU,CAAC;AAChC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAE3B,KAAK,UAAU,mBAAmB;IACvC,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC;AAC/C,CAAC;AAFD,kDAEC;AAEM,KAAK,UAAU,WAAW;IAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,SAAS,CAAC;AACpD,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACI,KAAK,UAAU,WAAW;IAC/B,OAAO,SAAS,CAAC,eAAe,CAAC,CAAC;AACpC,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc;IAClC,OAAO,SAAS,CAAC,eAAe,CAAC,CAAC;AACpC,CAAC;AAFD,wCAEC;AAED;;;GAGG;AACI,KAAK,UAAU,eAAe;IACnC,OAAO,SAAS,CAAC,gBAAgB,CAAC,CAAC;AACrC,CAAC;AAFD,0CAEC;AAED;;;GAGG;AACI,KAAK,UAAU,6BAA6B;IAIjD,OAAO,MAAM,GAAG,CAAC,yBAAyB,EAAE,CAAC;AAC/C,CAAC;AALD,sEAKC;AAED;;;GAGG;AACI,KAAK,UAAU,wBAAwB;IAC5C,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAS,kBAAkB,CAAC,CAAC;IACjE,yDAAyD;IACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC;AAJD,4DAIC;AAED;;;GAGG;AACI,KAAK,UAAU,mBAAmB;IACvC,OAAO,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;AACtC,CAAC;AAFD,kDAEC;AAED,SAAS,SAAS,CAAC,GAAW;IAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,YAAY,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["/*\n * Copyright 2023 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/app_engine.go\n */\n\nimport * as metadata from 'gcp-metadata';\nimport * as gce from './gce';\nimport * as faas from './faas';\n\nconst GAE_SERVICE_ENV = 'GAE_SERVICE';\nconst GAE_VERSION_ENV = 'GAE_VERSION';\nconst GAE_INSTANCE_ENV = 'GAE_INSTANCE';\nconst GAE_ENV = 'GAE_ENV';\nconst GAE_STANDARD = 'standard';\nconst ZONE_METADATA_ATTR = 'zone';\n\nexport async function onAppEngineStandard(): Promise<boolean> {\n  return process.env[GAE_ENV] === GAE_STANDARD;\n}\n\nexport async function onAppEngine(): Promise<boolean> {\n  return process.env[GAE_SERVICE_ENV] !== undefined;\n}\n\n/**\n * The service name of the app engine service. Check that {@link onAppEngine()} is true before\n * calling this, or it may throw exceptions.\n */\nexport async function serviceName(): Promise<string> {\n  return lookupEnv(GAE_SERVICE_ENV);\n}\n\n/**\n * The service version of the app engine service. Check that {@link onAppEngine()} is true\n * before calling this, or it may throw exceptions.\n */\nexport async function serviceVersion(): Promise<string> {\n  return lookupEnv(GAE_VERSION_ENV);\n}\n\n/**\n * The service instance of the app engine service. Check that {@link onAppEngine()} is true\n * before calling this, or it may throw exceptions.\n */\nexport async function serviceInstance(): Promise<string> {\n  return lookupEnv(GAE_INSTANCE_ENV);\n}\n\n/**\n * The zone and region in which this program is running. Check that {@link onAppEngine()} is\n * true before calling this, or it may throw exceptions.\n */\nexport async function flexAvailabilityZoneAndRegion(): Promise<{\n  zone: string;\n  region: string;\n}> {\n  return await gce.availabilityZoneAndRegion();\n}\n\n/**\n * The zone the app engine service is running in. Check that {@link onAppEngineStandard()} is\n * true before calling this, or it may throw exceptions.\n */\nexport async function standardAvailabilityZone(): Promise<string> {\n  const zone = await metadata.instance<string>(ZONE_METADATA_ATTR);\n  // zone is of the form \"projects/233510669999/zones/us15\"\n  return zone.slice(zone.lastIndexOf('/') + 1);\n}\n\n/**\n * The region the app engine service is running in. Check that {@link onAppEngineStandard()} is\n * true before calling this, or it may throw exceptions.\n */\nexport async function standardCloudRegion(): Promise<string> {\n  return await faas.faasCloudRegion();\n}\n\nfunction lookupEnv(key: string): string {\n  const val = process.env[key];\n  if (val === undefined) {\n    throw new Error(`Environment variable ${key} not found`);\n  }\n  return val;\n}\n"]}

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

@@ -0,0 +1,25 @@
+export declare function onGce(): Promise<boolean>;
+/**
+ * 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 declare function hostType(): Promise<string>;
+/**
+ * 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 declare function hostId(): Promise<string>;
+/**
+ * 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 declare function hostName(): Promise<string>;
+/**
+ * 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 declare function availabilityZoneAndRegion(): Promise<{
+    zone: string;
+    region: string;
+}>;
+//# sourceMappingURL=gce.d.ts.map

package/build/src/detectors/gce.js

@@ -0,0 +1,84 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.availabilityZoneAndRegion = exports.hostName = exports.hostId = exports.hostType = exports.onGce = void 0;
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gce.go
+ */
+const api_1 = require("@opentelemetry/api");
+const metadata = require("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';
+async function onGce() {
+    try {
+        await metadata.instance(MACHINE_TYPE_METADATA_ATTR);
+        return true;
+    }
+    catch (err) {
+        api_1.diag.debug('Could not fetch metadata attribute %s, assuming not on GCE. Error was %s', MACHINE_TYPE_METADATA_ATTR, err);
+        return false;
+    }
+}
+exports.onGce = onGce;
+/**
+ * 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.
+ */
+async function hostType() {
+    return metadata.instance(MACHINE_TYPE_METADATA_ATTR);
+}
+exports.hostType = hostType;
+/**
+ * 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.
+ */
+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();
+}
+exports.hostId = hostId;
+/**
+ * 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.
+ */
+async function hostName() {
+    return metadata.instance(HOST_NAME_METADATA_ATTR);
+}
+exports.hostName = hostName;
+/**
+ * The zone and region in which this program is running. Check that {@link onGce()} is true
+ * before calling this, or it may throw exceptions.
+ */
+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 };
+}
+exports.availabilityZoneAndRegion = availabilityZoneAndRegion;
+//# sourceMappingURL=gce.js.map

package/build/src/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,4CAA0C;AAC1C,yCAAyC;AAEzC,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,uBAAuB,GAAG,MAAM,CAAC;AACvC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAE3B,KAAK,UAAU,KAAK;IACzB,IAAI;QACF,MAAM,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;KACb;IAAC,OAAO,GAAG,EAAE;QACZ,UAAI,CAAC,KAAK,CACR,0EAA0E,EAC1E,0BAA0B,EAC1B,GAAG,CACJ,CAAC;QACF,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAZD,sBAYC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;AAC/D,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACI,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;AALD,wBAKC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,QAAQ,CAAC,QAAQ,CAAS,uBAAuB,CAAC,CAAC;AAC5D,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACI,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;AAjBD,8DAiBC","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/src/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/src/detectors/gke.js

@@ -0,0 +1,74 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.availabilityZoneOrRegion = exports.clusterName = exports.hostId = exports.onGke = void 0;
+/**
+ * Implementation in this file copied from
+ * https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/v1.8.0/detectors/gcp/gke.go
+ */
+const metadata = require("gcp-metadata");
+const gce = require("./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';
+async function onGke() {
+    return process.env[KUBERNETES_SERVICE_HOST_ENV] !== undefined;
+}
+exports.onGke = onGke;
+/**
+ * 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.
+ */
+async function hostId() {
+    return await gce.hostId();
+}
+exports.hostId = 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.
+ */
+async function clusterName() {
+    return metadata.instance(CLUSTER_NAME_METADATA_ATTR);
+}
+exports.clusterName = clusterName;
+/**
+ * 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.
+ */
+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}`);
+    }
+}
+exports.availabilityZoneOrRegion = availabilityZoneOrRegion;
+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/src/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,yCAAyC;AACzC,6BAA6B;AAE7B,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AAC9D,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAC7D,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;AAE9D,KAAK,UAAU,KAAK;IACzB,OAAO,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,KAAK,SAAS,CAAC;AAChE,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACI,KAAK,UAAU,MAAM;IAC1B,OAAO,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;AAC5B,CAAC;AAFD,wBAEC;AAED;;;GAGG;AACI,KAAK,UAAU,WAAW;IAC/B,OAAO,QAAQ,CAAC,QAAQ,CAAS,0BAA0B,CAAC,CAAC;AAC/D,CAAC;AAFD,kCAEC;AAED;;;GAGG;AACI,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;AAjBD,4DAiBC;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentelemetry/resource-detector-gcp",
-  "version": "0.38.0",
+  "version": "0.40.0",
   "description": "OpenTelemetry SDK resource detector for GCP",
   "main": "build/src/index.js",
   "module": "build/esm/index.js",
@@ -46,15 +46,16 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.0.0",
-    "@opentelemetry/contrib-test-utils": "^0.50.0",
-    "@opentelemetry/instrumentation-http": "^0.204.0",
+    "@opentelemetry/contrib-test-utils": "^0.51.0",
+    "@opentelemetry/instrumentation-http": "^0.205.0",
     "@opentelemetry/sdk-trace-base": "^2.0.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/semver": "7.5.8",
-    "nock": "13.3.3",
+    "@types/sinon": "17.0.4",
+    "bignumber.js": "9.3.1",
     "nyc": "17.1.0",
-    "rimraf": "5.0.10",
+    "sinon": "15.2.0",
     "typescript": "5.0.4"
   },
   "peerDependencies": {
@@ -68,5 +69,5 @@
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/resource-detector-gcp#readme",
   "sideEffects": false,
-  "gitHead": "0a45ac1b951d2acd2e40834e7ae012c04820faec"
+  "gitHead": "9d689e167e92b09fca91906e20790496a49af384"
 }