APMInsight - NET Agent Onboarding - KB

APMInsight - NET Agent Onboarding - KB

This document provides a step-by-step guide to onboard and troubleshoot the APM Insight .NET Agent. It includes environment verification, permission checks, network connectivity validation, and solutions for common installation and configuration issues.

Quick Navigation


1. Prerequisites
Warning Warning: Restart of your application is necessary (i.e., IISRESET cmd execution for IIS sites, restart for Windows service & desktop apps) to start monitoring after agent installation.
1.1 .NET Framework Version – Environment should align with agent’s supported components

How to verify:

Run the following command using Windows PowerShell (Administrator mode):

QuoteGet-ChildItem 'HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP' -Recurse | Get-ItemProperty -Name Version, Release, SP -ErrorAction SilentlyContinue | Where-Object { $_.PSChildName -match '^(?!S)\p{L}'} | Select-Object PSChildName, Version, SP, Release

Requirements:

  • Confirm that .NET Framework v3.0 is listed and has SP ≥ 1
  • Confirm .NET Framework v4 (Full) is listed and has Release ≥ 378389

Resolution (if .msi installation fails despite prerequisites being met):

  1. Recheck prerequisites and try the Installation via command line.
  2. If issue still persists, locate the apm_install.log file in the installation directory & send the log file to appmanager-support@manageengine.com for further assistance.

1.2 Network & Firewall

Outbound communication from the agent-installed machine to the Applications Manager (Host and Port) should be allowed — either directly or via a proxy.

How to verify:

1. Get the configured “Apm Endpoint Urls” from the APM Insight .NET Agent Configuration tool.

2. Open the same URL in a browser on the agent-installed machine and confirm it loads.

3. Run the below PowerShell command (as Administrator) using the same “Apm Endpoint Url”:

Quoteadd-type 'using System.Net;using System.Security.Cryptography.X509Certificates;public class TrustAllCertsPolicy : ICertificatePolicy {public bool CheckValidationResult(ServicePoint a,X509Certificate b,WebRequest c,int d){return true;}}';[System.Net.ServicePointManager]::CertificatePolicy=New-Object TrustAllCertsPolicy;(Invoke-WebRequest -Uri '<Apm_EndPoint_Urls>'/index.do).Content -split "`n" | Where-Object {$_ -match 'Applications Manager'}

Verify the output contains the text “Applications Manager”:

4. If the output does NOT contain “Applications Manager”, the configured endpoint is incorrect or network/firewall is blocking communication.

Resolution:

  1. Ensure the correct endpoint is configured.
  2. Ensure the network and firewall configuration allows communication from the APM Insight .NET agent installed machine to the Applications Manager.
  3. If a proxy is used, specify the “Proxy Authentication” → Behind Proxy in the “Edit APM Insight .NET Agent Configuration” tool.
  4. After updating the settings, restart the application and the APM Insight .NET Agent service for the changes to take effect.
1.3 Application user should have full permissions over the agent directory – C:\ProgramData\DotNetAgent & C:\ProgramData\DotNetCoreAgent

How to verify:

  1. Open Task Manager → Details tab.
  2. Locate your target application process: w3wp.exe for IIS app, <service_name>.exe for services, or the main executable for desktop apps.

  1. Note the “User name” and go to the above folder (C:\ProgramData\DotNetAgent & C:\ProgramData\DotNetCoreAgent) → Properties → Security.
  2. Confirm the user/group (e.g., IIS_IUSRS, SYSTEM, or service account) has Read & Write permissions.

Resolution:

  1. If missing permissions, click Edit → Add → [User Name] → Allow Read & Write permissions.
  2. Restart the application and check.
1.4 Competing APM agents (e.g., Dynatrace, AppDynamics, etc.) should be removed before installing our agent

Running multiple profiler-based agents simultaneously can cause application instability and conflicts.

Follow these steps to identify and resolve conflicts between other APM products and the APM Insight .NET agent.

1.5 SharePoint / Multi-Domain Environment – Specific configuration changes required

SharePoint and Multi-Domain environments require specific configuration changes due to security concerns.

Follow these steps to identify the SharePoint/Multi-Domain environment and configure the “Support Multi-Domain Applications” checkbox.

2. Misconfiguration Issues
2.1 Incorrect “Apm Endpoint Urls” Configuration

