summary: Azure function support (preview) (#2724)

feat: Preview support for instrumentation of "isolated" model Azure Functions. Instrumentation is disabled by default. Please reach out to your account team if you would like to try this new feature.

Author: tippmar-nr

.github/workflows/all_solutions.yml

@@ -215,7 +215,7 @@ jobs:
     strategy:
       matrix:
         namespace: [ 
-          AgentFeatures, 
+          AgentFeatures,
           AgentLogs, 
           AgentMetrics, 
           Api, 
@@ -232,6 +232,7 @@ jobs:
           AwsLambda.Sns,
           AwsLambda.Sqs,
           AwsLambda.WebRequest,
+          AzureFunction,
           BasicInstrumentation, 
           CatInbound, 
           CatOutbound, 
@@ -279,6 +280,8 @@ jobs:
       # Make this variable true to enable extra data-gathering and logging to help troubleshoot test failures, at the cost of additional time and resources
       enhanced_logging: false
       NR_DOTNET_TEST_SAVE_WORKING_DIRECTORY: 1
+      azure_func_exe_path: C:\ProgramData\chocolatey\lib\azure-functions-core-tools\tools\func.exe
+      NEW_RELIC_AZURE_FUNCTION_LOG_LEVEL_OVERRIDE: 1 # enables profiler debug logs when testing an azure function
 
     steps:
       - name: Checkout
@@ -330,6 +333,12 @@ jobs:
           pip install aiohttp
         shell: powershell
 
+      - name: Install Azure Functions Core Tools
+        if: matrix.namespace == 'AzureFunction'
+        run: |
+          choco install azure-functions-core-tools -y --params "'/x64'"
+        shell: powershell
+
       - name: Run Integration Tests
         run: |
           if ($Env:enhanced_logging -eq $True) {

FullAgent.sln

@@ -149,6 +149,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Home", "src\Agent\NewRelic\
 		{279F8AD0-C959-476F-BD58-3581D9A33238} = {279F8AD0-C959-476F-BD58-3581D9A33238}
 		{2E6CF650-CB50-453D-830A-D00F0540FC2C} = {2E6CF650-CB50-453D-830A-D00F0540FC2C}
 		{2FB30555-65A4-43D7-82AA-56BF203D3A96} = {2FB30555-65A4-43D7-82AA-56BF203D3A96}
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8} = {338AD83A-ED68-438A-8FB1-E93A3AE87EA8}
 		{37262C22-6A3A-4AD7-AB78-3853D2B2931D} = {37262C22-6A3A-4AD7-AB78-3853D2B2931D}
 		{3D69B4C9-FD16-461F-95AF-6FCA6EAA914E} = {3D69B4C9-FD16-461F-95AF-6FCA6EAA914E}
 		{44434B8F-EE14-49B0-855D-6EA0B48048BF} = {44434B8F-EE14-49B0-855D-6EA0B48048BF}
@@ -214,6 +215,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestSerializationHelpers.Te
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AwsSdk", "src\Agent\NewRelic\Agent\Extensions\Providers\Wrapper\AwsSdk\AwsSdk.csproj", "{37262C22-6A3A-4AD7-AB78-3853D2B2931D}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AzureFunction", "src\Agent\NewRelic\Agent\Extensions\Providers\Wrapper\AzureFunction\AzureFunction.csproj", "{338AD83A-ED68-438A-8FB1-E93A3AE87EA8}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -448,6 +451,10 @@ Global
 		{37262C22-6A3A-4AD7-AB78-3853D2B2931D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{37262C22-6A3A-4AD7-AB78-3853D2B2931D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{37262C22-6A3A-4AD7-AB78-3853D2B2931D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -516,10 +523,11 @@ Global
 		{173B1B8E-51D9-4639-88E9-B08065C2B47B} = {E5B988C0-5D19-407E-8210-71FFB90C579A}
 		{DC3E4801-A54A-42A4-AC45-DBD2F0CAE438} = {E5B988C0-5D19-407E-8210-71FFB90C579A}
 		{37262C22-6A3A-4AD7-AB78-3853D2B2931D} = {5E86E10A-C38F-48CB-ADE9-67B22BB2F50A}
+		{338AD83A-ED68-438A-8FB1-E93A3AE87EA8} = {5E86E10A-C38F-48CB-ADE9-67B22BB2F50A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
-		EnterpriseLibraryConfigurationToolBinariesPath = packages\Unity.2.1.505.2\lib\NET35
 		SolutionGuid = {D8B98070-6B8E-403C-A07F-A3F2E4A3A3D0}
+		EnterpriseLibraryConfigurationToolBinariesPath = packages\Unity.2.1.505.2\lib\NET35
 	EndGlobalSection
 	GlobalSection(TestCaseManagementSettings) = postSolution
 		CategoryFile = FullAgent.vsmdi

build/ArtifactBuilder/CoreAgentComponents.cs

@@ -58,6 +58,7 @@ protected override void CreateAgentComponents()
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Bedrock.dll",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsLambda.dll",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsSdk.dll",
+                $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AzureFunction.dll",
             };
 
             var wrapperXmls = new[]
@@ -84,6 +85,7 @@ protected override void CreateAgentComponents()
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Bedrock.Instrumentation.xml",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsLambda.Instrumentation.xml",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml",
+                $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml",
             };
 
             ExtensionXsd = $@"{SourceHomeBuilderPath}\extensions\extension.xsd";

build/ArtifactBuilder/FrameworkAgentComponents.cs

@@ -65,6 +65,7 @@ protected override void CreateAgentComponents()
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Kafka.dll",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Bedrock.dll",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsSdk.dll",
+                $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AzureFunction.dll",
             };
 
             var wrapperXmls = new[]
@@ -105,6 +106,7 @@ protected override void CreateAgentComponents()
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Kafka.Instrumentation.xml",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.Bedrock.Instrumentation.xml",
                 $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml",
+                $@"{SourceHomeBuilderPath}\extensions\NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml",
             };
 
             ExtensionXsd = $@"{SourceHomeBuilderPath}\extensions\extension.xsd";

src/Agent/MsiInstaller/Installer/Product.wxs

@@ -398,6 +398,9 @@ SPDX-License-Identifier: Apache-2.0
       <Component Id="AwsSdkWrapperComponent" Guid="{00D58C03-D517-41CA-BBAD-DAC605EADD3E}">
         <File Id="AwsSdkWrapperFile" Name="NewRelic.Providers.Wrapper.AwsSdk.dll" KeyPath="yes" Source="$(var.HomeFolderPath)\extensions\NewRelic.Providers.Wrapper.AwsSdk.dll" />
       </Component>
+      <Component Id="AzureFunctionWrapperComponent" Guid="{949893C5-0212-447A-88A3-DDE3638DDC6E}">
+        <File Id="AzureFunctionWrapperFile" Name="NewRelic.Providers.Wrapper.AzureFunction.dll" KeyPath="yes" Source="$(var.HomeFolderPath)\extensions\NewRelic.Providers.Wrapper.AzureFunction.dll" />
+      </Component>
     </ComponentGroup>
 
     <ComponentGroup Id="CoreNewRelic.Agent.Extensions" Directory="CoreProgramFilesExtensionsFolder">
@@ -470,7 +473,10 @@ SPDX-License-Identifier: Apache-2.0
       <Component Id="CoreAwsSdkWrapperComponent" Guid="{7C5E31CB-BA85-4E00-BA1B-99FA0B42E414}">
         <File Id="CoreAwsSdkWrapperFile" Name="NewRelic.Providers.Wrapper.AwsSdk.dll" KeyPath="yes" Source="$(var.HomeFolderPath)_coreclr\extensions\NewRelic.Providers.Wrapper.AwsSdk.dll" />
       </Component>
-    </ComponentGroup>
+      <Component Id="CoreAzureFunctionWrapperComponent" Guid="{6DC23A07-4063-462E-B43A-532D6F810AFE}">
+        <File Id="CoreAzureFunctionWrapperFile" Name="NewRelic.Providers.Wrapper.AzureFunction.dll" KeyPath="yes" Source="$(var.HomeFolderPath)_coreclr\extensions\NewRelic.Providers.Wrapper.AzureFunction.dll" />
+      </Component>
+   </ComponentGroup>
 
     <!-- Wrapper Instrumentation Files-->
     <ComponentGroup Id="NewRelic.Agent.Extensions.Instrumentation" Directory="FrameworkExtensionsFolder">
@@ -582,7 +588,10 @@ SPDX-License-Identifier: Apache-2.0
       <Component Id="AwsSdkInstrumentationComponent" Guid="{E719FAC8-8D69-41EA-9395-B71868DA7449}">
         <File Id="AwsSdkInstrumentationFile" Name="NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml" KeyPath="yes" Source="$(var.HomeFolderPath)\extensions\NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml" />
       </Component>
-    </ComponentGroup>
+      <Component Id="AzureFunctionInstrumentationComponent" Guid="{0D802289-3B47-4D94-8907-285FFD2779AB}">
+        <File Id="AzureFunctionInstrumentationFile" Name="NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml" KeyPath="yes" Source="$(var.HomeFolderPath)\extensions\NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml" />
+      </Component>
+   </ComponentGroup>
 
     <ComponentGroup Id="CoreNewRelic.Agent.Extensions.Instrumentation" Directory="CoreExtensionsFolder">
       <Component Id="CoreAspNetCoreInstrumentationComponent" Guid="{E69FA7D5-DC09-4146-A77E-6EE697EF2910}">
@@ -651,6 +660,9 @@ SPDX-License-Identifier: Apache-2.0
       <Component Id="CoreAwsSdkInstrumentationComponent" Guid="{CAB15FAE-EF3F-4998-9376-56DA4E11BAEF}">
         <File Id="CoreAwsSdkInstrumentationFile" Name="NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml" KeyPath="yes" Source="$(var.HomeFolderPath)_coreclr\extensions\NewRelic.Providers.Wrapper.AwsSdk.Instrumentation.xml"/>
       </Component>
+      <Component Id="CoreAzureFunctionInstrumentationComponent" Guid="{BF3BEE66-A563-4A59-ADEC-65C3381C582E}">
+        <File Id="CoreAzureFunctionInstrumentationFile" Name="NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml" KeyPath="yes" Source="$(var.HomeFolderPath)_coreclr\extensions\NewRelic.Providers.Wrapper.AzureFunction.Instrumentation.xml"/>
+      </Component>
     </ComponentGroup>
 
     <!-- Extensions XSD-->

src/Agent/NewRelic/Agent/Core/AgentManager.cs

@@ -284,7 +284,8 @@ private void LogInitialized()
                     "NEW_RELIC_FORCE_NEW_TRANSACTION_ON_NEW_THREAD",
                     "NEW_RELIC_CODE_LEVEL_METRICS_ENABLED",
                     "NEW_RELIC_SEND_DATA_ON_EXIT",
-                    "NEW_RELIC_SEND_DATA_ON_EXIT_THRESHOLD_MS"
+                    "NEW_RELIC_SEND_DATA_ON_EXIT_THRESHOLD_MS",
+                    "NEW_RELIC_AZURE_FUNCTION_MODE_ENABLED"
                 };
 
                 List<string> environmentVariablesSensitive = new List<string> {

src/Agent/NewRelic/Agent/Core/Attributes/AttributeDefinitionService.cs

@@ -125,6 +125,7 @@ public interface IAttributeDefinitions
         AttributeDefinition<object, object> GetCustomAttributeForTransaction(string name);
 
         AttributeDefinition<object, object> GetLambdaAttribute(string name);
+        AttributeDefinition<object, object> GetFaasAttribute(string name);
 
         AttributeDefinition<string, string> GetRequestParameterAttribute(string paramName);
 
@@ -188,6 +189,7 @@ public AttributeDefinitions(IAttributeFilter attribFilter)
         private readonly ConcurrentDictionary<string, AttributeDefinition<string, string>> _requestParameterAttributes = new ConcurrentDictionary<string, AttributeDefinition<string, string>>();
         private readonly ConcurrentDictionary<string, AttributeDefinition<string, string>> _requestHeadersAttributes = new ConcurrentDictionary<string, AttributeDefinition<string, string>>();
         private readonly ConcurrentDictionary<string, AttributeDefinition<object, object>> _lambdaAttributes = new ConcurrentDictionary<string, AttributeDefinition<object, object>>();
+        private readonly ConcurrentDictionary<string, AttributeDefinition<object, object>> _faasAttributes = new();
 
         private readonly ConcurrentDictionary<TypeAttributeValue, AttributeDefinition<TypeAttributeValue, string>> _typeAttributes = new ConcurrentDictionary<TypeAttributeValue, AttributeDefinition<TypeAttributeValue, string>>();
 
@@ -263,6 +265,22 @@ public AttributeDefinition<object, object> GetLambdaAttribute(string name)
             return _lambdaAttributes.GetOrAdd(name, CreateLambdaAttribute);
         }
 
+        private AttributeDefinition<object, object> CreateFaasAttribute(string attribName)
+        {
+            return AttributeDefinitionBuilder
+                .Create<object, object>(attribName, AttributeClassification.Intrinsics)
+                .AppliesTo(AttributeDestinations.TransactionTrace)
+                .AppliesTo(AttributeDestinations.TransactionEvent)
+                .AppliesTo(AttributeDestinations.SpanEvent)
+                .Build(_attribFilter);
+        }
+
+        public AttributeDefinition<object, object> GetFaasAttribute(string name)
+        {
+            return _faasAttributes.GetOrAdd(name, CreateFaasAttribute);
+        }
+
+
         public AttributeDefinition<object, object> GetCustomAttributeForTransaction(string name)
         {
             return _trxCustomAttributes.GetOrAdd(name, CreateCustomAttributeForTransaction);

src/Agent/NewRelic/Agent/Core/Config/BootstrapConfiguration.cs

@@ -20,6 +20,7 @@ public interface IBootstrapConfiguration
         ILogConfig LogConfig { get; }
         string ServerlessFunctionName { get; }
         string ServerlessFunctionVersion { get; }
+        bool AzureFunctionModeDetected { get; }
     }
 
     /// <summary>
@@ -130,6 +131,8 @@ public string AgentEnabledAt
 
         public ILogConfig LogConfig { get; private set; }
 
+        public bool AzureFunctionModeDetected => ConfigLoaderHelpers.GetEnvironmentVar("FUNCTIONS_WORKER_RUNTIME") != null;
+
         private bool CheckServerlessModeEnabled(configuration localConfiguration)
         {
             // We may need these later even if we don't use it now.

src/Agent/NewRelic/Agent/Core/Config/Configuration.cs

@@ -5722,6 +5722,8 @@ public partial class configurationUtilization
 
         private bool detectKubernetesField;
 
+        private bool detectAzureFunctionField;
+        
         private System.Nullable<int> logicalProcessorsField;
 
         private System.Nullable<int> totalRamMibField;
@@ -5739,6 +5741,7 @@ public configurationUtilization()
             this.detectPcfField = true;
             this.detectDockerField = true;
             this.detectKubernetesField = true;
+            this.detectAzureFunctionField = true;
         }
 
         [System.Xml.Serialization.XmlAttributeAttribute()]
@@ -5825,6 +5828,20 @@ public bool detectKubernetes
             }
         }
 
+        [System.Xml.Serialization.XmlAttributeAttribute()]
+        [System.ComponentModel.DefaultValueAttribute(true)]
+        public bool detectAzureFunction
+        {
+            get
+            {
+                return this.detectAzureFunctionField;
+            }
+            set
+            {
+                this.detectAzureFunctionField = value;
+            }
+        }
+        
         [System.Xml.Serialization.XmlAttributeAttribute()]
         public int logicalProcessors
         {

src/Agent/NewRelic/Agent/Core/Config/Configuration.xsd

@@ -1962,6 +1962,13 @@
                             </xs:annotation>
                         </xs:attribute>
 
+                        <xs:attribute name="detectAzureFunction" type="xs:boolean" default="true"  use="optional">
+                            <xs:annotation>
+                                <xs:documentation>
+                                    This attribute controls whether to look for Azure Function environment variables (optional). The default is true.
+                                </xs:documentation>
+                            </xs:annotation>
+                        </xs:attribute>
                         <xs:attribute name="logicalProcessors" type="xs:int" use="optional">
                             <xs:annotation>
                                 <xs:documentation>