[SVLS-8161] Update Azure Function metadata detection logic (#7100)

* Check DD_AZURE_RESOURCE_GROUP env var when detecting resource group metadata for Azure Flex Consumption Functions

* Add tests, add DD_AZURE_RESOURCE_GROUP to supported configurations

* Make flex consumption function detection a function

Author: kathiehuang

packages/dd-trace/src/azure_metadata.js

@@ -3,7 +3,7 @@
 // Modeled after https://github.com/DataDog/libdatadog/blob/f3994857a59bb5679a65967138c5a3aec418a65f/ddcommon/src/azure_app_services.rs
 
 const os = require('os')
-const { getIsAzureFunction } = require('./serverless')
+const { getIsAzureFunction, getIsFlexConsumptionAzureFunction } = require('./serverless')
 const { getEnvironmentVariable, getEnvironmentVariables } = require('../../dd-trace/src/config-helper')
 
 function extractSubscriptionID (ownerName) {
@@ -38,6 +38,7 @@ function buildMetadata () {
   const {
     COMPUTERNAME,
     DD_AAS_DOTNET_EXTENSION_VERSION,
+    DD_AZURE_RESOURCE_GROUP,
     FUNCTIONS_EXTENSION_VERSION,
     FUNCTIONS_WORKER_RUNTIME,
     FUNCTIONS_WORKER_RUNTIME_VERSION,
@@ -56,7 +57,12 @@ function buildMetadata () {
     ? ['functionapp', 'function']
     : ['app', 'app']
 
-  const resourceGroup = WEBSITE_RESOURCE_GROUP ?? extractResourceGroup(WEBSITE_OWNER_NAME)
+  // Azure Functions on Flex Consumption plans require the `DD_AZURE_RESOURCE_GROUP` env var.
+  // If this logic ever changes, update the logic in `libdatadog`, `serverless-components/src/datadog-trace-agent`,
+  // and the serverless compat layers accordingly.
+  const resourceGroup = getIsFlexConsumptionAzureFunction()
+    ? (DD_AZURE_RESOURCE_GROUP ?? WEBSITE_RESOURCE_GROUP ?? extractResourceGroup(WEBSITE_OWNER_NAME))
+    : (WEBSITE_RESOURCE_GROUP ?? extractResourceGroup(WEBSITE_OWNER_NAME))
 
   return trimObject({
     extensionVersion: DD_AAS_DOTNET_EXTENSION_VERSION,

packages/dd-trace/src/profiling/config.js

@@ -12,9 +12,10 @@ const SpaceProfiler = require('./profilers/space')
 const EventsProfiler = require('./profilers/events')
 const { oomExportStrategies, snapshotKinds } = require('./constants')
 const { GIT_REPOSITORY_URL, GIT_COMMIT_SHA } = require('../plugins/util/tags')
+const { getIsAzureFunction } = require('../serverless')
 const { tagger } = require('./tagger')
 const { isFalse, isTrue } = require('../util')
-const { getAzureTagsFromMetadata, getAzureAppMetadata } = require('../azure_metadata')
+const { getAzureTagsFromMetadata, getAzureAppMetadata, getAzureFunctionMetadata } = require('../azure_metadata')
 const { getEnvironmentVariables } = require('../config-helper')
 const defaults = require('../config_defaults')
 
@@ -73,7 +74,7 @@ class Config {
       tagger.parse(DD_TAGS),
       tagger.parse(options.tags),
       tagger.parse({ env, host, service, version, functionname }),
-      getAzureTagsFromMetadata(getAzureAppMetadata())
+      getAzureTagsFromMetadata(getIsAzureFunction() ? getAzureFunctionMetadata() : getAzureAppMetadata())
     )
 
     // Add source code integration tags if available

packages/dd-trace/src/serverless.js

@@ -21,6 +21,10 @@ function getIsAzureFunction () {
   return isAzureFunction
 }
 
+function getIsFlexConsumptionAzureFunction () {
+  return getIsAzureFunction() && getEnvironmentVariable('WEBSITE_SKU') === 'FlexConsumption'
+}
+
 function isInServerlessEnvironment () {
   const inAWSLambda = getEnvironmentVariable('AWS_LAMBDA_FUNCTION_NAME') !== undefined
   const isGCPFunction = getIsGCPFunction()
@@ -32,5 +36,6 @@ function isInServerlessEnvironment () {
 module.exports = {
   getIsGCPFunction,
   getIsAzureFunction,
+  getIsFlexConsumptionAzureFunction,
   isInServerlessEnvironment
 }

packages/dd-trace/src/supported-configurations.json

@@ -37,6 +37,7 @@
     "DD_APPSEC_STACK_TRACE_ENABLED": ["A"],
     "DD_APPSEC_TRACE_RATE_LIMIT": ["A"],
     "DD_APPSEC_WAF_TIMEOUT": ["A"],
+    "DD_AZURE_RESOURCE_GROUP": ["A"],
     "DD_CIVISIBILITY_AGENTLESS_ENABLED": ["A"],
     "DD_CIVISIBILITY_AGENTLESS_URL": ["A"],
     "DD_CIVISIBILITY_AUTO_INSTRUMENTATION_PROVIDER": ["A"],

packages/dd-trace/test/azure_metadata.spec.js

@@ -6,7 +6,7 @@ const os = require('node:os')
 
 require('./setup/core')
 
-const { getAzureAppMetadata, getAzureTagsFromMetadata } = require('../src/azure_metadata')
+const { getAzureAppMetadata, getAzureTagsFromMetadata, getAzureFunctionMetadata } = require('../src/azure_metadata')
 
 describe('Azure metadata', () => {
   describe('for apps is', () => {
@@ -107,4 +107,45 @@ describe('Azure metadata', () => {
     }
     assert.deepStrictEqual(getAzureTagsFromMetadata(getAzureAppMetadata()), expected)
   })
+
+  it('uses DD_AZURE_RESOURCE_GROUP for Flex Consumption Azure Functions', () => {
+    delete process.env.WEBSITE_RESOURCE_GROUP
+    delete process.env.WEBSITE_OS
+    delete process.env.DD_AAS_DOTNET_EXTENSION_VERSION
+    process.env.COMPUTERNAME = 'flex_function'
+    process.env.WEBSITE_SITE_NAME = 'flex_function_app'
+    process.env.WEBSITE_OWNER_NAME = 'subscription_id+flex-regionwebspace'
+    process.env.WEBSITE_INSTANCE_ID = 'instance_id'
+    process.env.WEBSITE_SKU = 'FlexConsumption'
+    process.env.FUNCTIONS_EXTENSION_VERSION = '4'
+    process.env.FUNCTIONS_WORKER_RUNTIME = 'node'
+    process.env.DD_AZURE_RESOURCE_GROUP = 'flex_resource_group'
+    const expected = {
+      functionRuntimeVersion: '4',
+      instanceID: 'instance_id',
+      instanceName: 'flex_function',
+      operatingSystem: os.platform(),
+      resourceGroup: 'flex_resource_group',
+      resourceID:
+        '/subscriptions/subscription_id/resourcegroups/flex_resource_group' +
+        '/providers/microsoft.web/sites/flex_function_app',
+      runtime: 'node',
+      siteKind: 'functionapp',
+      siteName: 'flex_function_app',
+      siteType: 'function',
+      subscriptionID: 'subscription_id'
+    }
+    assert.deepStrictEqual(getAzureFunctionMetadata(), expected)
+  })
+
+  it('uses WEBSITE_RESOURCE_GROUP for non-Flex Consumption plans', () => {
+    process.env.WEBSITE_SITE_NAME = 'regular_function_app'
+    process.env.WEBSITE_RESOURCE_GROUP = 'regular_resource_group'
+    process.env.WEBSITE_OWNER_NAME = 'subscription_id+extracted_group-regionwebspace'
+    process.env.WEBSITE_SKU = 'Consumption'
+    process.env.FUNCTIONS_EXTENSION_VERSION = '4'
+    process.env.DD_AZURE_RESOURCE_GROUP = 'should_not_use_this'
+    const metadata = getAzureFunctionMetadata()
+    assert.strictEqual(metadata.resourceGroup, 'regular_resource_group')
+  })
 })