Install the .NET Core agent with the .NET Core agent for IIS installer

The .NET Core agent for IIS installer is a normal Windows application installer built using standard MSI technology. It validates that the target server and satisfies several requirements (for example, that the server's operating system is a supported operating system). If all requirements are met, the installer:

  • Registers the .NET Core agent for IIS as a standard Windows program.

  • Places the agent’s files on a disk in the specified install location (for example, C:\Program Files\Contrast\dotnet-core). This includes several dynamic link libraries (DLLs) and executables.

  • Creates the specified data directory for the agent that's primarily used to store agent log files and configuration (for example, C:\ProgramData\Contrast\dotnet-core).

  • Adds the .NET Core agent’s IIS Native Module to IIS.

Before you begin

Before you begin, check the system requirements and supported technologies to be sure installation will work and ensure best performance.

Install the agent using Contrast

  1. In the Contrast web application, select Add new.

  2. Choose .NET Core in the application language dropdown menu, then select IIS hosted and select the link to Download the .NET Core agent installer.

  3. Configure the .NET Core agent with a YAML configuration file to set the authentication keys and any application-specific configuration.

  4. Extract the downloaded ZIP archive on the web server, and run contrast-dotnet-core-agent-for-iis-installer.exe. This installs the .NET Core agent for IIS.

    Tip

    You can use the command line to access additional options supported by the .NET Core agent for IIS installer.

  5. Use the application as you normally would and verify that Contrast sees your application.

Install the agent using command line

Use the command line to access additional options supported by the .NET Core agent for IIS installer.

The .NET Core for IIS agent can be installed using the Windows web interface, and uninstalled or repaired using standard Windows features (including the Programs and Features Control Panel and Powershell). However, you may want to use the Contrast Windows installer to perform these actions instead for certain scenarios such as automated scripting.

Use these commands for attended mode:

  • Install: contrast-dotnet-core-agent-for-iis-installer.exe

  • Uninstall: contrast-dotnet-core-agent-for-iis-installer.exe -uninstall

  • Repair: contrast-dotnet-core-agent-for-iis-installer.exe -repair

Use these commands for unattended or silent mode:

  • Install: contrast-dotnet-core-agent-for-iis-installer.exe -s SUPPRESS_RESTARTING_IIS=1

  • Uninstall: contrast-dotnet-core-agent-for-iis-installer.exe -uninstall -s SUPPRESS_RESTARTING_IIS=1

  • Repair: contrast-dotnet-core-agent-for-iis-installer.exe -repair -s SUPPRESS_RESTARTING_IIS=1

The .NET Core agent for IIS installer supports several additional options that are accessible when you use the command line for installation.

Option

Description

Example

INSTALLFOLDER

Specify the location where the installer will place agent files.

INSTALLFOLDER=C:Program Files\Contrast\dotnet-core

DATAFOLDER

Specify the default location for agent log and configuration files.

DATAFOLDER=C:\ProgramData\Contrast\dotnet-core

SUPPRESS_RESTARTING_IIS

When set the installer will not restart IIS. Note that the agent will not be loaded by applications until IIS is restarted.

SUPPRESS_RESTARTING_IIS=0

Important

The .NET Core agent for IIS installer automatically restarts IIS when you install the agent for the first time. You may want to change the configuration of any web server monitoring tools that raise alarms when IIS restarts.

The .NET Profiling API requires that profiled processes be started with a profiler. Therefore, the .NET Core agent must restart IIS (and any IIS worker processes) to attach the Contrast profiler. This process is similar to how other profiling products (for example, memory or performance profilers) behave.

In this section: