feat(resource-detector-azure)!: update semconv usage to ATTR_ exports, update to semconv v1.37.0 (#3063)

Author: trentm

packages/resource-detector-azure/README.md

@@ -27,18 +27,18 @@ const tracerProvider = new NodeTracerProvider({ resource });
 
 ## Available Detectors
 
-This package implements Semantic Convention [Version 1.19.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.19.0/semantic_conventions/README.md).
+This package implements Semantic Convention [Version 1.37.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.37.0/semantic_conventions/README.md).
 
 ### App Service Resource Detector
 
 | Resource Attribute      | Description                                                                                                                                                                                               |
 |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | azure.app.service.stamp | The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001". Value of Process Environment Variable `APP_SERVICE_ATTRIBUTE_ENV_VARS`.                            |
-| cloud.platform          | The cloud platform. Here, it's always "azure_app_service".                                                                                                                                                |
+| cloud.platform          | The cloud platform. Here, it's always "azure.app_service".                                                                                                                                                |
 | cloud.provider          | The cloud service provider. In this context, it's always "azure".                                                                                                                                         |
 | cloud.region            | The Azure region where the App Service is hosted, e.g., "East US", "West Europe", etc.  Value of Process Environment Variable `REGION_NAME`.                                                              |
 | cloud.resource_id       | The Azure Resource Manager URI uniquely identifying the Azure App Service. Typically in the format `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Web/sites/{siteName}`. |
-| deployment.environment  | The deployment slot where the Azure App Service is running, such as "staging", "production", etc. Value of Process Environment Variable `WEBSITE_SLOT_NAME`.                                              |
+| deployment.environment.name | The deployment slot where the Azure App Service is running, such as "staging", "production", etc. Value of Process Environment Variable `WEBSITE_SLOT_NAME`. |
 | host.id                 | The primary hostname for the app, excluding any custom hostnames. Value of Process Environment Variable `WEBSITE_HOSTNAME`.                                                                               |
 | service.instance.id     | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value of Process Environment Variable `WEBSITE_INSTANCE_ID`.                                                        |
 | service.name            | The name of the Azure App Service. Value of Process Environment Variable `WEBSITE_SITE_NAME`.                                                                                                             |
@@ -49,7 +49,7 @@ This package implements Semantic Convention [Version 1.19.0](https://github.com/
 |--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | azure.vm.scaleset.name   | The name of the Virtual Machine Scale Set if the VM is part of one. Value from `vmScaleSetName` key on `/metadata/instance/compute` request.                                                             |
 | azure.vm.sku             | The SKU of the Azure Virtual Machine's operating system. For instance, for a VM running Windows Server 2019 Datacenter edition, this value would be "2019-Datacenter". Value from `sku` key on `/metadata/instance/compute` request. |
-| cloud.platform           | The cloud platform, which is always set to "azure_vm" in this context.                                                                                                                                   |
+| cloud.platform           | The cloud platform, which is always set to "azure.vm" in this context.                                                                                                                                   |
 | cloud.provider           | The cloud service provider, which is always set to "azure" in this context.                                                                                                                              |
 | cloud.region             | The Azure region where the Virtual Machine is hosted, such as "East US", "West Europe", etc. Value from `location` key on `/metadata/instance/compute` request.                                          |
 | cloud.resource_id        | The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: `/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}`. Value from `resourceId` key on `/metadata/instance/compute` request.|
@@ -62,7 +62,7 @@ This package implements Semantic Convention [Version 1.19.0](https://github.com/
 
 | Resource Attribute      | Description                                                                                                                                          |
 |-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
-| cloud.platform          | The cloud platform. Here, it's always "azure_functions".                                                                                             |
+| cloud.platform          | The cloud platform. Here, it's always "azure.functions".                                                                                             |
 | cloud.provider          | The cloud service provider. In this context, it's always "azure".                                                                                    |
 | cloud.region            | The Azure region where the Azure Function is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`.       |
 | faas.instance           | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value from Process Environment Variable `WEBSITE_INSTANCE_ID`. |

packages/resource-detector-azure/package.json

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

packages/resource-detector-azure/src/detectors/AzureAppServiceDetector.ts

@@ -25,24 +25,24 @@ import {
   WEBSITE_SLOT_NAME,
   CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE,
 } from '../types';
+import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 import {
-  SEMRESATTRS_CLOUD_REGION,
-  SEMRESATTRS_DEPLOYMENT_ENVIRONMENT,
-  SEMRESATTRS_HOST_ID,
-  SEMRESATTRS_SERVICE_INSTANCE_ID,
-  SEMRESATTRS_SERVICE_NAME,
-  SEMRESATTRS_CLOUD_PROVIDER,
-  SEMRESATTRS_CLOUD_PLATFORM,
-  CLOUDPROVIDERVALUES_AZURE,
-  CLOUDPLATFORMVALUES_AZURE_APP_SERVICE,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_CLOUD_REGION,
+  ATTR_DEPLOYMENT_ENVIRONMENT_NAME,
+  ATTR_HOST_ID,
+  ATTR_SERVICE_INSTANCE_ID,
+  ATTR_CLOUD_PROVIDER,
+  CLOUD_PROVIDER_VALUE_AZURE,
+  ATTR_CLOUD_PLATFORM,
+  CLOUD_PLATFORM_VALUE_AZURE_APP_SERVICE,
+} from '../semconv';
 import { getAzureResourceUri, isAzureFunction } from '../utils';
 
 const APP_SERVICE_ATTRIBUTE_ENV_VARS = {
-  [SEMRESATTRS_CLOUD_REGION]: REGION_NAME,
-  [SEMRESATTRS_DEPLOYMENT_ENVIRONMENT]: WEBSITE_SLOT_NAME,
-  [SEMRESATTRS_HOST_ID]: WEBSITE_HOSTNAME,
-  [SEMRESATTRS_SERVICE_INSTANCE_ID]: WEBSITE_INSTANCE_ID,
+  [ATTR_CLOUD_REGION]: REGION_NAME,
+  [ATTR_DEPLOYMENT_ENVIRONMENT_NAME]: WEBSITE_SLOT_NAME,
+  [ATTR_HOST_ID]: WEBSITE_HOSTNAME,
+  [ATTR_SERVICE_INSTANCE_ID]: WEBSITE_INSTANCE_ID,
   [AZURE_APP_SERVICE_STAMP_RESOURCE_ATTRIBUTE]: WEBSITE_HOME_STAMPNAME,
 };
 
@@ -57,15 +57,15 @@ class AzureAppServiceDetector implements ResourceDetector {
     if (websiteSiteName && !isAzureFunction()) {
       attributes = {
         ...attributes,
-        [SEMRESATTRS_SERVICE_NAME]: websiteSiteName,
+        [ATTR_SERVICE_NAME]: websiteSiteName,
       };
       attributes = {
         ...attributes,
-        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
+        [ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AZURE,
       };
       attributes = {
         ...attributes,
-        [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AZURE_APP_SERVICE,
+        [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AZURE_APP_SERVICE,
       };
 
       const azureResourceUri = getAzureResourceUri(websiteSiteName);

packages/resource-detector-azure/src/detectors/AzureFunctionsDetector.ts

@@ -15,17 +15,17 @@
  */
 
 import { ResourceDetector, DetectedResource } from '@opentelemetry/resources';
+import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 import {
-  SEMRESATTRS_FAAS_MAX_MEMORY,
-  SEMRESATTRS_FAAS_INSTANCE,
-  SEMRESATTRS_CLOUD_PROVIDER,
-  SEMRESATTRS_CLOUD_PLATFORM,
-  SEMRESATTRS_CLOUD_REGION,
-  CLOUDPROVIDERVALUES_AZURE,
-  CLOUDPLATFORMVALUES_AZURE_FUNCTIONS,
-  SEMRESATTRS_SERVICE_NAME,
-  SEMRESATTRS_PROCESS_PID,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_FAAS_MAX_MEMORY,
+  ATTR_FAAS_INSTANCE,
+  ATTR_CLOUD_PROVIDER,
+  CLOUD_PROVIDER_VALUE_AZURE,
+  ATTR_CLOUD_PLATFORM,
+  CLOUD_PLATFORM_VALUE_AZURE_FUNCTIONS,
+  ATTR_CLOUD_REGION,
+  ATTR_PROCESS_PID,
+} from '../semconv';
 import {
   WEBSITE_SITE_NAME,
   WEBSITE_INSTANCE_ID,
@@ -36,9 +36,9 @@ import {
 import { getAzureResourceUri, isAzureFunction } from '../utils';
 
 const AZURE_FUNCTIONS_ATTRIBUTE_ENV_VARS = {
-  [SEMRESATTRS_SERVICE_NAME]: WEBSITE_SITE_NAME,
-  [SEMRESATTRS_FAAS_INSTANCE]: WEBSITE_INSTANCE_ID,
-  [SEMRESATTRS_FAAS_MAX_MEMORY]: FUNCTIONS_MEM_LIMIT,
+  [ATTR_SERVICE_NAME]: WEBSITE_SITE_NAME,
+  [ATTR_FAAS_INSTANCE]: WEBSITE_INSTANCE_ID,
+  [ATTR_FAAS_MAX_MEMORY]: FUNCTIONS_MEM_LIMIT,
 };
 
 /**
@@ -60,28 +60,28 @@ class AzureFunctionsDetector implements ResourceDetector {
       const functionMemLimit = process.env[FUNCTIONS_MEM_LIMIT];
 
       attributes = {
-        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
-        [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AZURE_FUNCTIONS,
-        [SEMRESATTRS_CLOUD_REGION]: process.env[REGION_NAME],
-        [SEMRESATTRS_PROCESS_PID]: process.pid,
+        [ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AZURE,
+        [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AZURE_FUNCTIONS,
+        [ATTR_CLOUD_REGION]: process.env[REGION_NAME],
+        [ATTR_PROCESS_PID]: process.pid,
       };
 
       if (serviceName) {
         attributes = {
           ...attributes,
-          [SEMRESATTRS_SERVICE_NAME]: serviceName,
+          [ATTR_SERVICE_NAME]: serviceName,
         };
       }
       if (functionInstance) {
         attributes = {
           ...attributes,
-          [SEMRESATTRS_FAAS_INSTANCE]: functionInstance,
+          [ATTR_FAAS_INSTANCE]: functionInstance,
         };
       }
       if (functionMemLimit) {
         attributes = {
           ...attributes,
-          [SEMRESATTRS_FAAS_MAX_MEMORY]: functionMemLimit,
+          [ATTR_FAAS_MAX_MEMORY]: functionMemLimit,
         };
       }
       const azureResourceUri = getAzureResourceUri(serviceName);

packages/resource-detector-azure/src/detectors/AzureVmDetector.ts

@@ -24,16 +24,16 @@ import {
   DetectedResourceAttributes,
 } from '@opentelemetry/resources';
 import {
-  CLOUDPLATFORMVALUES_AZURE_VM,
-  CLOUDPROVIDERVALUES_AZURE,
-  SEMRESATTRS_CLOUD_PLATFORM,
-  SEMRESATTRS_CLOUD_PROVIDER,
-  SEMRESATTRS_CLOUD_REGION,
-  SEMRESATTRS_HOST_ID,
-  SEMRESATTRS_HOST_NAME,
-  SEMRESATTRS_HOST_TYPE,
-  SEMRESATTRS_OS_VERSION,
-} from '@opentelemetry/semantic-conventions';
+  ATTR_CLOUD_PLATFORM,
+  CLOUD_PLATFORM_VALUE_AZURE_VM,
+  ATTR_CLOUD_PROVIDER,
+  CLOUD_PROVIDER_VALUE_AZURE,
+  ATTR_CLOUD_REGION,
+  ATTR_HOST_ID,
+  ATTR_HOST_NAME,
+  ATTR_HOST_TYPE,
+  ATTR_OS_VERSION,
+} from '../semconv';
 import {
   CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE,
   AZURE_VM_METADATA_HOST,
@@ -56,14 +56,14 @@ class AzureVmResourceDetector implements ResourceDetector {
     const attrNames = [
       AZURE_VM_SCALE_SET_NAME_ATTRIBUTE,
       AZURE_VM_SKU_ATTRIBUTE,
-      SEMRESATTRS_CLOUD_PLATFORM,
-      SEMRESATTRS_CLOUD_PROVIDER,
-      SEMRESATTRS_CLOUD_REGION,
+      ATTR_CLOUD_PLATFORM,
+      ATTR_CLOUD_PROVIDER,
+      ATTR_CLOUD_REGION,
       CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE,
-      SEMRESATTRS_HOST_ID,
-      SEMRESATTRS_HOST_NAME,
-      SEMRESATTRS_HOST_TYPE,
-      SEMRESATTRS_OS_VERSION,
+      ATTR_HOST_ID,
+      ATTR_HOST_NAME,
+      ATTR_HOST_TYPE,
+      ATTR_OS_VERSION,
     ];
 
     const attributes = {} as DetectedResourceAttributes;
@@ -122,14 +122,14 @@ class AzureVmResourceDetector implements ResourceDetector {
       const attributes = {
         [AZURE_VM_SCALE_SET_NAME_ATTRIBUTE]: metadata['vmScaleSetName'],
         [AZURE_VM_SKU_ATTRIBUTE]: metadata['sku'],
-        [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AZURE_VM,
-        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
-        [SEMRESATTRS_CLOUD_REGION]: metadata['location'],
+        [ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AZURE_VM,
+        [ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AZURE,
+        [ATTR_CLOUD_REGION]: metadata['location'],
         [CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE]: metadata['resourceId'],
-        [SEMRESATTRS_HOST_ID]: metadata['vmId'],
-        [SEMRESATTRS_HOST_NAME]: metadata['name'],
-        [SEMRESATTRS_HOST_TYPE]: metadata['vmSize'],
-        [SEMRESATTRS_OS_VERSION]: metadata['version'],
+        [ATTR_HOST_ID]: metadata['vmId'],
+        [ATTR_HOST_NAME]: metadata['name'],
+        [ATTR_HOST_TYPE]: metadata['vmSize'],
+        [ATTR_OS_VERSION]: metadata['version'],
       };
       return attributes;
     } catch (err: any) {