resource-detector-aws

- chore(resource-detector-aws)!: merge Sync and async resources
  - removed `awsBeanstalkDetectorSync` -> use `awsBeanstalkDetector`
  - removed `awsEc2DetectorSync` -> use `awsEc2Detector`
  - removed `awsEcsDetectorSync` -> use `awsEcsDetector`
  - removed `awsEksDetectorSync` -> use `awsEksDetector`
  - removed `awsLambdaDetectorSync` -> use `awsLambdaDetector`
  - no longer exporting the detector classes: `AwsBeanstalkDetector`, `AwsEcsDetector`, `AwsEksDetector`, `AwsLambdaDetector`,

Author: trentm

detectors/node/opentelemetry-resource-detector-aws/package.json

@@ -27,7 +27,7 @@
   "author": "OpenTelemetry Authors",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=14"
+    "node": "^18.19.0 || >=20.6.0"
   },
   "files": [
     "build/src/**/*.js",
@@ -44,7 +44,7 @@
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/contrib-test-utils": "^0.45.1",
     "@opentelemetry/instrumentation-fs": "^0.19.1",
-    "@opentelemetry/instrumentation-http": "^0.57.2",
+    "@opentelemetry/instrumentation-http": "^0.200.0-dev.0",
     "@types/mocha": "10.0.10",
     "@types/node": "18.18.14",
     "@types/sinon": "17.0.4",
@@ -58,8 +58,8 @@
     "@opentelemetry/api": "^1.0.0"
   },
   "dependencies": {
-    "@opentelemetry/core": "^1.0.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-aws#readme",

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsBeanstalkDetector.ts

@@ -14,13 +14,28 @@
  * limitations under the License.
  */
 
+import { context } from '@opentelemetry/api';
+import { suppressTracing } from '@opentelemetry/core';
+
 import {
-  Detector,
-  IResource,
-  ResourceDetectionConfig,
+  ResourceDetector,
+  DetectedResource,
+  DetectedResourceAttributes,
 } from '@opentelemetry/resources';
-
-import { awsBeanstalkDetectorSync } from './AwsBeanstalkDetectorSync';
+import {
+  ATTR_SERVICE_NAME,
+  ATTR_SERVICE_VERSION,
+} from '@opentelemetry/semantic-conventions';
+import {
+  ATTR_CLOUD_PROVIDER,
+  ATTR_CLOUD_PLATFORM,
+  ATTR_SERVICE_NAMESPACE,
+  ATTR_SERVICE_INSTANCE_ID,
+  CLOUD_PROVIDER_VALUE_AWS,
+  CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
+} from '../semconv';
+import * as fs from 'fs';
+import * as util from 'util';
 
 /**
  * The AwsBeanstalkDetector can be used to detect if a process is running in AWS Elastic
@@ -29,13 +44,66 @@ import { awsBeanstalkDetectorSync } from './AwsBeanstalkDetectorSync';
  *
  * See https://docs.amazonaws.cn/en_us/xray/latest/devguide/xray-guide.pdf
  * for more details about detecting information of Elastic Beanstalk plugins
- *
- * @deprecated Use {@link AwsBeanstalkDetectorSync} class instead.
  */
 
-export class AwsBeanstalkDetector implements Detector {
-  detect(config?: ResourceDetectionConfig): Promise<IResource> {
-    return Promise.resolve(awsBeanstalkDetectorSync.detect(config));
+const DEFAULT_BEANSTALK_CONF_PATH =
+  '/var/elasticbeanstalk/xray/environment.conf';
+const WIN_OS_BEANSTALK_CONF_PATH =
+  'C:\\Program Files\\Amazon\\XRay\\environment.conf';
+
+export class AwsBeanstalkDetector implements ResourceDetector {
+  BEANSTALK_CONF_PATH: string;
+  private static readFileAsync = util.promisify(fs.readFile);
+  private static fileAccessAsync = util.promisify(fs.access);
+
+  constructor() {
+    if (process.platform === 'win32') {
+      this.BEANSTALK_CONF_PATH = WIN_OS_BEANSTALK_CONF_PATH;
+    } else {
+      this.BEANSTALK_CONF_PATH = DEFAULT_BEANSTALK_CONF_PATH;
+    }
+  }
+
+  detect(): DetectedResource {
+    const attributes = context.with(suppressTracing(context.active()), () =>
+      this._getAttributes()
+    );
+    return { attributes };
+  }
+
+  /**
+   * Async resource attributes for AWS Beanstalk configuration read from file.
+   */
+  _getAttributes(): DetectedResourceAttributes {
+    const parsedDataP = AwsBeanstalkDetector.fileAccessAsync(
+      this.BEANSTALK_CONF_PATH,
+      fs.constants.R_OK
+    )
+      .then(() =>
+        AwsBeanstalkDetector.readFileAsync(this.BEANSTALK_CONF_PATH, 'utf8')
+      )
+      .then(rawData => {
+        return JSON.parse(rawData);
+      });
+
+    return {
+      [ATTR_CLOUD_PROVIDER]: parsedDataP.then(() => CLOUD_PROVIDER_VALUE_AWS),
+      [ATTR_CLOUD_PLATFORM]: parsedDataP.then(
+        () => CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK
+      ),
+      [ATTR_SERVICE_NAME]: parsedDataP.then(
+        () => CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK
+      ),
+      [ATTR_SERVICE_NAMESPACE]: parsedDataP.then(
+        parsedData => parsedData.environment_name
+      ),
+      [ATTR_SERVICE_VERSION]: parsedDataP.then(
+        parsedData => parsedData.version_label
+      ),
+      [ATTR_SERVICE_INSTANCE_ID]: parsedDataP.then(
+        parsedData => parsedData.deployment_id
+      ),
+    };
   }
 }