Edit

Share via


Enable the .NET Profiler for Azure App Service apps in Linux

By using Application Insights Profiler for .NET, you can track how much time is spent in each method of your live ASP.NET Core web apps. This article focuses on web apps hosted in Linux. You can also experiment by using Windows and Mac development environments.

In this article, you:

  • Set up an ASP.NET Core web application hosted on Linux on your local computer.
  • Create an App Service using the Azure portal.
  • Deploy your local ASP.NET Core project to Azure using local Git.
  • Add the Profiler to the ASP.NET Core web application.

Note

Review the Application Insights SDK support guidance for the Classic API SDK support policy.

Caution

For new applications, use the Azure Monitor OpenTelemetry Distro. It provides a similar experience and comparable functionality to the Application Insights SDK. To migrate to an OpenTelemetry based offering, review the migration guidance.

Prerequisites

Set up the project locally

  1. Open a command prompt window on your computer.

  2. Create an ASP.NET Core MVC web application:

    dotnet new mvc -n LinuxProfilerTest
    
  3. Change the working directory to the root folder for the project.

  4. Add the NuGet packages to collect the Profiler traces:

    dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore --prerelease
    dotnet add package Azure.Monitor.OpenTelemetry.Profiler --prerelease
    

Enable the .NET Profiler

  1. In your preferred code editor, verify that you added the two packages for the Azure Monitor OpenTelemetry Profiler for .NET to Program.cs. Add custom Profiler settings, if applicable.

    In your project's .csproj file, verify that you added the following lines:

    <ItemGroup>
        <PackageReference Include="Azure.Monitor.OpenTelemetry.AspNetCore" Version="[1.*-*, 2.0.0)" />
        <PackageReference Include="Azure.Monitor.OpenTelemetry.Profiler" Version="[1.*-*, 2.0.0)" />
    </ItemGroup>
    

    In your Program.cs file, verify that you added the following lines:

    using Azure.Monitor.OpenTelemetry.AspNetCore;
    using Azure.Monitor.OpenTelemetry.Profiler;
    
    ///
    
    builder.Services.AddOpenTelemetry()
        .UseAzureMonitor()          // Enable Azure Monitor OpenTelemetry distro for ASP.NET Core
        .AddAzureMonitorProfiler(); // Add Azure Monitor Profiler    
    
  2. Save and commit your changes to the local repository:

    git init
    git add .
    git commit -m "first commit"
    

Create the Linux web app to host your project

  1. In the Azure portal, search for and select App Services, and then select Create > Web App.

  2. Create a web app environment by using App Service on Linux.

    Screenshot that shows creating the Linux web app.

  3. Go to your new web app resource. In the left menu, select Deployment > Deployment Center, and then select FTPS Credentials to create the deployment credentials. Make a note of your credentials to use later.

    Screenshot that shows creating the deployment credentials.

  4. Select Save.

  5. Select the Settings tab.

  6. To set up a local Git repository in the web app, select Source, and then select Local Git.

    Screenshot that shows view deployment options in a dropdown.

  7. Select Save to create a Git repository with a Git clone URI.

    Screenshot that shows setting up the local Git repository.

    For more deployment options, see the App Service documentation.

Deploy your project

You can deploy code to Azure App Service in various ways. The simplest way is to deploy by using local Git. For more information, see Deploy to Azure App Service by using local Git.

  1. In your command prompt window, browse to the root folder for your project. Add a Git remote repository to point to the repository on App Service:

    git remote add azure https://<username>@<app_name>.scm.azurewebsites.net:443/<app_name>.git
    

    For this value, go to the Overview page for your web app. Copy Git clone url.

  2. Deploy the project by pushing the changes to Azure:

    git push azure main
    

Add Application Insights to monitor your web app

You can enable Application Insights while creating an App Service, which sets the connection string automatically.

Copy and paste your connection string from your Application Insights resource to monitor your web app.

  1. Copy the connection string.
  2. Paste the connection string into your environment.

Troubleshooting

If you can't find traces from your app, try the steps in this troubleshooting guide.

If you are unable to find traces from your app, consider following the steps in this troubleshooting guide.

Next step