Cause: “APM Endpoint Urls” configured with invalid Applications Manager host/port. Sometimes the port is configured with the OpManager port instead of the Applications Manager port.

Resolution:

1. From the Applications Manager server, navigate to Settings → Tools → Support → Installation Information to get the Web Server Port & SSL Port.

2. Ensure the same is configured in the “Apm Endpoint Urls” from the APM Insight .NET Agent Configuration tool.

3. Open the same URL in a browser on the agent-installed machine and confirm it loads.

4. Run the below PowerShell command (as Administrator) using the same “Apm Endpoint Url”:

Quoteadd-type 'using System.Net;using System.Security.Cryptography.X509Certificates;public class TrustAllCertsPolicy : ICertificatePolicy {public bool CheckValidationResult(ServicePoint a,X509Certificate b,WebRequest c,int d){return true;}}';[System.Net.ServicePointManager]::CertificatePolicy=New-Object TrustAllCertsPolicy;(Invoke-WebRequest -Uri '<Apm_EndPoint_Urls>'/index.do).Content -split "`n" | Where-Object {$_ -match 'Applications Manager'}

Verify the output contains the text “Applications Manager”:

5. If the output does NOT contain “Applications Manager”, the configured endpoint is incorrect or network/firewall is blocking communication.

  • Ensure the correct endpoint is configured.
  • Ensure the network and firewall configuration allows communication from the APM Insight .NET agent installed machine to the Applications Manager.
  • If a proxy is used, specify the “Proxy Authentication” → Behind Proxy in the “Edit APM Insight .NET Agent Configuration” tool.

6. After updating the settings, restart the application and the APM Insight .NET Agent service for the changes to take effect.

2.2 Incorrect “License Key” Configuration

Cause: The configured “License Key” in the “Edit APM Insight .NET Agent Configuration” tool might not match the Applications Manager configured in “Apm Endpoint Urls”. Sometimes users configure a different Applications Manager’s license key instead of the one matching the configured endpoint.

Resolution:

  1. Login to the Applications Manager configured in “Apm Endpoint Urls”. Navigate to APM → Add Monitor → .NET – Configure Now → APM Insight License Key. Copy the license key and replace it in the “License Key” value on the “Edit APM Insight .NET Agent Configuration” tool.

  1. Restart the agent service and application to reflect the changes.
2.3 AppManagerDataExporter Service Disabled (Applicable to >v7.0 Agent)

Cause: In APM Insight .NET Agent v7.0.2 or later, application onboarding may fail if the “Use Data Exporter” option is disabled in the Edit APM Insight .NET Agent Configuration tool. When disabled, the agent reverts to service mode and does not export data to Applications Manager.

Resolution:

  1. Open Edit APM Insight .NET Agent Configuration on the agent-installed machine.
  2. Enable “Use Data Exporter” under General → Exporter Configuration. Click Save.
  3. Run IISRESET from an administrator command prompt OR restart the relevant application service.
  4. Generate application traffic, then check for monitoring.

3. Application Not Enabled / No Active Traffic

After agent installation, the application might not be enabled, not restarted, or not having active traffic to initiate monitoring.

How to check and ensure:

1. Ensure your application (IIS app, Windows service, desktop app) is enabled for monitoring within the “APM Insight .NET Agent Configuration” tool and your application is running & processing transactions or requests for the agent to monitor it.

2. Verify if the application process is instrumented with the agent profiler using Process Explorer:

  • Download and unzip Process Explorer. Run procexp.exe in administrator mode.
  • Locate the target application process (w3wp.exe for IIS app, <service_name>.exe for services, or the main executable for desktop apps).
  • In the Process Properties (Right Click → Properties), go to the Environment tab, and confirm the presence of the COR_PROFILER & CORECLR_PROFILER variable with the values:
    989D151B-3F31-482E-926F-2E95D274BD36 & 9D363A5F-ED5F-4AAC-B456-75AFFA6AA0C8

3. Verify if the application process is instrumented with the agent profiler using Event Viewer:

  • Open Event Viewer and navigate to Windows Logs > Application.
  • Check for the event with the source .NET Runtime and verify that the Process ID (decimal) matches the one in Task Manager.

