Install APM Insight .NET Core Agent


Monitor your web applications built in .NET Core 2.0 and above with the help of the APM Insight .NET Core agent. You can track HTTP requests, SQL queries, errors, exceptions, web API calls, and remote calls in your ASP .NET Core applications hosted in IIS or Kestrel web servers.

Installing APM Insight .NET Core Agent

  • In Applications Manager, APM Insight tab > Help Card > copy the License Key present there.
  • Download the APM Insight .NET Core Agent file (apminsight-dotnetcoreagent.ziphere in your application server and unzip the agent.
  • Run Powershell in administrator mode and navigate to the location of unzipped agent.
  • Install the .NET Core Agent by executing the below command:

    InstallAgent.ps1 -Destination "[path]" -InstallType "[local|global]" -LicenseKey [License Key] -AppName "[application Name]" -Force

    where,

    Destination "[path]" → The location where the agent will be installed. May be an absolute or relative path. Wrapping quotes are also required.
    InstallType [local|global] → Determines whether the installation will be done locally or globally. Since global install will instrument all .NET Core applications unintentionally, Local install is the recommended. 
    LicenseKey [licenseKey] → The license key copied from the Application Manager APM Insight homepage.
    AppName → Optional. Sets the default application name for the agent.
    Force → Optional. Overwrites exisiting installation. We recommend backing up the existing configuration files first.

    Example:

    InstallAgent.ps1 -Destination "C:\.NET_Core_Agent" -InstallType "local" -LicenseKey APMI_762cf0800fd41749008b5d73115a6841d8dee7e01fc2f451500d39786b593c39

  • Once the installation is complete, Open the <Agent Installation Path>\DotNetAgent\apminsight.conf file in any text editor and include\update the following keys:

    apm.host=[HOST]:[PORT]
    apm.protocol.https=[true|false]

    Where,
    apm.host - Host Name/IP and Port where the Applications Manager is running.
    apm.protocol.https - Specify true if the data to the Applications Manager should be sent through HTTPS Protocol. If false, data will be sent through HTTP Protocol.

    Example:

    apm.host=app-w8-test:8443
    apm.protocol.https=true

  • Save the file and restart your .NET Core application.

Note: To Change the .NET Core application name,
  1. Navigate to the application publish directory.
  2. Create or open the apmapplication.conf file, then add or modify the application name.

    application.name="[Your Application Name]"

    Changing the application name only creates a new host whereas the previous host does not get deleted.
  3. Restart the .NET Core application.