Enabling the .NET Profiler

To install the .NET Profiler machine-wide:

1. Download the latest .NET Tracer package that supports your operating system and architecture.

2. Run one of the following commands to install the package and create the .NET log directory /var/log/datadog/dotnet with the appropriate permissions:

   Debian or Ubuntu

   sudo dpkg -i ./datadog-dotnet-apm_<TRACER_VERSION>_amd64.deb && sudo /opt/datadog/createLogPath.sh

   CentOS 7+ or Fedora

   sudo rpm -Uvh datadog-dotnet-apm<TRACER_VERSION>-1.x86_64.rpm && sudo /opt/datadog/createLogPath.sh

   Alpine or other musl-based distributions

   sudo tar -C /opt/datadog -xzf datadog-dotnet-apm<TRACER_VERSION>-musl.tar.gz && sudo sh /opt/datadog/createLogPath.sh

   Other distributions

   sudo tar -C /opt/datadog -xzf datadog-dotnet-apm<TRACER_VERSION>-tar.gz && sudo /opt/datadog/createLogPath.sh

To install the .NET Profiler machine-wide:

1. Install or upgrade to the latest version, using the .NET Monitoring MSI installer. Continuous Profiler supports 64-bit Windows, so you need the file like datadog-dotnet-apm-<VERSION>-x64.msi.

2. Run the installer with administrator privileges.

To install the .NET Profiler per-application:

1. Add the Datadog.Trace.Bundle NuGet package to your application.

To install the .NET Profiler per-webapp:

1. Install the Azure App Service Datadog APM Extension for Windows or use the Linux setup for your webapp.

3. Set the following required environment variables for automatic instrumentation to attach to your application:

   CORECLR_ENABLE_PROFILING=1
   CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   CORECLR_PROFILER_PATH=/opt/datadog/Datadog.Trace.ClrProfiler.Native.so
   DD_DOTNET_TRACER_HOME=/opt/datadog
   LD_PRELOAD=/opt/datadog/continuousprofiler/Datadog.Linux.ApiWrapper.x64.so
   DD_PROFILING_ENABLED=1
   DD_ENV=production
   DD_VERSION=1.2.3
   

4. For standalone applications, manually restart the application as you normally would.

5. A minute or two after starting your application, your profiles appear on the Datadog APM > Profiler page.

1. With Single Step Instrumentation, set the following required environment variables for automatic instrumentation to attach to your application:

   LD_PRELOAD=/opt/datadog/apm/library/dotnet/continuousprofiler/Datadog.Linux.ApiWrapper.x64.so
   DD_PROFILING_ENABLED=1
   DD_ENV=production
   DD_VERSION=1.2.3
   

2. For standalone applications, manually restart the application as you normally would.

3. A minute or two after starting your application, your profiles appear on the Datadog APM > Profiler page.

3. Set needed environment variables to configure and enable Profiler. To enable the Profiler for IIS applications, it is required to set the DD_PROFILING_ENABLED environment variable in the Registry under HKLM\System\CurrentControlSet\Services\WAS and HKLM\System\CurrentControlSet\Services\W3SVC nodes.

   Starting v2.14.0, you don't need to set CORECLR_PROFILER or COR_PROFILER if you installed the tracer using the MSI.

   With the Registry Editor:

   In the Registry Editor, modify the multi-string value called Environment in the HKLM\System\CurrentControlSet\Services\WAS and HKLM\System\CurrentControlSet\Services\W3SVC nodes and set the value data as follows:

   For .NET Core and .NET 5+:

   CORECLR_ENABLE_PROFILING=1
   CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   DD_PROFILING_ENABLED=1
   DD_ENV=production
   DD_VERSION=1.2.3
   

   For .NET Framework:

   COR_ENABLE_PROFILING=1
   COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   DD_PROFILING_ENABLED=1
   DD_ENV=production
   DD_VERSION=1.2.3
   

   Note: the environment variables are applied for all IIS applications. Starting with IIS 10, you can set environment variables for each IIS application in the C:\Windows\System32\inetsrv\config\applicationhost.config file. Read the Microsoft documentation for more details.

4. Completely stop and start IIS by running the following commands as an administrator:

   net stop /y was
   net start w3svc
   

   Note: Use stop and start commands. A reset or restart does not always work.

5. A minute or two after starting your application, your profiles appear on the Datadog APM > Profiler page.

3. Set needed environment variables to configure and enable Profiler. To enable the Profiler for your service, it is required to set the DD_PROFILING_ENABLED environment variable in the Registry key associated to the service. If the profiler is running alone (the tracer is deactivated), you can optionally add the DD_SERVICE, DD_ENV and DD_VERSION environment variables.

   Starting v2.14.0, you don't need to set CORECLR_PROFILER or COR_PROFILER if you installed the tracer using the MSI.

   With the Registry Editor:

   In the Registry Editor, create a multi-string value called Environment in the HKLM\System\CurrentControlSet\Services\MyService key and set the value data to:

   For .NET Core and .NET 5+:

   CORECLR_ENABLE_PROFILING=1
   CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   DD_PROFILING_ENABLED=1
   DD_SERVICE=MyService
   DD_ENV=production
   DD_VERSION=1.2.3
   

   For .NET Framework:

   COR_ENABLE_PROFILING=1
   COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   DD_PROFILING_ENABLED=1
   DD_SERVICE=MyService
   DD_ENV=production
   DD_VERSION=1.2.3
   

   With a PowerShell script:

   For .NET Core and .NET 5+:

   [string[]] $v = @(
       "CORECLR_ENABLE_PROFILING=1",
       "CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}",
       "DD_PROFILING_ENABLED=1",
       "DD_SERVICE=MyService",
       "DD_ENV=production",
       "DD_VERSION=1.2.3"
   )
   Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\MyService -Name Environment -Value $v
   

   For .NET Framework:

   [string[]] $v = @(
       "COR_ENABLE_PROFILING=1",
       "COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}",
       "DD_PROFILING_ENABLED=1",
       "DD_SERVICE=MyService",
       "DD_ENV=production",
       "DD_VERSION=1.2.3"
   )
   Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\MyService -Name Environment -Value $v
   

4. A minute or two after you start your application, your profiles appear on the Datadog APM > Profiler page.

3. Set needed environment variables to configure and enable Profiler for a non-service application, such as console, ASP.NET (Core), Windows Forms, or WPF. To enable the Profiler for Standalone applications, it is required to set the DD_PROFILING_ENABLED environment variable. If the profiler is running alone (the tracer is deactivated), you can optionally set the DD_SERVICE, DD_ENV and DD_VERSION environment variables. The recommended approach is to create a batch file that sets these and starts the application, and run your application using the batch file.

   For .NET Core and .NET 5+:

   SET CORECLR_ENABLE_PROFILING=1
   SET CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   SET DD_PROFILING_ENABLED=1
   SET DD_SERVICE=MyService
   SET DD_ENV=production
   SET DD_VERSION=1.2.3
   
   REM start the application here
   

   For .NET Framework:

   SET COR_ENABLE_PROFILING=1
   SET COR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   SET DD_PROFILING_ENABLED=1
   SET DD_SERVICE=MyService
   SET DD_ENV=production
   SET DD_VERSION=1.2.3
   
   REM start the application here
   

4. A minute or two after you start your application, your profiles appear on the Datadog APM > Profiler page.

2. Set the following required environment variables for profiling to attach to your application:

   CORECLR_ENABLE_PROFILING=1
   CORECLR_PROFILER={846F5F1C-F9AE-4B07-969E-05C26BC060D8}
   CORECLR_PROFILER_PATH=<System-dependent path>
   DD_PROFILING_ENABLED=1
   LD_PRELOAD=<System-dependent path>
   DD_SERVICE=MyService
   DD_ENV=production
   DD_VERSION=1.2.3
   DD_DOTNET_TRACER_HOME=<APP_DIRECTORY>/datadog
   

   The value for the <APP_DIRECTORY> placeholder is the path to the directory containing the application’s .dll files. The value for the CORECLR_PROFILER_PATH environment variable varies based on the system where the application is running:

   Operating System and Process Architecture	CORECLR_PROFILER_PATH Value	LD_PRELOAD Value
   Alpine Linux x64	<APP_DIRECTORY>/datadog/linux-musl-x64/Datadog.Trace.ClrProfiler.Native.so	<APP_DIRECTORY>/datadog/linux-musl-x64/Datadog.Linux.ApiWrapper.x64.so
   Linux x64	<APP_DIRECTORY>/datadog/linux-x64/Datadog.Trace.ClrProfiler.Native.so	<APP_DIRECTORY>/datadog/linux-x64/Datadog.Linux.ApiWrapper.x64.so
   Linux ARM64	<APP_DIRECTORY>/datadog/linux-arm64/Datadog.Trace.ClrProfiler.Native.so	<APP_DIRECTORY>/datadog/linux-arm64/Datadog.Linux.ApiWrapper.x64.so
   Windows x64	<APP_DIRECTORY>\datadog\win-x64\Datadog.Trace.ClrProfiler.Native.dll	N/A
   Windows x86	<APP_DIRECTORY>\datadog\win-x86\Datadog.Trace.ClrProfiler.Native.dll	N/A

3. For Docker images running on Linux, configure the image to run the createLogPath.sh script:

   RUN /<APP_DIRECTORY>/datadog/createLogPath.sh
   

   Docker examples are available in the dd-trace-dotnet repository.

4. For standalone applications, manually restart the application.

2. Follow these installation guidelines (Windows or Linux) to set DD_PROFILING_ENABLED:true to enable the profiler.