chore(resource-detector-azure): use exported strings for attributes

maryliag · maryliag · commit e48a38d1ac5a · 2024-03-27T10:55:04.000-04:00
Use exported strings for Semantic Resource Attributes, Cloud Platform Values and Cloud Provider Values.

Signed-off-by: maryliag &lt;marylia.gutierrez@grafana.com&gt;
diff --git a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md
@@ -12,6 +12,16 @@
   * devDependencies
     * @opentelemetry/contrib-test-utils bumped from ^0.36.0 to ^0.37.0
 
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @opentelemetry/semantic-conventions bumped from ^1.0.0 to ^1.22.0
+
+### Enhancement
+
+* refactor: use exported strings for Semantic Resource Attributes, Cloud Platform Values and Cloud Provider Values
+
 ## [0.2.3](https://github.com/open-telemetry/opentelemetry-js-contrib/compare/resource-detector-azure-v0.2.2...resource-detector-azure-v0.2.3) (2024-01-04)
 
 
diff --git a/detectors/node/opentelemetry-resource-detector-azure/package.json b/detectors/node/opentelemetry-resource-detector-azure/package.json
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@opentelemetry/resources": "^1.10.1",
-    "@opentelemetry/semantic-conventions": "^1.0.0"
+    "@opentelemetry/semantic-conventions": "^1.22.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-azure#readme"
 }