4. Verify if the agent created the following log files under: “C:\ProgramData\DotNetAgent\AgentLogs” or “C:\ProgramData\DotNetCoreAgent\AgentLogs”

  • For IIS app: .NetAgentNative.w3wp.exe.<PID>.log , DotNetAgentManaged.ROOT.w3wp.<PID>-<dd-mm-yyyy>.log
  • For Windows service & Desktop app: .NetAgentNative.<service_name>.exe.<PID>.log , DotNetAgentManaged.<service_name>.exe.<service_name>.<PID>-<dd-mm-yyyy>.log
Note: This log file will be created only if the application has performed some transactions.

4. License Expired

Cause: “APM Insight .Net Add-On” license might have expired or the add-on license is not enabled on the Applications Manager.

How to verify:

  1. Open the “APM Insight .NET Agent Health Monitor” tool.
  2. Navigate to the “IIS Applications” tab for IIS sites OR “Windows Service and Apps” for Windows Service & Desktop apps.
  3. Check if the app monitoring status appears as “LicenseExpired” state.

Resolution:

  1. Apply & ensure the “APM Insight .Net Add-On” licensing is enabled to allow .NET app monitoring on the Applications Manager.
  2. From the “APM Insight .NET Agent Health Monitor” tool, click “Fix it”Yes.
5. Deprecated apminsight.conf Fields After Agent Upgrade (Known Behavior)
This is not an issue. This is expected behavior from agent version v6.7.1 onwards.

Starting from agent version v6.7.1, endpoint configuration moved to a unified “App Manager Endpoint Urls” field to support multiple endpoints for failover setups (Release Notes). As part of this change, the agent updates apm.host with the configured endpoint URL, while apm.port and apm.protocol.https are deprecated and no longer used.

These deprecated fields may show incorrect values after upgrade (e.g., apm.port=9090, apm.protocol.https=False) — this can be safely ignored as the agent reads only from “App Manager Endpoint Urls”.

Quoteapm.host=https://opmanager.ica.com:8443   ← updated by agent (correct)
apm.protocol.https=False   ← deprecated, not used
apm.port=9090   ← deprecated, not used
Warning Important: Do NOT manually edit apm.port or apm.protocol.https in the apminsight.conf file. These fields are deprecated and any changes will be overwritten. Use the “App Manager Endpoint Urls” field in the Configuration tool instead.

Correct endpoint format:

Quotehttps://<APM_Host>:<SSL_Port>/   (or)   http://<APM_Host>:<HTTP_Port>/
For failover: https://apmhost1:8443,https://apmhost2:8443

💬 Still Need Help?

If the issue persists after following the above steps, contact support with the following data for further assistance:

1. Generate & Share Agent Diagnostics Zip

Open the APM Insight .NET Agent Diagnosis Tool → click Create Diagnostic zip file and share it with support.

Note: If the generated diagnostics zip does not contain the agent logs and configuration files (i.e., it only contains .evtx and _system.info files), the event log files (.evtx) are too large and are causing the agent data folders to be excluded. In this case, generate another diagnostics zip with “Include Event Logs” unchecked and share both zips with support.

2. Send the diagnostics zip(s) to support:

                  New to ADSelfService Plus?

                    • Related Articles

                    • APMInsight - .NET Agent Data Collection - KB

                      Overview 📌 Note: For any onboarding or agent installation-related issues, please refer to the APM Insight .NET Agent Onboarding KB. This document provides a step-by-step guide to troubleshoot the data collection issue with the APM Insight .NET ...
                    • APM Insight Java Agent – Onboarding & Troubleshooting Guide

                      This guide helps support engineers troubleshoot cases where the APM Insight Java Agent is not onboarding (not appearing in Applications Manager) after installation. Follow the step-by-step verification checklist in Section 2 to quickly diagnose and ...
                    • How to Deploy APMInsight .NET Agent Docker Image in Air-Gapped (Offline) Environments

                      This guide explains how to use the APMInsight .NET Agent Docker image in environments without direct internet access by transferring it through a private container registry. Overview Since air-gapped (isolated from internet) environments cannot pull ...
                    • How to Install .NET agent on AWS Elastic Beanstalk?

                      One of the two options listed below can be used to install APM Insight agent onto a .NET web application hosted in Elastic Beanstalk environment via ebextensions. Deployment through AWS kit for Visual Studio. Deployment via uploading packages to AWS ...
                    • Troubleshoot - Duplicate APMInsight Monitors

                      Introduction: Duplicate monitors might be created in APMInsight due to various reasons. This article will help you identify and resolve the issue of duplicate monitors. The common causes include: - Changes in monitor configuration. (apminsight.conf ...