chore(resource-detector-alibaba-cloud): update semconv usage to ATTR_ exports (#3051)

Refs: #2377

Author: trentm

package-lock.json

@@ -63,8 +63,7 @@
   },
   "dependencies": {
     "@opentelemetry/core": "^2.0.0",
-    "@opentelemetry/resources": "^2.0.0",
-    "@opentelemetry/semantic-conventions": "^1.27.0"
+    "@opentelemetry/resources": "^2.0.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/resource-detector-alibaba-cloud#readme",
   "sideEffects": false

packages/resource-detector-alibaba-cloud/package.json

@@ -22,17 +22,17 @@ import {
   DetectedResourceAttributes,
 } from '@opentelemetry/resources';
 import {
-  CLOUDPLATFORMVALUES_ALIBABA_CLOUD_ECS,
-  CLOUDPROVIDERVALUES_ALIBABA_CLOUD,
-  SEMRESATTRS_CLOUD_ACCOUNT_ID,
-  SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
-  SEMRESATTRS_CLOUD_PLATFORM,
-  SEMRESATTRS_CLOUD_PROVIDER,
-  SEMRESATTRS_CLOUD_REGION,
-  SEMRESATTRS_HOST_ID,
-  SEMRESATTRS_HOST_NAME,
-  SEMRESATTRS_HOST_TYPE,
-} from '@opentelemetry/semantic-conventions';
+  CLOUD_PLATFORM_VALUE_ALIBABA_CLOUD_ECS,
+  CLOUD_PROVIDER_VALUE_ALIBABA_CLOUD,
+  ATTR_CLOUD_ACCOUNT_ID,
+  ATTR_CLOUD_AVAILABILITY_ZONE,
+  ATTR_CLOUD_PLATFORM,
+  ATTR_CLOUD_PROVIDER,
+  ATTR_CLOUD_REGION,
+  ATTR_HOST_ID,
+  ATTR_HOST_NAME,
+  ATTR_HOST_TYPE,
+} from '../semconv';
 
 import * as http from 'http';
 
@@ -66,14 +66,14 @@ class AlibabaCloudEcsDetector implements ResourceDetector {
     );
 
     const attrNames = [
-      SEMRESATTRS_CLOUD_PROVIDER,
-      SEMRESATTRS_CLOUD_PLATFORM,
-      SEMRESATTRS_CLOUD_ACCOUNT_ID,
-      SEMRESATTRS_CLOUD_REGION,
-      SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
-      SEMRESATTRS_HOST_ID,
-      SEMRESATTRS_HOST_TYPE,
-      SEMRESATTRS_HOST_NAME,
+      ATTR_CLOUD_PROVIDER,
+      ATTR_CLOUD_PLATFORM,
+      ATTR_CLOUD_ACCOUNT_ID,
+      ATTR_CLOUD_REGION,
+      ATTR_CLOUD_AVAILABILITY_ZONE,
+      ATTR_HOST_ID,
+      ATTR_HOST_TYPE,
+      ATTR_HOST_NAME,
     ];
 
     const attributes = {} as DetectedResourceAttributes;
@@ -98,14 +98,14 @@ class AlibabaCloudEcsDetector implements ResourceDetector {
       const hostname = await 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,
+        [ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_ALIBABA_CLOUD,
+        [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_ALIBABA_CLOUD_ECS,
+        [ATTR_CLOUD_ACCOUNT_ID]: accountId,
+        [ATTR_CLOUD_REGION]: region,
+        [ATTR_CLOUD_AVAILABILITY_ZONE]: availabilityZone,
+        [ATTR_HOST_ID]: instanceId,
+        [ATTR_HOST_TYPE]: instanceType,
+        [ATTR_HOST_NAME]: hostname,
       };
     } catch (err: any) {
       diag.debug(

packages/resource-detector-alibaba-cloud/src/detectors/AlibabaCloudEcsDetector.ts

@@ -0,0 +1,116 @@
+/*
+ * 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.
+ */
+
+/*
+ * This file contains a copy of unstable semantic convention definitions
+ * used by this package.
+ * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv
+ */
+
+/**
+ * The cloud account ID the resource is assigned to.
+ *
+ * @example 111111111111
+ * @example opentelemetry
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_ACCOUNT_ID = 'cloud.account.id' as const;
+
+/**
+ * Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running.
+ *
+ * @example us-east-1c
+ *
+ * @note Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' as const;
+
+/**
+ * The cloud platform in use.
+ *
+ * @note The prefix of the service **SHOULD** match the one specified in `cloud.provider`.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_PLATFORM = 'cloud.platform' as const;
+
+/**
+ * Name of the cloud provider.
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_PROVIDER = 'cloud.provider' as const;
+
+/**
+ * The geographical region within a cloud provider. When associated with a resource, this attribute specifies the region where the resource operates. When calling services or APIs deployed on a cloud, this attribute identifies the region where the called destination is deployed.
+ *
+ * @example us-central1
+ * @example us-east-1
+ *
+ * @note Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091).
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_CLOUD_REGION = 'cloud.region' as const;
+
+/**
+ * Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system.
+ *
+ * @example fdbf79e8af94cb7f9e8df36789187052
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_HOST_ID = 'host.id' as const;
+
+/**
+ * Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user.
+ *
+ * @example opentelemetry-test
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_HOST_NAME = 'host.name' as const;
+
+/**
+ * Type of host. For Cloud, this must be the machine type.
+ *
+ * @example n1-standard-1
+ *
+ * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const ATTR_HOST_TYPE = 'host.type' as const;
+
+/**
+ * Enum value "alibaba_cloud_ecs" for attribute {@link ATTR_CLOUD_PLATFORM}.
+ *
+ * Alibaba Cloud Elastic Compute Service
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const CLOUD_PLATFORM_VALUE_ALIBABA_CLOUD_ECS =
+  'alibaba_cloud_ecs' as const;
+
+/**
+ * Enum value "alibaba_cloud" for attribute {@link ATTR_CLOUD_PROVIDER}.
+ *
+ * Alibaba Cloud
+ *
+ * @experimental This enum value is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+ */
+export const CLOUD_PROVIDER_VALUE_ALIBABA_CLOUD = 'alibaba_cloud' as const;

packages/resource-detector-alibaba-cloud/src/semconv.ts

@@ -18,7 +18,7 @@ import { setTimeout as setTimeoutP } from 'timers/promises';
 import * as nock from 'nock';
 import * as assert from 'assert';
 import { detectResources } from '@opentelemetry/resources';
-import { CLOUDPROVIDERVALUES_ALIBABA_CLOUD } from '@opentelemetry/semantic-conventions';
+import { CLOUD_PROVIDER_VALUE_ALIBABA_CLOUD } from '../../src/semconv';
 import {
   assertCloudResource,
   assertHostResource,
@@ -74,7 +74,7 @@ describe('alibabaCloudEcsDetector', () => {
       assert.ok(resource);
 
       assertCloudResource(resource, {
-        provider: CLOUDPROVIDERVALUES_ALIBABA_CLOUD,
+        provider: CLOUD_PROVIDER_VALUE_ALIBABA_CLOUD,
         accountId: 'my-owner-account-id',
         region: 'my-region-id',
         zone: 'my-zone-id',