resource-detector-alibaba-cloud

Author: trentm

detectors/node/opentelemetry-resource-detector-alibaba-cloud/package.json

@@ -28,7 +28,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -57,8 +57,8 @@
     "@opentelemetry/api": "^1.0.0"
   },
   "dependencies": {
-    "@opentelemetry/core": "^1.26.0",
-    "@opentelemetry/resources": "^1.10.0",
+    "@opentelemetry/core": "^2.0.0-dev.0",
+    "@opentelemetry/resources": "^2.0.0-dev.0",
     "@opentelemetry/semantic-conventions": "^1.27.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-alibaba-cloud#readme",

detectors/node/opentelemetry-resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts

@@ -17,11 +17,9 @@
 import { context } from '@opentelemetry/api';
 import { suppressTracing } from '@opentelemetry/core';
 import {
-  DetectorSync,
-  IResource,
-  Resource,
-  ResourceAttributes,
-  ResourceDetectionConfig,
+  ResourceDetector,
+  DetectedResource,
+  DetectedResourceAttributes,
 } from '@opentelemetry/resources';
 import {
   CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
@@ -43,7 +41,7 @@ import * as http from 'http';
  * AlibabaCloud ECS and return a {@link Resource} populated with metadata about
  * the ECS instance. Returns an empty Resource if detection fails.
  */
-class AlibabaCloudEcsDetector implements DetectorSync {
+class AlibabaCloudEcsDetector implements ResourceDetector {
   /**
    * See https://www.alibabacloud.com/help/doc-detail/67254.htm for
    * documentation about the AlibabaCloud instance identity document.
@@ -62,35 +60,38 @@ class AlibabaCloudEcsDetector implements DetectorSync {
    *
    * @param config (unused) The resource detection config
    */
-  detect(_config?: ResourceDetectionConfig): IResource {
+  detect(): DetectedResource {
     const attributes = context.with(suppressTracing(context.active()), () =>
       this._getAttributes()
     );
-    return new Resource({}, attributes);
+    return { attributes };
   }
 
   /** Gets identity and host info and returns them as attribs. Empty object if fails */
-  async _getAttributes(
-    _config?: ResourceDetectionConfig
-  ): Promise<ResourceAttributes> {
-    const {
-      'owner-account-id': accountId,
-      'instance-id': instanceId,
-      'instance-type': instanceType,
-      'region-id': region,
-      'zone-id': availabilityZone,
-    } = await this._fetchIdentity();
-    const hostname = await this._fetchHost();
+  _getAttributes(): DetectedResourceAttributes {
+    const dataP = Promise.all([this._fetchIdentity(), this._fetchHost()]);
 
     return {
-      [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_ALIBABA_CLOUD,
-      [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
-      [SEMRESATTRS_CLOUD_ACCOUNT_ID]: accountId,
-      [SEMRESATTRS_CLOUD_REGION]: region,
-      [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
-      [SEMRESATTRS_HOST_ID]: instanceId,
-      [SEMRESATTRS_HOST_TYPE]: instanceType,
-      [SEMRESATTRS_HOST_NAME]: hostname,
+      [SEMRESATTRS_CLOUD_PROVIDER]: dataP.then(
+        () => CLOUDPROVIDERVALUES_ALIBABA_CLOUD
+      ),
+      [SEMRESATTRS_CLOUD_PLATFORM]: dataP.then(
+        () => CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS
+      ),
+
+      // Data from _fetchIdentity()
+      [SEMRESATTRS_CLOUD_ACCOUNT_ID]: dataP.then(
+        data => data[0]['owner-account-id']
+      ),
+      [SEMRESATTRS_CLOUD_REGION]: dataP.then(data => data[0]['region-id']),
+      [SEMRESATTRS_CLOUD_AVAILABILITY_ZONE]: dataP.then(
+        data => data[0]['zone-id']
+      ),
+      [SEMRESATTRS_HOST_ID]: dataP.then(data => data[0]['instance-id']),
+      [SEMRESATTRS_HOST_TYPE]: dataP.then(data => data[0]['instance-type']),
+
+      // Data from _fetchHost()
+      [SEMRESATTRS_HOST_NAME]: dataP.then(data => data[1]),
     };
   }
 

detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetector.test.ts

@@ -16,7 +16,7 @@
 
 import * as nock from 'nock';
 import * as assert from 'assert';
-import { Resource } from '@opentelemetry/resources';
+import { detectResources } from '@opentelemetry/resources';
 import { CLOUDPROVIDERVALUES_ALIBABA_CLOUD } from '@opentelemetry/semantic-conventions';
 import {
   assertCloudResource,
@@ -63,7 +63,9 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_HOST_PATH)
         .reply(200, () => mockedHostResponse);
 
-      const resource: Resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       scope.done();
@@ -93,7 +95,9 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_HOST_PATH)
         .reply(404, () => new Error());
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -109,7 +113,9 @@ describe('alibabaCloudEcsDetector', () => {
         .delayConnection(2000)
         .reply(200, () => mockedHostResponse);
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});
@@ -122,7 +128,9 @@ describe('alibabaCloudEcsDetector', () => {
         .get(ALIYUN_IDENTITY_PATH)
         .replyWithError('NOT FOUND');
 
-      const resource = await alibabaCloudEcsDetector.detect();
+      const resource = detectResources({
+        detectors: [alibabaCloudEcsDetector],
+      });
       await resource.waitForAsyncAttributes?.();
 
       assert.deepStrictEqual(resource.attributes, {});

detectors/node/opentelemetry-resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetectorIntegration.test.ts

@@ -22,7 +22,7 @@ import {
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
 import { NodeSDK } from '@opentelemetry/sdk-node';
-import { IResource } from '@opentelemetry/resources';
+import { detectResources } from '@opentelemetry/resources';
 
 describe('[Integration] AlibabaCloudEcsDetector', () => {
   it('should not start spans for detector requests', async () => {
@@ -47,7 +47,7 @@ describe('[Integration] AlibabaCloudEcsDetector', () => {
     const {
       alibabaCloudEcsDetector,
     } = require('../../build/src/detectors/AlibabaCloudEcsDetector');
-    const resource = alibabaCloudEcsDetector.detect() as IResource;
+    const resource = detectResources({ detectors: [alibabaCloudEcsDetector] });
     await resource.waitForAsyncAttributes?.();
 
     // Wait for the next loop to let the span close properly