diff --git a/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureAppServiceDetector.ts b/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureAppServiceDetector.ts
@@ -29,16 +29,22 @@ import {
   FUNCTIONS_VERSION,
 } from '../types';
 import {
-  CloudProviderValues,
-  CloudPlatformValues,
-  SemanticResourceAttributes,
+  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';
 
 const APP_SERVICE_ATTRIBUTE_ENV_VARS = {
-  [SemanticResourceAttributes.CLOUD_REGION]: REGION_NAME,
-  [SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT]: WEBSITE_SLOT_NAME,
-  [SemanticResourceAttributes.HOST_ID]: WEBSITE_HOSTNAME,
-  [SemanticResourceAttributes.SERVICE_INSTANCE_ID]: WEBSITE_INSTANCE_ID,
+  [SEMRESATTRS_CLOUD_REGION]: REGION_NAME,
+  [SEMRESATTRS_DEPLOYMENT_ENVIRONMENT]: WEBSITE_SLOT_NAME,
+  [SEMRESATTRS_HOST_ID]: WEBSITE_HOSTNAME,
+  [SEMRESATTRS_SERVICE_INSTANCE_ID]: WEBSITE_INSTANCE_ID,
   [AZURE_APP_SERVICE_STAMP_RESOURCE_ATTRIBUTE]: WEBSITE_HOME_STAMPNAME,
 };
 
@@ -54,16 +60,16 @@ class AzureAppServiceDetector implements DetectorSync {
     if (websiteSiteName && !isAzureFunction) {
       attributes = {
         ...attributes,
-        [SemanticResourceAttributes.SERVICE_NAME]: websiteSiteName,
+        [SEMRESATTRS_SERVICE_NAME]: websiteSiteName,
       };
       attributes = {
         ...attributes,
-        [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.AZURE,
+        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
       };
       attributes = {
         ...attributes,
-        [SemanticResourceAttributes.CLOUD_PLATFORM]:
-          CloudPlatformValues.AZURE_APP_SERVICE,
+        [SEMRESATTRS_CLOUD_PLATFORM]:
+          CLOUDPLATFORMVALUES_AZURE_APP_SERVICE,
       };
 
       const azureResourceUri = this.getAzureResourceUri(websiteSiteName);
diff --git a/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureFunctionsDetector.ts b/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureFunctionsDetector.ts
@@ -17,9 +17,15 @@
 import { DetectorSync, IResource, Resource } from '@opentelemetry/resources';
 
 import {
-  CloudProviderValues,
-  CloudPlatformValues,
-  SemanticResourceAttributes,
+  SEMRESATTRS_FAAS_NAME,
+  SEMRESATTRS_FAAS_VERSION,
+  SEMRESATTRS_FAAS_MAX_MEMORY,
+  SEMRESATTRS_FAAS_INSTANCE,
+  SEMRESATTRS_CLOUD_PROVIDER,
+  SEMRESATTRS_CLOUD_PLATFORM,
+  SEMRESATTRS_CLOUD_REGION,
+  CLOUDPROVIDERVALUES_AZURE,
+  CLOUDPLATFORMVALUES_AZURE_FUNCTIONS,
 } from '@opentelemetry/semantic-conventions';
 import {
   WEBSITE_SITE_NAME,
@@ -30,10 +36,10 @@ import {
 } from '../types';
 
 const AZURE_FUNCTIONS_ATTRIBUTE_ENV_VARS = {
-  [SemanticResourceAttributes.FAAS_NAME]: WEBSITE_SITE_NAME,
-  [SemanticResourceAttributes.FAAS_VERSION]: FUNCTIONS_VERSION,
-  [SemanticResourceAttributes.FAAS_INSTANCE]: WEBSITE_INSTANCE_ID,
-  [SemanticResourceAttributes.FAAS_MAX_MEMORY]: FUNCTIONS_MEM_LIMIT,
+  [SEMRESATTRS_FAAS_NAME]: WEBSITE_SITE_NAME,
+  [SEMRESATTRS_FAAS_VERSION]: FUNCTIONS_VERSION,
+  [SEMRESATTRS_FAAS_INSTANCE]: WEBSITE_INSTANCE_ID,
+  [SEMRESATTRS_FAAS_MAX_MEMORY]: FUNCTIONS_MEM_LIMIT,
 };
 
 /**
@@ -50,34 +56,34 @@ class AzureFunctionsDetector implements DetectorSync {
       const functionMemLimit = process.env[FUNCTIONS_MEM_LIMIT];
 
       attributes = {
-        [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.AZURE,
-        [SemanticResourceAttributes.CLOUD_PLATFORM]:
-          CloudPlatformValues.AZURE_FUNCTIONS,
-        [SemanticResourceAttributes.CLOUD_REGION]: process.env[REGION_NAME],
+        [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
+        [SEMRESATTRS_CLOUD_PLATFORM]:
+          CLOUDPLATFORMVALUES_AZURE_FUNCTIONS,
+        [SEMRESATTRS_CLOUD_REGION]: process.env[REGION_NAME],
       };
 
       if (functionName) {
         attributes = {
           ...attributes,
-          [SemanticResourceAttributes.FAAS_NAME]: functionName,
+          [SEMRESATTRS_FAAS_NAME]: functionName,
         };
       }
       if (functionVersion) {
         attributes = {
           ...attributes,
-          [SemanticResourceAttributes.FAAS_VERSION]: functionVersion,
+          [SEMRESATTRS_FAAS_VERSION]: functionVersion,
         };
       }
       if (functionInstance) {
         attributes = {
           ...attributes,
-          [SemanticResourceAttributes.FAAS_INSTANCE]: functionInstance,
+          [SEMRESATTRS_FAAS_INSTANCE]: functionInstance,
         };
       }
       if (functionMemLimit) {
         attributes = {
           ...attributes,
-          [SemanticResourceAttributes.FAAS_MAX_MEMORY]: functionMemLimit,
+          [SEMRESATTRS_FAAS_MAX_MEMORY]: functionMemLimit,
         };
       }
 
diff --git a/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureVmDetector.ts b/detectors/node/opentelemetry-resource-detector-azure/src/detectors/AzureVmDetector.ts
@@ -22,9 +22,15 @@ import {
   ResourceAttributes,
 } from '@opentelemetry/resources';
 import {
-  CloudPlatformValues,
-  CloudProviderValues,
-  SemanticResourceAttributes,
+  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';
 import {
   CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE,
@@ -90,14 +96,14 @@ class AzureVmResourceDetector implements DetectorSync {
     const attributes = {
       [AZURE_VM_SCALE_SET_NAME_ATTRIBUTE]: metadata['vmScaleSetName'],
       [AZURE_VM_SKU_ATTRIBUTE]: metadata['sku'],
-      [SemanticResourceAttributes.CLOUD_PLATFORM]: CloudPlatformValues.AZURE_VM,
-      [SemanticResourceAttributes.CLOUD_PROVIDER]: CloudProviderValues.AZURE,
-      [SemanticResourceAttributes.CLOUD_REGION]: metadata['location'],
+      [SEMRESATTRS_CLOUD_PLATFORM]: CLOUDPLATFORMVALUES_AZURE_VM,
+      [SEMRESATTRS_CLOUD_PROVIDER]: CLOUDPROVIDERVALUES_AZURE,
+      [SEMRESATTRS_CLOUD_REGION]: metadata['location'],
       [CLOUD_RESOURCE_ID_RESOURCE_ATTRIBUTE]: metadata['resourceId'],
-      [SemanticResourceAttributes.HOST_ID]: metadata['vmId'],
-      [SemanticResourceAttributes.HOST_NAME]: metadata['name'],
-      [SemanticResourceAttributes.HOST_TYPE]: metadata['vmSize'],
-      [SemanticResourceAttributes.OS_VERSION]: metadata['version'],
+      [SEMRESATTRS_HOST_ID]: metadata['vmId'],
+      [SEMRESATTRS_HOST_NAME]: metadata['name'],
+      [SEMRESATTRS_HOST_TYPE]: metadata['vmSize'],
+      [SEMRESATTRS_OS_VERSION]: metadata['version'],
     };
     return attributes;
   }
diff --git a/detectors/node/opentelemetry-resource-detector-azure/test/detectors/AzureAppServiceDetector.test.ts b/detectors/node/opentelemetry-resource-detector-azure/test/detectors/AzureAppServiceDetector.test.ts
@@ -16,7 +16,15 @@
 
 import * as assert from 'assert';
 import { azureAppServiceDetector } from '../../src/detectors/AzureAppServiceDetector';
-import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
+import { 
+  SEMRESATTRS_CLOUD_PLATFORM,
+  SEMRESATTRS_CLOUD_PROVIDER,
+  SEMRESATTRS_CLOUD_REGION,
+  SEMRESATTRS_DEPLOYMENT_ENVIRONMENT,
+  SEMRESATTRS_HOST_ID,
+  SEMRESATTRS_SERVICE_INSTANCE_ID,
+  SEMRESATTRS_SERVICE_NAME
+} from '@opentelemetry/semantic-conventions';
 import { azureFunctionsDetector } from '../../src';
 import { detectResourcesSync } from '@opentelemetry/resources';
 
@@ -46,35 +54,35 @@ describe('AzureAppServiceDetector', () => {
     assert.ok(resource);
     const attributes = resource.attributes;
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.SERVICE_NAME],
+      attributes[SEMRESATTRS_SERVICE_NAME],
       'test-site'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_PROVIDER],
+      attributes[SEMRESATTRS_CLOUD_PROVIDER],
       'azure'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_PLATFORM],
+      attributes[SEMRESATTRS_CLOUD_PLATFORM],
       'azure_app_service'
     );
     assert.strictEqual(
       attributes['cloud.resource_id'],
       `/subscriptions/${process.env.WEBSITE_OWNER_NAME}/resourceGroups/${process.env.WEBSITE_RESOURCE_GROUP}/providers/Microsoft.Web/sites/${process.env.WEBSITE_SITE_NAME}`
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_REGION],
+      attributes[SEMRESATTRS_CLOUD_REGION],
       'test-region'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT],
+      attributes[SEMRESATTRS_DEPLOYMENT_ENVIRONMENT],
       'test-slot'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.HOST_ID],
+      attributes[SEMRESATTRS_HOST_ID],
       'test-hostname'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.SERVICE_INSTANCE_ID],
+      attributes[SEMRESATTRS_SERVICE_INSTANCE_ID],
       'test-instance-id'
     );
     assert.strictEqual(
@@ -98,19 +106,19 @@ describe('AzureAppServiceDetector', () => {
     assert.ok(resource);
     const attributes = resource.attributes;
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_REGION],
+      attributes[SEMRESATTRS_CLOUD_REGION],
       'test-region'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT],
+      attributes[SEMRESATTRS_DEPLOYMENT_ENVIRONMENT],
       'test-slot'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.HOST_ID],
+      attributes[SEMRESATTRS_HOST_ID],
       'test-hostname'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.SERVICE_INSTANCE_ID],
+      attributes[SEMRESATTRS_SERVICE_INSTANCE_ID],
       'test-instance-id'
     );
     assert.strictEqual(
@@ -135,19 +143,19 @@ describe('AzureAppServiceDetector', () => {
     assert.ok(resource);
     const attributes = resource.attributes;
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_REGION],
+      attributes[SEMRESATTRS_CLOUD_REGION],
       'test-region'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT],
+      attributes[SEMRESATTRS_DEPLOYMENT_ENVIRONMENT],
       'test-slot'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.HOST_ID],
+      attributes[SEMRESATTRS_HOST_ID],
       'test-hostname'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.SERVICE_INSTANCE_ID],
+      attributes[SEMRESATTRS_SERVICE_INSTANCE_ID],
       'test-instance-id'
     );
     assert.strictEqual(
diff --git a/detectors/node/opentelemetry-resource-detector-azure/test/detectors/AzureFunctionsDetector.test.ts b/detectors/node/opentelemetry-resource-detector-azure/test/detectors/AzureFunctionsDetector.test.ts
@@ -17,7 +17,16 @@
 import * as assert from 'assert';
 import { azureFunctionsDetector } from '../../src/detectors/AzureFunctionsDetector';
 import { azureAppServiceDetector } from '../../src/detectors/AzureAppServiceDetector';
-import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
+import { 
+  SEMRESATTRS_CLOUD_PLATFORM,
+  SEMRESATTRS_CLOUD_PROVIDER,
+  SEMRESATTRS_CLOUD_REGION,
+  SEMRESATTRS_FAAS_INSTANCE,
+  SEMRESATTRS_FAAS_MAX_MEMORY,
+  SEMRESATTRS_FAAS_NAME,
+  SEMRESATTRS_FAAS_VERSION,
+  SEMRESATTRS_SERVICE_INSTANCE_ID,
+} from '@opentelemetry/semantic-conventions';
 import { detectResourcesSync } from '@opentelemetry/resources';
 import { AZURE_APP_SERVICE_STAMP_RESOURCE_ATTRIBUTE } from '../../src/types';
 
@@ -44,37 +53,37 @@ describe('AzureFunctionsDetector', () => {
     assert.ok(resource);
     const attributes = resource.attributes;
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.FAAS_NAME],
+      attributes[SEMRESATTRS_FAAS_NAME],
       'test-function'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_PROVIDER],
+      attributes[SEMRESATTRS_CLOUD_PROVIDER],
       'azure'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_PLATFORM],
+      attributes[SEMRESATTRS_CLOUD_PLATFORM],
       'azure_functions'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.CLOUD_REGION],
+      attributes[SEMRESATTRS_CLOUD_REGION],
       'test-region'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.FAAS_INSTANCE],
+      attributes[SEMRESATTRS_FAAS_INSTANCE],
       'test-instance-id'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.FAAS_MAX_MEMORY],
+      attributes[SEMRESATTRS_FAAS_MAX_MEMORY],
       '1000'
     );
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.FAAS_VERSION],
+      attributes[SEMRESATTRS_FAAS_VERSION],
       '~4'
     );
 
     // Should not detect app service values
     assert.strictEqual(
-      attributes[SemanticResourceAttributes.SERVICE_INSTANCE_ID],
+      attributes[SEMRESATTRS_SERVICE_INSTANCE_ID],
       undefined
     );
 
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@`
`48`	`48`	`},`
`49`	`49`	`"dependencies": {`
`50`	`50`	`"@opentelemetry/resources": "^1.10.1",`
`51`		`- "@opentelemetry/semantic-conventions": "^1.0.0"`
	`51`	`+ "@opentelemetry/semantic-conventions": "^1.22.0"`
`52`	`52`	`},`
`53`	`53`	`"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-azure#readme"`
`54`	`54`	`}`