--- title: "Azure functions" slug: "azurefunctions" description: "Secure your Azure Functions with Traceable’s .NET agent. Learn how to configure, deploy, and monitor API security using Traceable’s seamless integration with Azure Functions." updated: 2024-12-26T05:15:52Z published: 2024-12-26T05:15:52Z --- > ## Documentation Index > Fetch the complete documentation index at: https://traceabledocs.document360.io/llms.txt > Use this file to discover all available pages before exploring further. # Azure functions .NET is a software framework developed by Microsoft that runs primarily on Microsoft Windows. It includes an extensive library of pre-written code and provides a runtime environment for executing code written in various programming languages. The framework is designed to provide a consistent object-oriented programming environment, whether code is executed on a server, browser, or desktop. It also includes a standard set of libraries for tasks such as connecting to databases, creating graphical user interfaces, and handling security. Traceable provides a .NET agent to capture the requests inline. If, for some reason, Traceable cannot capture the request, the requests are passed through to the application. The following is a high-level deployment diagram: ![traceable_dotNET_deployment](https://cdn.document360.io/24f14f07-13d1-4684-8fae-6d8f811768ee/Images/Documentation/traceable_dotNET_deployment.png) --- ## Before you begin Make a note of the following before proceeding with Traceable’s .NET agent configuration: - Make sure that the Traceable Platform agent is already installed. For more installation information, see [Platform agent](/docs/tpa). - Make a note of the Traceable Platform agent IP address. This would be used in the configuration later. - Note that the Traceable Platform agent needs to be connected to non-TLS port 4317. - Ensure to allow the 4317 port as a firewall rule on the machine where the Traceable Platform agent is installed. For example, on a Windows machine’s internal firewall, you must allow inbound connections on the 4317 port. - Decide on a service name. This is required during configuration and is displayed in the Traceable Platform. - Traceable supports Azure Function with HTTP Trigger template v4 running on .NET 6 on .NET agent. - This document expects that you know the following: - In-process runtime - Isolated runtime - Built-in Model - AspNetCore Model --- ## Supported framework Traceable’s .NET agent supports Azure Functions. In the context of the Azure function, there are two different runtimes: In-process and isolated. Traceable supports both **In-process** and **Isolated** runtimes. At present, Traceable supports only **HTTP trigger** template-based functions. The HTTP Trigger template is an Azure Functions template that allows you to create functions that respond to HTTP requests. When you create an Azure Function using the HTTP Trigger template, you create an endpoint that can be invoked via HTTP. --- ## Configuration Complete the following steps to configure Traceable’s .NET agent with Azure Functions: 1. Add the `Traceable.Agent` package to the project from NuGet gallery. ```plaintext dotnet add package Traceable.Agent ``` 2. In the Azure portal, navigate to your project’s root directory and make the following code change to the `startup.cs` file according to your runtime (in-process or isolated). In Azure Functions projects, the `startup.cs` file is a crucial component for configuring the application's services and request processing pipeline. It's typically located in the project's root directory. ****In-process Runtime**** ```csharp using Microsoft.AspNetCore.Server.Kestrel; using Microsoft.Azure.Functions.Extensions.DependencyInjection; using Microsoft.Extensions.DependencyInjection; using Traceable; //<- additional change for Traceable [assembly: FunctionsStartup(typeof(Company.Function.Startup))] namespace Company.Function {    public class Startup : FunctionsStartup    {        public override void Configure(IFunctionsHostBuilder builder)        {            // changes for traceable begin            var traceableAgent = TraceableAgentBuilder.CreateBuilder()            .AddInstrumentation(Instrumentations.AzureFunctionsInProcess)            .Build();            builder.Services.AddSingleton(traceableAgent);            // changes for traceable end                        builder.Services.AddLogging();        }    } } ``` Make a note of the code you need to insert: ```csharp // changes for traceable begin            var traceableAgent = TraceableAgentBuilder.CreateBuilder()            .AddInstrumentation(Instrumentations.AzureFunctionsInProcess)            .Build();            builder.Services.AddSingleton(traceableAgent); // changes for traceable end ``` > [!NOTE] > Note > > If you are not using the above `class`, you can create one by referring to [Microsoft documentation](https://learn.microsoft.com/en-us/azure/azure-functions/functions-dotnet-dependency-injection). ****Isolated Runtime**** - For Built-In Model ```csharp using Microsoft.Azure.Functions.Worker; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Traceable.Instrumentation.AzureFunctions.Isolated.Implementation; var host = new HostBuilder()    .ConfigureFunctionsWorkerDefaults(        (app) =>        {            // Inject Traceable Middleware            app.UseMiddleware();        }    )    .ConfigureServices(services =>    {        services.AddApplicationInsightsTelemetryWorkerService();        services.ConfigureFunctionsApplicationInsights();        // changes for Traceable Begin        var ta = Traceable            .TraceableAgentBuilder.CreateBuilder()            .AddAzureFunctionsIsolatedInstrumentation(services)            .Build();        services.AddSingleton(ta);        // changes for Traceable End    })    .Build(); host.Run(); ``` Make a note of the code you need to insert above: ```csharp // Inject Traceable Middleware app.UseMiddleware(); ``` AND ```csharp // changes for Traceable Begin var ta = Traceable    .TraceableAgentBuilder.CreateBuilder()    .AddAzureFunctionsIsolatedInstrumentation(services)    .Build(); services.AddSingleton(ta); // changes for Traceable End ``` - For AspNetCore-based Model ```csharp using Microsoft.Azure.Functions.Worker; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.DependencyInjection; using Traceable.Instrumentation.AzureFunctions.Isolated.Implementation; var host = new HostBuilder()    .ConfigureFunctionsWebApplication((app)=> {        // Inject Traceable Middleware        app.UseMiddleware();    })    .ConfigureServices(services => {        services.AddApplicationInsightsTelemetryWorkerService();        services.ConfigureFunctionsApplicationInsights();        // changes for Traceable Begin        var ta = Traceable            .TraceableAgentBuilder.CreateBuilder()            .AddAzureFunctionsIsolatedInstrumentation(services)            .Build();        services.AddSingleton(ta);        // changes for Traceable End    })    .Build(); host.Run(); ``` Make a note of the code you need to insert above: ```csharp // Inject Traceable Middleware app.UseMiddleware(); ``` AND ```csharp // changes for Traceable Begin var ta = Traceable    .TraceableAgentBuilder.CreateBuilder()    .AddAzureFunctionsIsolatedInstrumentation(services)    .Build(); services.AddSingleton(ta); // changes for Traceable End ``` 3. Add the following environment variables for configuration. In your Azure function application, navigate to **Settings** → **Configuration** to add the environment variable and **save** the configuration. ![](https://cdn.document360.io/24f14f07-13d1-4684-8fae-6d8f811768ee/Images/Documentation/traceable_dotNET_azure_function_add_env_variable(1).png) --- | Environment variable | Description | | --- | --- | | `TA_SERVICE_NAME` | (Optional) The name with which you would like to identify the service in Traceable Platform. The default service name is `dotnetagent` when no service name is assigned. | | `TA_REPORTING_ENDPOINT` | The endpoint for reporting the traces. This is a mandatory field. - OTLP - For OTLP reporter, use [http://:4317](http://:4317) > **Note** > > HTTPS communication is currently not supported. | | `TA_DATA_CAPTURE_HTTP_HEADERS_REQUEST` | (Optional) When set to `false`, the agent disables request capturing. | | `TA_DATA_CAPTURE_HTTP_HEADERS_RESPONSE` | (Optional) When set to `false`, the agent disables response capturing. | | `TA_DATA_CAPTURE_HTTP_BODY_REQUEST` | (Optional) When set to `false`, the agent disables request body capturing. | | `TA_DATA_CAPTURE_HTTP_BODY_RESPONSE` | (Optional) When set to `false`, the agent disables response body capturing. | | `TA_DATA_CAPTURE_BODY_MAX_SIZE_BYTES` | (Optional) Configure the maximum size of the body to capture. The default value is 128 KiB. | | `TA_DATA_CAPTURE_ALLOWED_CONTENT_TYPES` | (Optional) Comma-separated values of content type to capture. The default is [json, x-www-form-urlencoded]. For example, [json] will record any request body with a content-type header that includes “json”. | | `TA_ENABLED` | (Optional) Set it to `false`, if you wish to disable Traceable’s .NET agent. | | `TA_TELEMETRY_STARTUP_SPAN_ENABLED` | (Optional) When set to `true`, an internal span is created and exported when the agent is initialized and started. | 4. Deploy the application to Azure. --- ## Verification Send data to your application. On successful configuration, you will see Span data in the Traceable Platform. ![](https://cdn.document360.io/24f14f07-13d1-4684-8fae-6d8f811768ee/Images/Documentation/traceable_dotNET_configuration_verification(1).png) --- ## Upgrade Complete the following steps to upgrade the package: 1. Enter the following command to upgrade: ```plaintext dotnet add package Traceable.Agent ``` 2. Deploy the application to Azure. --- ## Uninstall Complete the following steps to uninstall the .NET agent: 1. Remove the .NET agent bootstrap code from `startup.cs` file. 2. Remove the Traceable.Agent package dependency from the project `csproj` file. Following is an example of `csproj` file. Remove `<PackageReference Include="Traceable.Agent" Version="1.0.0-rc.5" />` from `csproj` file. ```plaintext      net6.0    v4    azure_app_inprocess                                                                  PreserveNewest              PreserveNewest      Never       ``` 3. Perform a dotnet restore. ```plaintext dotnet restore ``` 4. Deploy the application to Azure. Azure Functions is a serverless compute service provided by Microsoft Azure. It allows you to run small pieces of code, known as functions, without having to worry about managing the infrastructure they run on. Azure Functions are event-driven, meaning they can be triggered by various events such as HTTP requests, timers, message queue events, database changes, file uploads, and more. NuGet is the official package manager for the Microsoft development platform, including .NET. The NuGet Gallery is a repository hosting thousands of packages created by Microsoft and third-party developers. These packages contain reusable code, libraries, frameworks, and tools that developers can easily integrate into their .NET projects.